The CData Sync App provides a straightforward way to continuously pipeline your Oracle Fusion Cloud Financials data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The Oracle Fusion Cloud Financials connector can be used from the CData Sync application to pull data from Oracle Fusion Cloud Financials and move it to any of the supported destinations.
The Sync App leverages the Oracle Fusion Cloud Financials API version 11.13.18.05+ to enable bidirectional access to finance data from Oracle Fusion Cloud Financials.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
You must set the following to authenticate to Oracle Fusion Cloud Financials:
The CData Sync App models Oracle Fusion Cloud Financials data as an easy-to-use SQL database with tables, views, and stored procedures.
The Sync App exposes two schemas:
In Oracle Fusion Cloud Financials, finders are filters used for searching collection resources. Each finder has several parameters bound to it.
To use a finder filter with a parent view, you need to provide the FinderName in the finder pseudo column and provide values for the finder parameter columns.
SELECT * FROM JournalBatches WHERE finder = 'JournalsFinder' AND JournalCategory = 'test';
To use a finder filter with a child view, you need to provide the FinderName of the parent view in the finder pseudo column and provide values for the finder parameter columns of the parent view.
SELECT * FROM InvoicesinvoiceLinesinvoiceDistributions WHERE finder = 'PrimaryKey' AND InvoiceId = 5484;
In the Financials Data Model schema, the Sync App models information such as expenses, invoices, and receivables associated with the authenticated account as an easy-to-use SQL database. Live connectivity to these objects means that any changes to your Oracle Fusion Cloud Financials account are immediately reflected in the Sync App.
The Tables section, which details standard SQL tables, and the Views section, which lists read-only SQL tables, contain samples of what you might have access to in your Oracle Fusion Cloud Financials account.
Common tables include:
| Table | Description |
| Invoices | Manages key supplier invoice data, including header, lines, distributions, installments, and descriptive flexfields for payables processing. |
| InvoicesinvoiceLines | Captures goods, services, freight, and miscellaneous charges at the invoice line level, forming the basis for accounting entries. |
| InvoicesinvoiceLinesinvoiceDistributions | Creates distribution records per invoice line, detailing account numbers, distribution dates, and expense allocations. |
| ReceivablesInvoices | Controls the creation, retrieval, and management of receivables invoices, streamlining billing and revenue tracking. |
| ReceivablesCreditMemos | Manages credit memo records in Receivables, including creation, retrieval, and referencing for financial adjustments. |
| StandardReceipts | Tracks standard incoming payments (for example, checks, wire transfers), mapping them to customer accounts for settlement. |
| ExpenseReports | Contains header-level details for expense reports, such as total cost, status, and submission date for auditing and payment tracking. |
| Expenses | Acts as the master resource for all incurred expenses by employees, centralizing data for reporting and approvals. |
| ExpenseDistributions | Shows how an expense item’s cost is allocated across multiple accounts or cost centers, ensuring financial accuracy. |
| ExpenseCashAdvances | Tracks employee cash advances for travel or business-related expenses, capturing key data such as status, requested amounts, and repayment details. |
| PaymentsExternalPayees | Defines external payees (for example, suppliers, vendors) for payments, enabling creation and modification of payee records. |
| ExternalBankAccounts | Stores external bank account details for payments or reimbursements, supporting account creation, modifications, and usage tracking. |
| CurrencyRates | Retrieves currency exchange rates for specified dates and currency pairs, informing multi-currency postings and reports. |
| AccountingPeriodsLOV | Lists period details (for example, open, closed) within a specified accounting calendar, aiding period-based reporting and reconciliation. |
| ChartOfAccountsLOV | Outlines details of a chart of accounts structure, including segments and hierarchies for robust financial tracking. |
| LedgersLOV | Task-related data, including project and customer information, task status, and budget/actual quantities. |
| TaxRegistrations | Controls creation and updates of tax registrations, linking registered entities to corresponding tax codes and authorities. |
| PayablesPaymentTerms | Defines the rules (for example, net 30, net 60) for paying a supplier, setting installment schedules and discount opportunities. |
| ReceivablesAdjustments | Allows modification of existing invoices, credit memos, or other transactions, adjusting charges, freight, taxes, or lines. |
| TransactionTaxLines | Allows the creation, retrieval, and modification of manual tax lines for a transaction, ensuring accurate tax posting. |
Stored Procedures are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, including cancelling invoices and creating expense reports.
The Sync App models the data in Oracle Fusion Cloud Financials as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| ExpenseReports | Contains header-level details for expense reports, such as total cost, status, and submission date for auditing and payment tracking. |
| Expenses | Acts as the master resource for all incurred expenses by employees, centralizing data for reporting and approvals. |
| Invoices | Manages key supplier invoice data, including header, lines, distributions, installments, and descriptive flexfields for payables processing. |
| InvoicesinvoiceDff | Supports organization-specific data fields on invoices, leveraging descriptive flexfields for custom reporting or validations. |
| InvoicesinvoiceInstallments | Tracks multiple payment installments tied to a single invoice, detailing amounts and due dates for staged payables. |
| InvoicesinvoiceLines | Captures goods, services, freight, and miscellaneous charges at the invoice line level, forming the basis for accounting entries. |
| InvoicesinvoiceLinesinvoiceDistributions | Creates distribution records per invoice line, detailing account numbers, distribution dates, and expense allocations. |
| ReceivablesCreditMemos | Manages credit memo records in Receivables, including creation, retrieval, and referencing for financial adjustments. |
| ReceivablesInvoices | Controls the creation, retrieval, and management of receivables invoices, streamlining billing and revenue tracking. |
| StandardReceipts | Tracks standard incoming payments (for example, checks, wire transfers), mapping them to customer accounts for settlement. |
| TaxRegistrations | Controls creation and updates of tax registrations, linking registered entities to corresponding tax codes and authorities. |
Contains header-level details for expense reports, such as total cost, status, and submission date for auditing and payment tracking.
The Sync App uses the Oracle Fusion Cloud Financials API to process some of the filters having queryable=true in metadata. The Sync App processes other filters within the Sync App.
For example, the following query is processed server side:
SELECT * FROM ExpenseReports WHERE ExpenseReportId = 10003
Create an expense report record.
INSERT INTO ExpenseReports (ReimbursementCurrencyCode) VALUES ('USD')
If you want to add child views/tables along with the parent table, you can add the child in following ways:
Using TEMP table:
INSERT into ExpenseReportsExpense#TEMP(Location,ReceiptTime,StartDate,NumberPeople,PassengerAmount,ReceiptRequiredFlag) values ('India','2024-10-10 23:12:15','2024-02-05',25,25.35,true);
INSERT INTO ExpenseReports (ReimbursementCurrencyCode,expense) VALUES ('USD','ExpenseReportsExpense#TEMP');
Directly providing the aggregate:
INSERT INTO ExpenseReports (ReimbursementCurrencyCode,expense) VALUES ('USD','[
{
"Location": "India",
"NumberPeople": 25,
"PassengerAmount": 25.35,
"ReceiptRequiredFlag": true,
"StartDate": "2024-02-05",
"ReceiptTime": "2024-10-10T23:12:15.000-04:00"
}
]');
Update an expense report record for a specific expense report identifier.
The Oracle Fusion Cloud Financials API uses ExpenseReportUniqId instead of ExpenseReportId as a path parameter in the URL to update the expense report.
If you want to update a record directly using the id (without any other filter), you can update the record in the following way:
Update ExpenseReports set ReimbursementCurrencyCode='EUR' where ExpenseReportUniqId=12457;
Note: This does not require any extra GET request to retrieve the UniqId.
Alternatively, if you want to apply any other filter. Please use ExpenseReportId instead of ExpenseReportUniqId. You can update the record in the following way:
Update ExpenseReports set ReimbursementCurrencyCode='EUR' where ExpenseReportId=12457 and PersonId=45442;
Note : Update on aggregates are not allowed by API, use the child tables to add/update/delete aggregates.
| Name | Type | ReadOnly | Description |
| AssignmentId | Long | False |
Unique identifier for the assignment related to the expense report, typically assigned to a person responsible for submitting or reviewing the report. |
| AuditCode | String | False |
Code that categorizes the type of audit applied to the expense report, such as audits based on original receipts or image-based receipts. |
| AuditReturnReasonCode | String | False |
Describes the reason for returning the expense report to the individual, usually due to missing or incorrect documentation during the audit process. |
| BothpayFlag | Bool | False |
Indicates whether the expense report includes corporate card transactions where the payment liability is split between both the company and the individual. |
| CurrentApproverId | Long | False |
Identifier for the individual who is currently responsible for approving the expense report. |
| ExchangeRateType | String | False |
Type of exchange rate used to calculate the reimbursable amounts for foreign currency expenses. |
| ExpenseReportDate | Date | False |
The date the expense report was saved or submitted, typically representing the end of the reporting period. |
| ExpenseReportId [KEY] | Long | False |
A unique identifier for the expense report, used for referencing and operations like updates and deletions. |
| ExpenseReportUniqId [KEY] | String | True |
A unique identifier for the expense report used during insert, update, and delete operations, ensuring proper tracking across systems. |
| ExpenseReportNumber | String | False |
A unique reference number for the expense report that adheres to company-specific numbering conventions. |
| ExpenseReportTotal | Decimal | False |
The total amount of the expense report, calculated in the reimbursement currency. Also includes the total in the approver’s preferred currency if applicable. |
| ExpenseStatusCode | String | False |
Current approval status of the expense report, such as Approved, Pending Manager Approval, or Paid. |
| ExpenseStatusDate | Date | False |
The date when the expense report transitioned to its current approval status. |
| FinalApprovalDate | Date | False |
The date on which the expense report received final approval from all necessary approvers. |
| ImagedReceiptsReceivedDate | Date | False |
The date when receipts for the expense report, in the form of images, were received and processed. |
| ImagedReceiptsStatusCode | String | False |
Status code representing the current state of imaged receipts for the expense report, such as 'Required', 'Missing', or 'Received'. |
| MissingImagesReason | String | False |
Explanation for why imaged receipts are not included with the expense report, potentially due to issues like receipt clarity or submission delays. |
| OrgId | Long | False |
Unique identifier for the business unit or department to which the expense report belongs. |
| OverrideApproverId | Long | False |
Identifier for the initial approver selected by the individual submitting the expense report, prior to any reassignments. |
| ParentExpenseReportId | Long | False |
Identifier of the parent expense report, if the current report is a revision or related to another earlier report. |
| PaymentMethodCode | String | False |
Code representing the method of payment used for the expenses on this report, such as 'check', 'cash', or 'credit card'. |
| PersonId | Long | False |
Unique identifier for the individual who owns the expense report, often tied to their employee or user account. |
| PreparerId | Long | False |
Identifier for the person who created the expense report, typically the individual submitting the expenses for review and approval. |
| Purpose | String | False |
Description of the business purpose or activities that justify the expenses submitted in the report. |
| ReceiptsFilingNumber | String | False |
A unique filing number for receipts, manually entered by the auditor to track and verify receipts submitted with the report. |
| ReceiptsReceivedDate | Date | False |
The date on which receipts for the expense report were physically received or digitally submitted for auditing. |
| ReceiptsStatusCode | String | False |
Status of the receipts for the expense report, indicating whether receipts are 'Missing', 'Required', or 'Received'. |
| ReimbursementCurrencyCode | String | False |
Currency code representing the currency used for reimbursing the individual for expenses incurred. |
| ReportCreationMethodCode | String | False |
Indicates how the expense report was created, for example, via a mobile app on iOS or Android. |
| ReportSubmitDate | Date | False |
The date the expense report was formally submitted for review and approval. |
| TripId | Long | False |
Identifier for the business trip associated with the expense report, which helps link the report to travel-related costs. |
| UnappliedAdvancesJust | String | False |
Explanation for why an outstanding cash advance has not been applied against the current expense report. |
| UnappliedCashAdvReason | String | False |
Reason why an outstanding cash advance has not been deducted from the current expense report's total amount. |
| CreatedBy | String | True |
Indicates the user who created the expense report or row in the system, typically a person responsible for data entry. |
| CreationDate | Datetime | True |
Timestamp indicating when the expense report or row was initially created in the system. |
| LastUpdateDate | Datetime | True |
Timestamp showing the last time the expense report or row was modified, reflecting any updates or changes. |
| LastUpdateLogin | String | True |
Login session identifier associated with the user who last updated the record. |
| LastUpdatedBy | String | True |
Name or identifier of the user who made the most recent update to the expense report or row. |
| BusinessUnit | String | False |
Indicates the specific business unit or department within the organization associated with the expense report. |
| SubmitReport | String | False |
Indicates whether the expense report is ready to be submitted for review, often depending on the completion of required fields and validations. |
| MatchExpenses | String | False |
Indicates whether corporate card transactions can be matched to corresponding expenses in the report to ensure accurate reimbursement. |
| SubmitErrors | String | False |
Lists any errors or issues that occurred during the submission process, such as missing required fields or incorrect data. |
| PersonName | String | True |
Name of the individual for whom the expense report was created, typically matching their employee or user account information. |
| OriginalReceiptsStatus | String | True |
The status of the original receipts required for the expense report, indicating whether they are 'Required', 'Missing', or 'Received'. |
| ImagedReceiptsStatus | String | True |
The status of the imaged receipts required for the expense report, indicating whether they are 'Required', 'Missing', or 'Received'. |
| ExpenseReportStatus | String | True |
Overall status of the expense report, which could be 'Draft', 'Submitted', 'Approved', 'Paid', or other relevant stages. |
| AuditCodeName | String | True |
Lookup value describing the meaning of the Audit Code, providing clarity on the type of audit applied. |
| CurrentApprovers | String | True |
List of individuals who are currently waiting for approval or are responsible for approving the expense report. |
| Expense | String | False |
This field is reserved for insert operations only; for updates or deletions, appropriate child table operations should be used. |
| ExpenseReportDff | String | False |
This field is reserved for insert operations only; for updates or deletions, appropriate child table operations should be used. |
| processingDetails | String | False |
This field is reserved for insert operations only; for updates or deletions, appropriate child table operations should be used. |
| ExpensePayment | String | False |
This field is reserved for insert operations only; for updates or deletions, appropriate child table operations should be used. |
| expenseNotes | String | False |
This field is reserved for insert operations only; for updates or deletions, appropriate child table operations should be used. |
| Finder | String | True |
This column is used as a generic reference, possibly tied to specific search operations or queries. |
| SysEffectiveDate | String | True |
Date associated with the system’s effective date for data operations, possibly used to ensure accurate historical data retrieval. |
| EffectiveDate | Date | True |
Query parameter that helps fetch records which are effective as of the specified start date. |
Acts as the master resource for all incurred expenses by employees, centralizing data for reporting and approvals.
The Sync App uses the Oracle Fusion Cloud Financials API to process some of the filters having queryable=true in metadata. The Sync App processes other filters within the Sync App.
For example, the following query is processed server side:
SELECT * FROM [Cdata].[Financials].[Expenses] WHERE ExpenseId = 10003
Create an expense record.
INSERT INTO [Cdata].[Financials].[Expenses] (Location) VALUES ('India')
If you want to add child views/tables along with the parent table, you can add the child in following ways:
Using TEMP table:
INSERT into ExpensesExpenseAttendee#TEMP(Name,EmployeeFlag,Amount) values ('Ted Brown',true,25);
INSERT INTO Expenses (Location,ExpenseAttendee) VALUES ('India','ExpensesExpenseAttendee#TEMP');
Directly providing the aggregate:
INSERT INTO Expenses (Location,ExpenseAttendee) VALUES ('India','[
{
"Amount": 25,
"EmployeeFlag": y,
"Name": "Ted Brown"
}
]');
The Oracle Fusion Cloud Financials API uses ExpenseUniqId instead of ExpenseId as a path parameter in the URL to update the expenses.
If you want to update a record directly using the id (without any other filter), you can update the record in the following way:
Update [Cdata].[Financials].[Expenses] set NumberPeople=566 where ExpenseUniqId=300000294909513;
Note: This does not require any extra GET request to retrieve the UniqId.
Alternatively, if you want to apply any other filter. Please use ExpenseId instead of ExpenseUniqId. You can update the record in the following way:
Update [Cdata].[Financials].[Expenses] set NumberPeople=566 where ExpenseId=300000294909513 and Location='India';
Note : Update on aggregates are not allowed by API, use the child tables to add/update/delete aggregates.
| Name | Type | ReadOnly | Description |
| AgencyName | String | False |
Name of the service provider for transportation or travel services, such as a car rental company or an airline. |
| AssignmentId | Long | False |
Unique identifier assigned to an individual who is responsible for the expense, typically the employee or contractor. |
| AuditAdjustmentReason | String | False |
Explanation provided by an auditor for adjusting the reimbursable amount, offering context for the changes made. |
| AuditAdjustmentReasonCode | String | False |
Code that identifies the specific reason an auditor made adjustments to the reimbursable amount for an individual. |
| AwtGroupId | Long | False |
Unique identifier for an alternate tax withholding group, used for tax purposes in the context of payroll or expenses. |
| BilledAmount | Decimal | False |
Total amount charged to the corporate card account for the expense incurred. |
| BilledCurrencyCode | String | False |
Currency code associated with the amount billed to the corporate card account. |
| CardId | Long | True |
Unique identifier for the corporate card associated with a specific transaction. |
| CheckoutDate | Date | False |
Date when a person checks out from a location, typically for accommodations-related expenses. |
| CreatedBy | String | True |
Username or identifier of the user who initially created the expense record. |
| CreationDate | Datetime | True |
Timestamp representing the exact date and time when the expense record was created. |
| CreditCardTrxnId | Long | True |
Unique transaction identifier for a specific credit card transaction, allowing for easy reference and tracking. |
| DailyAmount | Decimal | False |
Amount recorded for a daily expense receipt, expressed in the currency of the receipt. |
| DailyDistance | Decimal | False |
Total business-related distance traveled during the day, typically used for mileage or per diem calculations. |
| DailyLimit | String | False |
The maximum allowable daily expense for a trip or project, helping to manage travel expenses. |
| DepartureLocationId | Long | False |
Identifier for the location where a trip or travel begins, typically used in conjunction with other travel data. |
| Description | String | False |
Detailed description of the specific expense item, providing context and clarification for the expense. |
| DestinationFrom | String | False |
Starting point or departure location of a trip, used for travel and itinerary management. |
| DestinationTo | String | False |
Final destination or arrival location of the trip, aiding in expense categorization for travel. |
| DistanceUnitCode | String | False |
Code identifying the unit of measurement for travel distances, such as KILOMETER or MILE. |
| EndDate | String | False |
The final date for an expense that spans multiple days, marking the conclusion of the expense period. |
| EndDateTimestamp | Datetime | True |
Timestamp marking the exact end date and time of an expense that spans several days. |
| EndOdometer | Decimal | False |
Odometer reading recorded at the end of a business-related trip to track vehicle usage. |
| ExchangeRate | Decimal | False |
Rate at which one currency is exchanged for another, useful for conversions during international travel or expenses. |
| ExpenseCategoryCode | String | False |
Code that categorizes the expense item (for example, BUSINESS, PERSONAL) to assist in classification and reporting. |
| ExpenseCreationMethodCode | String | False |
Code identifying how the expense was created, such as via mobile apps or web portals. |
| ExpenseId [KEY] | Long | False |
Unique identifier for a specific expense item within the system. |
| ExpenseUniqId [KEY] | String | True |
Alternate unique identifier for an expense item, used in operations like inserts, updates, or deletes. |
| ExpenseReference | Int | False |
Reference number used to identify and track specific expenses within reports or systems. |
| ExpenseReportId | Long | False |
Unique identifier for a complete expense report that includes multiple related expenses. |
| ExpenseSource | String | False |
Code indicating the source of an expense, such as CASH or CORPORATE_CARD. |
| ExpenseTemplateId | Long | False |
Identifier for a template used to structure the expense report or for expense creation. |
| ExpenseTypeCategoryCode | String | False |
Code indicating the category of the expense, such as AIRFARE, CAR_RENTAL, or ACCOMMODATIONS. |
| ExpenseTypeId | Long | False |
Unique identifier for a specific type of expense, such as lodging, meals, or transportation. |
| FlightClassLimit | String | False |
Expense limit for a particular flight class, such as ECONOMY or BUSINESS. |
| FlightDuration | Decimal | False |
Total duration of the flight in hours, used for travel time tracking and reimbursement. |
| FlightNumber | String | False |
Identifier for the specific airline flight, providing details on the travel itinerary. |
| FuelType | String | False |
Types of fuel eligible for reimbursement, typically based on the vehicle and type of trip. |
| ImageReceiptRequiredFlag | Bool | False |
Indicates whether an image of the receipt is required for an expense to be processed. |
| ItemizationParentExpenseId | Long | False |
Identifier for the parent expense item in a set of itemized expenses, used for hierarchical expense reporting. |
| ItemizationReceiptBusinessTotalAmount | Decimal | False |
Amount on the receipt to be reimbursed for business-related expenses. |
| ItemizationReceiptPersonalTotalAmount | Decimal | False |
Amount on the receipt that is for personal use, not eligible for reimbursement. |
| ItineraryReservationId | Long | False |
Unique identifier for a travel reservation, such as a flight or hotel booking. |
| Justification | String | False |
Reason or explanation for why an expense was incurred, often required for validation or auditing purposes. |
| JustificationRequiredFlag | Bool | False |
Indicates whether a justification is required for a specific expense item. |
| LastUpdateDate | Datetime | True |
Timestamp indicating when the expense record was last updated. |
| LastUpdateLogin | String | True |
Login session associated with the last update made to the expense record. |
| LastUpdatedBy | String | True |
User who made the last modification to the expense record. |
| LicensePlateNumber | String | False |
License plate number of the vehicle used during the expense period. |
| Location | String | False |
Location where the expense was incurred, such as a city or event venue. |
| LocationId | Long | False |
Unique identifier for a specific location where the expense was incurred. |
| LongTermTripFlag | Bool | False |
Indicates whether the trip is considered long-term, typically based on duration or nature of the trip. |
| LongTermTripStartDate | Date | False |
Date the long-term trip began, used for trip planning and expense allocation. |
| MerchantDocumentNumber | String | False |
Merchant-assigned receipt or invoice number to track the specific transaction. |
| MerchantName | String | False |
Name of the merchant or business where the expense was incurred. |
| MerchantReference | String | False |
Unique reference number assigned by the merchant, used for transaction tracking. |
| MerchantTaxRegNumber | String | False |
Tax registration number assigned to the merchant by tax authorities, useful for reporting and compliance. |
| MerchantTaxpayerId | String | False |
Unique identifier assigned to the merchant for tax purposes, used for reporting and compliance. |
| MileagePolicyId | Long | False |
Unique identifier for a specific mileage reimbursement policy, helping to apply the correct reimbursement rules. |
| NumberOfAttendees | Decimal | False |
Number of individuals attending an event, such as a business dinner or meeting, for which expenses are claimed. |
| NumberOfDays | Int | False |
Number of days the expense occurred or was incurred, typically used for per diem calculations. |
| NumberPeople | Int | False |
Number of people sharing a vehicle or other transport, used for calculating shared mileage or expenses. |
| OrgId | Long | False |
Unique identifier for the business unit or department associated with the expense. |
| PassengerAmount | Decimal | False |
Total reimbursement for carrying passengers in a vehicle, used in mileage or transport reimbursements. |
| PassengerName | String | False |
Name of a passenger traveling with the individual who incurred the expense. |
| PassengerRateType | String | False |
Type of rate applied for mileage reimbursement based on the number of passengers in the vehicle. |
| PaymentDueFromCode | String | False |
Code indicating the entity responsible for the payment of the transaction, such as an employee or company. |
| PersonId | Long | False |
Unique identifier assigned to the person responsible for the expense, typically the employee or contractor. |
| PersonalReceiptAmount | Decimal | False |
Portion of the receipt marked as personal, not eligible for reimbursement. |
| PolicyShortpayFlag | Bool | False |
Indicates whether the expense was short-paid due to noncompliance with company policies. |
| PolicyViolatedFlag | Bool | False |
Indicates whether the expense violates any company policies, typically for auditing purposes. |
| PolicyWarningFlag | Bool | False |
Indicates whether a policy warning has been applied to the expense, often due to minor issues. |
| PolicyWarningReasonCode | String | False |
Code that explains the reason for a policy warning applied to an expense item. |
| PreparerId | Long | False |
Unique identifier for the individual who prepared the expense report. |
| RatePerPassenger | Decimal | False |
Mileage rate applied per passenger in a vehicle for the purpose of calculating reimbursements. |
| ReceiptAmount | Decimal | False |
Total amount on the receipt, typically in the receipt's currency, to be reimbursed or tracked. |
| ReceiptCurrencyCode | String | False |
Currency code for the receipt, indicating the currency in which the expense was incurred. |
| ReceiptDate | Date | False |
Date the receipt for the expense was generated, typically for verification and record-keeping. |
| ReceiptMissingDecRequiredFlag | Bool | False |
Indicates whether a declaration is required for missing receipts in order to process the expense. |
| ReceiptMissingFlag | Bool | False |
Indicates whether receipts are missing for the expense, affecting processing and reimbursement. |
| ReceiptRequiredFlag | Bool | False |
Indicates whether receipts are required for a specific expense item. |
| ReceiptVerifiedFlag | Bool | False |
Indicates whether the receipt for an expense has been verified by an auditor. |
| ReimbursableAmount | Decimal | False |
Amount to be reimbursed to the individual, calculated in the reimbursable currency. |
| ReimbursementCurrencyCode | String | False |
Currency code for the reimbursement, typically matching the currency used for the expense. |
| SequenceNumber | Decimal | False |
Number assigned to an expense item, indicating the order in which items are entered into the expense report. |
| StartDate | Date | False |
Date when the expense was incurred or when the first day of a multi-day expense begins. |
| StartDateTimestamp | Datetime | True |
Timestamp indicating the date and time when the expense occurred or the trip started. |
| StartOdometer | Decimal | False |
Odometer reading at the start of a trip, used for mileage calculation. |
| TaxClassificationCode | String | False |
Code that indicates the tax classification for an expense, used for compliance and reporting. |
| TicketClassCode | String | False |
Code indicating the class of ticket for travel, such as BUSINESS or ECONOMY. |
| TicketNumber | String | False |
Unique identifier for a specific airline or travel ticket. |
| TravelMethodCode | String | False |
Code indicating the travel method used, such as CAR, TRAIN, or FLIGHT. |
| TravelType | String | False |
Code for the type of travel, such as DOMESTIC or INTERNATIONAL. |
| TripDistance | Decimal | False |
Total distance traveled during a business trip, used for mileage reimbursement calculations. |
| UOMDays | Decimal | False |
Unit of measure for the number of days for per diem calculations. |
| ValidationErrorFlag | Bool | False |
Indicates whether the expense has failed validation checks and requires correction. |
| ValidationErrorMessages | String | False |
Error messages generated during validation, providing details on issues with the expense. |
| ValidationWarningMessages | String | False |
Warning messages generated during validation, indicating potential issues with the expense. |
| VehicleCategoryCode | String | False |
Code for the category of vehicle used, such as COMPANY, PRIVATE, or RENTAL. |
| VehicleType | String | False |
Type of vehicle used, for which mileage reimbursement may be applicable (for example, CAR, MOTORCYCLE, VAN). |
| ZoneCode | String | False |
Code that indicates the geographical zone for mileage reimbursement or trip planning. |
| ZoneTypeCode | String | False |
Code that specifies the lookup type for defining geographical zones used in calculating mileage rates. |
| BusinessUnit | String | False |
Business unit associated with the expense, used for departmental and financial tracking. |
| PersonName | String | False |
Name of the individual incurring the expense. |
| ExpenseTemplate | String | False |
Template associated with the expense item, used to categorize and standardize expenses. |
| ExpenseType | String | False |
Expense type categorizing the expense, such as travel, lodging, or meals. |
| ReceiptCurrency | String | False |
Currency of the receipt for the expense, providing clarity on exchange rates or reimbursement needs. |
| ReimbursementCurrency | String | False |
Currency used for reimbursing an expense, which may differ from the receipt currency. |
| DistanceUnit | String | True |
Unit of measurement used for travel distances, such as KILOMETER or MILE. |
| TicketClass | String | False |
Class of ticket for travel (for example, BUSINESS, ECONOMY). |
| ExpenseSourceName | String | True |
Source of the expense, such as Cash or Corporate Card. |
| ReferenceNumber | String | True |
Unique reference number for tracking the object version or transaction. |
| Request | Long | True |
Identifier for the credit card upload process, used for tracking and processing. |
| AttachmentExists | String | True |
Indicates whether an attachment is associated with the expense. |
| ExpenseReportStatus | String | True |
Status of the expense report (for example, Approved, Pending, Submitted). |
| AuthTrxnNumber | String | False |
Code representing the authorization number for a credit card transaction. |
| TravelTypeName | String | False |
Name of the travel type, either Domestic or International. |
| VehicleCategory | String | False |
Category of the vehicle used for the expense, such as COMPANY, PRIVATE, or RENTAL. |
| VehicleTypeName | String | False |
Name of the type of vehicle used for the expense, such as CAR, MOTORCYCLE, or VAN. |
| FuelTypeName | String | False |
Name of the fuel type used for a vehicle expense. |
| TaxClassification | String | False |
Meaning of the tax classification code, defining the tax treatment for the expense. |
| CountryCode | String | False |
Code indicating the country where the expense was incurred, relevant for tax and reporting purposes. |
| AutoSubmitDate | Datetime | False |
Date when the expense was automatically submitted for processing or approval. |
| ReceiptTime | Datetime | False |
Exact date and time when the transaction related to the receipt occurred, helping to differentiate transactions on the same day. |
| TipAmount | Decimal | False |
Amount of tip given as part of the expense transaction. |
| VisitedFlag | Bool | False |
Indicates whether the user has confirmed or visited the expense entry, ensuring accuracy. |
| ValidationStatus | String | False |
Status of the validation process for the expense, with values such as errors, warnings, or successful validation. |
| PrepaidFlag | Bool | False |
Indicates whether the expense is prepaid, such as a booked flight or hotel. |
| ExpenseAttendee | String | False |
Indicates the attendees for an expense item. Used in insertion processes for events and gatherings. |
| ExpenseDff | String | False |
Custom field for expense data that can only be used during insert operations. |
| expenseErrors | String | False |
Contains error messages for the expense item during insertion processes. |
| matchedExpenses | String | False |
Indicates matched expenses, used for linking related transactions. |
| ExpenseItemization | String | False |
Indicates itemization of the expense, used in insertion processes for detailed breakdown. |
| duplicateExpenses | String | False |
Indicates any duplicate expenses detected, requiring action for correction. |
| ExpenseDistribution | String | False |
Data on how the expense is distributed across accounts or departments. |
| Finder | String | True |
Finder value used for locating specific expenses. |
| SysEffectiveDate | String | True |
System effective date used for tracking the validity of data. |
| EffectiveDate | Date | True |
Date the data became effective, used for filtering records by date. |
Manages key supplier invoice data, including header, lines, distributions, installments, and descriptive flexfields for payables processing.
The Sync App uses the Oracle Fusion Cloud Financials API to process some of the filters having queryable=true in metadata. The Sync App processes other filters within the Sync App.
For example, the following query is processed server side:
SELECT * FROM [Cdata].[Financials].[Invoices] WHERE InvoiceId = 10003
Create an invoice.
INSERT INTO [Cdata].[Financials].[Invoices] (InvoiceNumber,InvoiceCurrency,InvoiceAmount,InvoiceDate,BusinessUnit,Supplier,SupplierSite,Requester,InvoiceGroup,Description) VALUES ('AND_Unmatched_Invoice','USD',2212.75,'2019-02-01','Vision Operations','Advanced Network Devices','FRESNO','Johnson,Mary','01Feb2019','Office Supplies')
If you want to add child views/tables along with the parent table, you can add the child in following ways:
Using TEMP table:
INSERT into InvoicesinvoiceLinesinvoiceDistributions#TEMP(DistributionLineNumber,DistributionCombination,DistributionAmount,DistributionLineType,CUReferenceNumber) values (26,'101.10.60230.462.000.000',3.25,'Item',1)
INSERT into InvoicesinvoiceLinesinvoiceDistributions#TEMP(DistributionLineNumber,DistributionCombination,DistributionAmount,DistributionLineType,CUReferenceNumber) values (27,'101.10.60230.462.000.000',83.25,'Item',2)
INSERT into InvoicesinvoiceLines#TEMP(invoiceDistributions,LineNumber,DistributionCombination,LineAmount,CUReferenceNumber) values ('InvoicesinvoiceLinesinvoiceDistributions#TEMP',46,'101.10.60230.462',3.25,1)
INSERT into InvoicesinvoiceLines#TEMP(invoiceDistributions,LineNumber,DistributionCombination,LineAmount,CUReferenceNumber) values ('InvoicesinvoiceLinesinvoiceDistributions#TEMP',47,'101.10.60230.462',36.25,2)
INSERT INTO [Cdata].[Financials].[Invoices] (InvoiceNumber,InvoiceCurrency,InvoiceAmount,InvoiceDate,BusinessUnit,Supplier,SupplierSite,Requester,InvoiceGroup,Description,invoiceLines) VALUES ('AND_Unmatched_Invoice','USD',2212.75,'2019-02-01','Vision Operations','Advanced Network Devices','FRESNO','Johnson,Mary','01Feb2019','Office Supplies','InvoicesinvoiceLines#TEMP')
Note : you can use CUReferenceNumber to map the child views/tables to their parent. For example, invoiceLines having CUReferenceNumber 1, will have the child aggregates having CUReferenceNumber 1.
Directly providing the aggregate:
INSERT INTO [Cdata].[Financials].[Invoices] (InvoiceNumber,InvoiceCurrency,InvoiceAmount,InvoiceDate,BusinessUnit,Supplier,SupplierSite,Requester,InvoiceGroup,Description,invoiceLines) VALUES ('AND_Unmatched_Invoice','USD',2212.75,'2019-02-01','Vision Operations','Advanced Network Devices','FRESNO','Johnson,Mary','01Feb2019','Office Supplies','[
{
"LineNumber": 3,
"LineAmount": 54.25,
"DistributionCombination": "101.10.60230.462"
}
]')
The Oracle Fusion Cloud Financials API uses InvoiceUniqId instead of InvoiceId as a path parameter in the URL to update the record.
If you want to update a record directly using the id (without any other filter), you can update the record in the following way:
Update [Cdata].[Financials].[Invoices] set Description='abcd' where InvoiceUniqId=454545454;
Note: This does not require any extra GET request to retrieve the UniqId.
Alternatively, if you want to apply any other filter. Please use InvoiceId instead of InvoiceUniqId. You can update the record in the following way:
Update [Cdata].[Financials].[Invoices] set Description='abcd' where InvoiceId=454545454 and Supplier='abc';
Note : Update on aggregates are not allowed by API, use the child tables to add/update/delete aggregates.
The Oracle Fusion Cloud Financials API uses InvoiceUniqId instead of InvoiceId as a path parameter in the URL to delete the record.
If you want to delete a record directly using the id (without any other filter), you can delete the record in the following way:
Delete from [Cdata].[Financials].[Invoices] where InvoiceUniqId=454545454;
Note: This does not require any extra GET request to retrieve the UniqId.
Alternatively, if you want to apply any other filter. Please use InvoiceId instead of InvoiceUniqId. You can delete the record in the following way:
Delete from [Cdata].[Financials].[Invoices] where InvoiceUniqId=454545454 and Supplier='abc';
| Name | Type | ReadOnly | Description |
| InvoiceId [KEY] | Long | True |
Unique identifier for the invoice, used for tracking and managing invoices in the system. |
| InvoiceUniqId [KEY] | String | True |
Alternative unique identifier for the invoice, used for insert, update, and delete operations to manage invoice records. |
| InvoiceNumber | String | False |
The unique number assigned to the supplier invoice, used for referencing and identifying the invoice. |
| InvoiceCurrency | String | False |
Currency code used on the invoice, which can be manually specified or defaulted from the Supplier Site or invoicing business unit. |
| PaymentCurrency | String | False |
Currency used to make a payment for the invoice, specified during invoice creation or defaulted from the Supplier Site or business unit settings. |
| InvoiceAmount | Decimal | False |
The total amount of the invoice in the transaction currency, specified when creating the invoice. |
| InvoiceDate | Date | False |
The date on the supplier invoice, which can be set during creation or defaulted to the system date. |
| BusinessUnit | String | False |
The name of the business unit for the invoice, set during creation and cannot be changed after the invoice is created. |
| Supplier | String | False |
The name of the supplier associated with the invoice, provided during invoice creation and cannot be changed afterward. |
| SupplierNumber | String | True |
Unique identifier for the supplier associated with the invoice. |
| ProcurementBU | String | False |
Procurement business unit linked to the supplier site for identifying the correct supplier site in the invoice. |
| SupplierSite | String | False |
The physical location of the supplier where goods and services are delivered. This value must be set at invoice creation and is immutable afterward. |
| RequesterId | Long | False |
Unique identifier for the requester who initiated the goods or services request, used in invoice approval workflows. |
| Requester | String | False |
Name of the person requesting the goods or services associated with the invoice. |
| InvoiceGroup | String | False |
Name of the invoice group, assigned for reporting and payment purposes, required during invoice creation based on business unit settings. |
| ConversionRateType | String | False |
The source of the currency conversion rate for the invoice, used when dealing with non-functional currencies. |
| ConversionDate | Date | False |
Date when the conversion rate is applied to convert amounts to another currency, essential for non-functional currency invoices. |
| ConversionRate | Decimal | False |
The rate used to convert one currency into another for the invoice, essential for non-functional currency invoices. |
| AccountingDate | Date | False |
The accounting date for the invoice, determining when the invoice is recorded in accounting. It can be defaulted or manually provided. |
| Description | String | False |
A textual description of the invoice for clarification or additional information. |
| DeliveryChannelCode | String | False |
Code used to identify the method of payment delivery associated with the invoice. |
| DeliveryChannel | String | False |
The text on electronic payment instructions used by the bank for processing payments, such as printing a check or holding it for collection. |
| PayAloneFlag | Bool | False |
Flag indicating whether the invoice is to be paid independently of other invoices for the same supplier. |
| InvoiceSourceCode | String | True |
The code that identifies the source of the invoice, such as a spreadsheet, external system, or user-defined source. |
| InvoiceSource | String | False |
The source system from which the invoice was created, such as external systems or spreadsheets. |
| InvoiceType | String | False |
The type of invoice, such as Standard, Prepayment, Credit Memo, or Debit Memo, defined by the invoice amount and other parameters. |
| PayGroup | String | False |
Groups invoices for a single payment run, categorizing suppliers into specific groups like Employees, Merchandise, or Government. |
| InvoiceReceivedDate | Date | False |
The date when the invoice was received, which can be used to calculate the due date for payments. |
| PaymentReasonCode | String | False |
User-defined code for categorizing the reason for the payment. |
| PaymentReason | String | False |
Code from a government or central bank that provides additional details on the reason for payment, used for regulatory reporting. |
| PaymentReasonComments | String | False |
User comments explaining the reason for the payment, which can be entered during invoice creation. |
| RemittanceMessageOne | String | False |
First remittance message used for payment processing, providing additional payment details. |
| RemittanceMessageTwo | String | False |
Second remittance message used for payment processing. |
| RemittanceMessageThree | String | False |
Third remittance message used for payment processing. |
| PaymentTerms | String | False |
Terms used to calculate payment dates, installments, and discount amounts, based on agreements with the supplier. |
| TermsDate | Date | False |
Date used along with payment terms to determine due dates and discount dates. |
| GoodsReceivedDate | Date | False |
The date when goods were received, used for calculating the invoice payment due date. |
| PaymentMethodCode | String | False |
Code used to identify the method of payment, such as check, cash, or credit card. |
| PaymentMethod | String | False |
Indicates how the payer will make the payment, which can be defaulted from supplier or profile-level payment settings. |
| SupplierTaxRegistrationNumber | String | False |
Tax registration number of the supplier, used for tax reporting and compliance. |
| FirstPartyTaxRegistrationId | Long | False |
Unique identifier for the first party tax registration. |
| FirstPartyTaxRegistrationNumber | String | False |
Tax registration number of the first party, used for legal and financial purposes. |
| LegalEntity | String | False |
The name of the legal entity associated with the invoice, either manually entered or defaulted. |
| LegalEntityIdentifier | String | False |
The identifier for the legal entity, used for tracking and compliance purposes. |
| LiabilityDistribution | String | False |
Account combination for recording liabilities associated with the invoice. |
| DocumentCategory | String | False |
Category of the document, used for organizing and classifying invoice types. |
| DocumentSequence | Long | False |
Manual sequence number used when sequential document numbering is enabled. |
| VoucherNumber | String | False |
Voucher number assigned to the invoice if document numbering is not used. |
| ValidationStatus | String | False |
Indicates the validation state of the invoice, typically 'Not Validated' by default. |
| ApprovalStatus | String | True |
Approval state of the invoice, showing whether it is approved, pending, or rejected. |
| PaidStatus | String | True |
Indicates whether the invoice has been paid. |
| AccountingStatus | String | True |
Accounting state of the invoice, showing whether it has been processed in the accounting system. |
| ApplyAfterDate | Date | False |
Date after which a prepayment invoice can be applied to other invoices. This applies only to temporary prepayments. |
| CanceledFlag | Bool | True |
Indicates whether the invoice has been canceled. |
| AmountPaid | Decimal | True |
The amount paid against the invoice. |
| BaseAmount | Decimal | True |
The base amount of the invoice before any adjustments or currency conversions. |
| PurchaseOrderNumber | String | False |
Purchase order number associated with the invoice, used to match invoices to purchase orders. |
| Party | String | True |
The party associated with the invoice. |
| PartySite | String | True |
The party site associated with the invoice, providing further details about the location or entity. |
| ControlAmount | Decimal | False |
The calculated tax amount that ensures consistency with the physical document. |
| DocumentFiscalClassificationCodePath | String | False |
Classification of transactions that require special documentation for tax purposes, like international transactions. |
| TaxationCountry | String | False |
Country where the transaction occurred, used for taxation and reporting purposes. |
| RoutingAttribute1 | String | True |
Attribute used for routing invoice images. |
| RoutingAttribute2 | String | False |
Additional attribute used for routing invoice images. |
| RoutingAttribute3 | String | False |
Another attribute used for routing invoice images. |
| RoutingAttribute4 | String | False |
Additional routing attribute used for invoice image processing. |
| RoutingAttribute5 | String | True |
Routing attribute used for invoice image processing. |
| AccountCodingStatus | String | True |
Indicates the coding status of the invoice, showing whether it has been correctly accounted for. |
| BudgetDate | Date | False |
Date for budgetary calendar periods used for funds checks. |
| FundsStatus | String | True |
Status of funds availability for the invoice. |
| CanceledDate | Date | True |
Date the invoice was canceled. |
| CanceledBy | String | True |
Username of the person who canceled the invoice. |
| UniqueRemittanceIdentifier | String | False |
Unique identifier for a remittance, used for tracking payments. |
| UniqueRemittanceIdentifierCheckDigit | String | False |
Check digit for validating the unique remittance identifier. |
| CreationDate | Datetime | True |
Timestamp when the invoice record was created. |
| CreatedBy | String | True |
Username of the person who created the invoice. |
| LastUpdatedBy | String | True |
Username of the person who last updated the invoice. |
| LastUpdateDate | Datetime | True |
Timestamp when the invoice was last updated. |
| LastUpdateLogin | String | True |
Session login associated with the user who last updated the invoice. |
| BankAccount | String | False |
Bank account number to which the payment for the invoice is remitted. |
| SupplierIBAN | String | False |
Supplier's International Bank Account Number (IBAN), used for international payments. |
| ExternalBankAccountId | Long | False |
Unique identifier for the external bank account associated with the supplier. |
| BankChargeBearer | String | False |
Indicates who is responsible for bank charges, such as the payer or payee. |
| SettlementPriority | String | False |
Priority assigned to the payment for processing based on urgency. |
| ReferenceKeyOne | String | True |
First reference key for invoice tracking. |
| ReferenceKeyTwo | String | True |
Second reference key for invoice tracking. |
| ReferenceKeyThree | String | True |
Third reference key for invoice tracking. |
| ReferenceKeyFour | String | True |
Fourth reference key for invoice tracking. |
| ReferenceKeyFive | String | True |
Fifth reference key for invoice tracking. |
| ProductTable | String | True |
Product table used to categorize the invoice. |
| ImageDocumentNumber | String | True |
Document number for the invoice image. |
| invoiceLines | String | False |
Details of the invoice lines, used for itemizing the products or services. |
| appliedPrepayments | String | False |
Details of prepayments applied to the invoice. |
| availablePrepayments | String | False |
Details of available prepayments for the invoice. |
| invoiceGdf | String | False |
Global descriptive flexfield for additional invoice data. |
| invoiceInstallments | String | False |
Details of installments for the invoice. |
| invoiceDff | String | False |
User-defined descriptive flexfield for the invoice. |
| Finder | String | True |
Search term or identifier used to locate and retrieve specific invoices. |
| EffectiveDate | Date | True |
Date used to fetch resources that are effective as of a specified start date. |
Supports organization-specific data fields on invoices, leveraging descriptive flexfields for custom reporting or validations.
The Sync App uses the Oracle Fusion Cloud Financials API to process some of the filters having queryable=true in metadata. The Sync App processes other filters within the Sync App.
For example, the following query is processed server side:
SELECT * FROM [Cdata].[Financials].[InvoicesinvoiceDff] WHERE InvoiceId = 10003
Create an InvoicesinvoiceDff.
You need to provide InvoicesUniqId, instead of InvoicesInvoiceId, to insert the invoiceDff.
INSERT into [Cdata].[Financials].[InvoicesinvoiceDff](InvoicesUniqId,[__FLEX_Context_DisplayValue],[__FLEX_Context]) values (45,'My Group 2','My Group 2')
The Oracle Fusion Cloud Financials API uses InvoicesUniqId instead of InvoicesInvoiceId and InvoiceUniqId instead of InvoiceId as a path parameter in the URL to update the record.
If you want to update a record directly using the id (without any other filter), you can update the record in the following way:
Update [Cdata].[Financials].[InvoicesinvoiceDff] set MyDescription='asdw' where InvoiceUniqId=45 and InvoicesUniqId=45;
Note: This does not require any extra GET request to retrieve the UniqId.
Alternatively, if you want to apply any other filter. Please use InvoiceId instead of InvoiceUniqId and InvoicesInvoiceId instead of InvoicesUniqId. You can update the record in the following way:
Update [Cdata].[Financials].[InvoicesinvoiceDff] set MyDescription='asdw' where InvoicesInvoiceId=45 and MyDescription='aaaa'
Note : Update on aggregates are not allowed by API, use the child tables to add/update/delete aggregates.
| Name | Type | ReadOnly | Description |
| InvoicesInvoiceId [KEY] | Long | True |
Unique identifier for the invoice associated with the descriptive flexfield, used to link the flexfield data to its corresponding invoice. |
| InvoicesUniqId [KEY] | String | True |
Unique identifier to be used for insert, update, and delete operations, preferred over InvoicesInvoiceId to manage descriptive flexfield data. |
| InvoiceId [KEY] | Long | False |
The unique identifier for the invoice to which the descriptive flexfield data is linked, used to track and manage the flexfield's association. |
| InvoiceUniqId [KEY] | String | True |
Use this unique identifier for insert, update, and delete operations to handle flexfield data, providing a more flexible approach than InvoiceId. |
| MyDescription | String | False |
Custom description of the invoice, providing additional information or context related to the descriptive flexfield. |
| MyDate | Date | False |
Custom date field for the invoice's descriptive flexfield, capturing a relevant date associated with the invoice. |
| DsComments | String | False |
Custom comments related to the descriptive flexfield, allowing users to add further context or explanations regarding the invoice. |
| _FLEX_Context | String | False |
Context name for the descriptive flexfield, helping define the purpose or use of the flexfield in relation to the invoice. |
| _FLEX_Context_DisplayValue | String | False |
Display value for the descriptive flexfield context, providing a human-readable version of the context name for better user understanding. |
| Finder | String | True |
Search term or identifier used to locate and retrieve specific descriptive flexfield records, aiding in efficient data retrieval. |
| CUReferenceNumber | Int | False |
Reference number used to map child aggregates to parent tables, linking descriptive flexfield data with other related entities. |
| EffectiveDate | Date | True |
Date parameter used to fetch resources that are effective as of a specified start date, ensuring time-sensitive data is retrieved accurately. |
Tracks multiple payment installments tied to a single invoice, detailing amounts and due dates for staged payables.
The Sync App uses the Oracle Fusion Cloud Financials API to process some of the filters having queryable=true in metadata. The Sync App processes other filters within the Sync App.
For example, the following query is processed server side:
SELECT * FROM [Cdata].[Financials].[InvoicesinvoiceInstallments] WHERE InstallmentNumber = 10003
Create an InvoicesinvoiceInstallments.
You need to provide InvoicesUniqId, instead of InvoicesInvoiceId, to insert the record.
INSERT into [Cdata].[Financials].[invoicesinvoiceInstallments](InvoicesUniqId,InstallmentNumber,DueDate,GrossAmount) values (132432,46,'2024-12-31',3.25)
The Oracle Fusion Cloud Financials API uses InvoicesUniqId instead of InvoicesInvoiceId and InstallmentNumberUniqId instead of InstallmentNumber as a path parameter in the URL to update the record.
If you want to update a record directly using the id (without any other filter), you can update the record in the following way:
Update [Cdata].[Financials].[invoicesinvoiceInstallments] set GrossAmount=45.50 where InstallmentNumberUniqId='1324325,45' and InvoicesUniqId=13243;
Note: This does not require any extra GET request to retrieve the UniqId.
Alternatively, if you want to apply any other filter. Please use InstallmentNumber instead of InstallmentNumberUniqId and InvoicesInvoiceId instead of InvoicesUniqId. You can update the record in the following way:
Update [Cdata].[Financials].[invoicesinvoiceInstallments] set GrossAmount=45.50 where GrossAmount=41.2 and InvoicesInvoiceId=13243
Note : Update on aggregates are not allowed by API, use the child tables to add/update/delete aggregates.
The Oracle Fusion Cloud Financials API uses InvoicesUniqId instead of InvoicesInvoiceId and InstallmentNumberUniqId instead of InstallmentNumber as a path parameter in the URL to delete the record.
If you want to delete a record directly using the id (without any other filter), you can delete the record in the following way:
Delete from [Cdata].[Financials].[invoicesinvoiceInstallments] where InvoicesUniqId=132432 and InstallmentNumberUniqId='1324325,46'
Note: This does not require any extra GET request to retrieve the UniqId.
Alternatively, if you want to apply any other filter. Please use InstallmentNumber instead of InstallmentNumberUniqId and InvoicesInvoiceId instead of InvoicesUniqId. You can delete the record in the following way:
Delete from [Cdata].[Financials].[invoicesinvoiceInstallments] where GrossAmount=41.2 and InvoicesInvoiceId=13243
| Name | Type | ReadOnly | Description |
| InvoicesInvoiceId [KEY] | Long | True |
Unique identifier of the invoice associated with the installment, linking the installment data to the corresponding invoice. |
| InvoicesUniqId [KEY] | String | True |
Unique identifier for managing insert, update, and delete operations in place of InvoicesInvoiceId for handling invoice installments. |
| InstallmentNumber [KEY] | Long | False |
The unique number assigned to an invoice installment, helping to track and identify the installment within the larger invoice. |
| InstallmentNumberUniqId [KEY] | String | True |
Unique identifier used for managing insert, update, and delete operations related to invoice installments, preferred over InstallmentNumber. |
| UnpaidAmount | Decimal | True |
The outstanding amount of the invoice installment that has not yet been paid. |
| FirstDiscountAmount | Decimal | False |
Discount amount available on the first discount date, which can be provided during invoice creation or derived from payment terms. |
| FirstDiscountDate | Date | False |
Date when the first discount becomes available, either provided during invoice creation or calculated based on payment terms. |
| DueDate | Date | False |
The date when the installment is due for payment, either provided during invoice creation or determined from payment terms. |
| GrossAmount | Decimal | False |
Total amount due for the installment, representing the full amount before any discounts or adjustments. |
| HoldReason | String | False |
Reason provided for placing or releasing the hold on the installment, allowing flexibility in managing payment statuses. |
| PaymentPriority | Int | False |
Priority number for paying this installment, influencing the order in which installments are processed. |
| SecondDiscountAmount | Decimal | False |
Discount amount available on the second discount date, similar to the first discount amount, either provided or derived from payment terms. |
| SecondDiscountDate | Date | False |
Date when the second discount becomes available, derived from payment terms or specified during invoice creation. |
| ThirdDiscountAmount | Decimal | False |
Discount amount available on the third discount date, provided or calculated based on terms. |
| ThirdDiscountDate | Date | False |
Date when the third discount is available, calculated based on the payment terms or provided at invoice creation. |
| NetAmountOne | Decimal | True |
Net amount associated with the first installment of the invoice, after applying any discounts or adjustments. |
| NetAmountTwo | Decimal | True |
Net amount for the second installment of the invoice, reflecting any changes due to discounts or other factors. |
| NetAmountThree | Decimal | True |
Net amount for the third installment of the invoice, calculated after all applicable adjustments. |
| HoldFlag | Bool | False |
Indicates whether a scheduled payment is currently on hold due to validation issues or other reasons. |
| HeldBy | String | True |
The user or system entity responsible for placing the installment on hold, for traceability and accountability. |
| HoldType | String | True |
Type of hold applied to the installment, detailing the nature of the issue (for example, validation failure). |
| PaymentMethod | String | False |
Method used by the payer to settle the installment, such as check, cash, or credit, which can be defaulted or manually entered. |
| PaymentMethodCode | String | False |
Code representing the payment method, uniquely identifying the chosen payment method. |
| HoldDate | Datetime | True |
Timestamp indicating when the hold on the installment was placed or released. |
| BankAccount | String | False |
Bank account number for the supplier where the payment is made, either manually entered or populated from the supplier profile. |
| ExternalBankAccountId | Long | False |
Unique identifier for the supplier's external bank account, prioritized over the bank account if both are provided. |
| CreatedBy | String | True |
Username of the individual who created the installment record, ensuring accountability for data entry. |
| CreationDate | Datetime | True |
Timestamp when the installment record was created, helping track the creation time of the installment. |
| LastUpdateDate | Datetime | True |
Timestamp indicating when the installment record was last updated, providing visibility into its most recent changes. |
| LastUpdatedBy | String | True |
Username of the individual who last updated the installment record, adding traceability for changes. |
| LastUpdateLogin | String | True |
Session login associated with the user who last updated the installment, helping identify the update session. |
| RemitToAddressName | String | False |
Name of the remit-to address where the payment for the installment should be sent, either provided or defaulted from the supplier profile. |
| RemitToSupplier | String | False |
Name of the remit-to supplier where payment should be directed, defined at invoice creation or sourced from the supplier profile. |
| RemittanceMessageOne | String | False |
First remittance message for payment processing, provided during invoice creation or updated later as needed. |
| RemittanceMessageTwo | String | False |
Second remittance message for payment processing, with similar functionality as RemittanceMessageOne. |
| RemittanceMessageThree | String | False |
Third remittance message, serving the same purpose as RemittanceMessageOne and Two, for detailed payment instructions. |
| invoiceInstallmentDff | String | False |
Field for user-defined descriptive flexfield data related to the installment, used for custom data during insert operations. |
| invoiceInstallmentGdf | String | False |
Global descriptive flexfield field for capturing custom, global attributes associated with the invoice installment. |
| Finder | String | True |
Search term or identifier used to locate and retrieve specific invoice installment records. |
| InvoiceId | Long | True |
Unique identifier of the invoice related to the installment, used for tracking the installment data in relation to the invoice. |
| CUReferenceNumber | Int | False |
Reference number that links child aggregate records to parent tables, providing a relationship between data entities. |
| EffectiveDate | Date | True |
Date parameter used to fetch resources that are effective as of a specific start date, ensuring accurate retrieval of relevant data. |
Captures goods, services, freight, and miscellaneous charges at the invoice line level, forming the basis for accounting entries.
The Sync App uses the Oracle Fusion Cloud Financials API to process some of the filters having queryable=true in metadata. The Sync App processes other filters within the Sync App.
For example, the following query is processed server side:
SELECT * FROM [Cdata].[Financials].[InvoicesinvoiceLines] WHERE LineNumber = 10003
Create an InvoicesinvoiceLine.
You need to provide InvoicesUniqId, instead of InvoicesInvoiceId, to insert the record.
INSERT into [Cdata].[Financials].[invoicesinvoiceLines](InvoicesUniqId,LineNumber,DistributionCombination,LineAmount) values (132432,46,'101.10.60230.462',3.25)
The Oracle Fusion Cloud Financials API uses InvoicesUniqId instead of InvoicesInvoiceId and LineNumberUniqId instead of LineNumber as a path parameter in the URL to update the record.
If you want to update a record directly using the id (without any other filter), you can update the record in the following way:
Update [Cdata].[Financials].[invoicesinvoiceLines] set Description='adsw' where LineNumberUniqId='1324325,45' and InvoicesUniqId=13243;
Note: This does not require any extra GET request to retrieve the UniqId.
Alternatively, if you want to apply any other filter. Please use LineNumber instead of LineNumberUniqId and InvoicesInvoiceId instead of InvoicesUniqId. You can update the record in the following way:
Update [Cdata].[Financials].[invoicesinvoiceLines] set Description='adsw' where Description='asas' and InvoicesInvoiceId=13243
Note : Update on aggregates are not allowed by API, use the child tables to add/update/delete aggregates.
The Oracle Fusion Cloud Financials API uses InvoicesUniqId instead of InvoicesInvoiceId and LineNumberUniqId instead of LineNumber as a path parameter in the URL to delete the record.
If you want to delete a record directly using the id (without any other filter), you can delete the record in the following way:
Delete from [Cdata].[Financials].[invoicesinvoiceLines] where InvoicesUniqId=132432 and LineNumberUniqId='1324325,46'
Note: This does not require any extra GET request to retrieve the UniqId.
Alternatively, if you want to apply any other filter. Please use LineNumber instead of LineNumberUniqId and InvoicesInvoiceId instead of InvoicesUniqId. You can delete the record in the following way:
Delete from [Cdata].[Financials].[invoicesinvoiceLines] where Description='asas' and InvoicesInvoiceId=13243
| Name | Type | ReadOnly | Description |
| InvoicesInvoiceId [KEY] | Long | True |
Unique identifier of the invoice associated with the invoice line, linking the line to its corresponding invoice. |
| InvoicesUniqId [KEY] | String | True |
Unique identifier used for insert, update, and delete operations, preferred over InvoicesInvoiceId when managing invoice lines. |
| LineNumber [KEY] | Int | False |
Unique number assigned to each invoice line. It must be provided when creating the invoice line and cannot be updated once created. |
| LineNumberUniqId [KEY] | String | True |
Unique identifier for managing insert, update, and delete operations related to invoice lines, preferred over LineNumber. |
| LineAmount | Decimal | False |
The amount of the invoice line in the invoice currency. This value must be provided during invoice line creation. |
| AccountingDate | Date | False |
The accounting date for the invoice line, which is used to default values in invoice distributions. It can be derived or manually entered. |
| UOM | String | False |
Unit of measure for the quantity invoiced, such as 'kg', 'box', etc., indicating the quantity for the line item. |
| TaxRateName | String | True |
Name of the tax rate associated with the invoice line, defining the applicable tax rate. |
| LineType | String | False |
Type of invoice line, such as 'Item', 'Freight', or 'Miscellaneous'. The type defines the nature of the line item. |
| AssetBook | String | False |
Asset book associated with the invoice line, relevant for transferring the item to Oracle Fusion Assets. |
| TrackAsAssetFlag | Bool | False |
Indicates whether the item should be tracked as an asset in Oracle Fusion Assets. Defaulted based on distribution settings. |
| BaseAmount | Decimal | True |
Base amount for the invoice line before taxes and adjustments. |
| Description | String | False |
Description of the invoice line item, providing additional details about the line. |
| IncomeTaxRegion | String | False |
Region for reporting income tax on the invoice line, used for tax purposes, especially in 1099 reporting. |
| Item | String | False |
Inventory item identifier, corresponding to the item being invoiced. |
| ItemDescription | String | True |
Description of the inventory item associated with the invoice line. |
| LineSource | String | True |
Source of the invoice line, identifying how the line item is classified or categorized. |
| Quantity | Decimal | False |
The quantity of items invoiced, including any price corrections, quantity corrections, or unmatched lines. |
| DistributionCombination | String | False |
Accounting flexfield used for generating a distribution for the invoice line. This can be defaulted from supplier settings. |
| AssetCategory | String | False |
Category under which the asset line is grouped when transferring to Oracle Fusion Assets. |
| UnitPrice | Decimal | False |
Price per unit of the good or service invoiced. |
| ProrateAcrossAllItemsFlag | Bool | False |
Indicates whether freight or miscellaneous charges should be prorated across all item lines. Default is false. |
| LandedCostEnabled | String | False |
Indicates whether the invoice line is enabled for calculating and including landed cost. |
| DiscardedFlag | Bool | True |
Flag indicating whether the invoice line has been discarded and should no longer be considered. |
| CanceledFlag | Bool | True |
Flag indicating whether the invoice line has been canceled. |
| IncomeTaxType | String | False |
Income tax type applicable to the supplier, such as 1099 tax classification for certain suppliers. |
| TaxRateCode | String | True |
Tax rate code applied to the invoice line for tax calculation purposes. |
| TaxRate | Decimal | True |
Tax rate applied to the invoice line, indicating the percentage for tax calculation. |
| TaxClassification | String | False |
Tax classification code used to categorize the invoice line for tax purposes. |
| GenerateDistributions | String | True |
Indicates whether distributions should be generated for the invoice line during accounting. |
| BudgetDate | Date | False |
Budgetary calendar period date applicable for funds checking. |
| FundsStatus | String | True |
Status of funds available for the invoice line, used in budget tracking. |
| ApprovalStatus | String | True |
Current approval status of the invoice line, indicating whether it is approved, pending, etc. |
| DistributionSet | String | False |
Distribution set used for generating distributions for the invoice line. |
| Withholding | String | False |
Name of the withholding tax group applied to the invoice line. |
| ShipToLocationCode | String | False |
Code identifying the location where goods were shipped to for the invoice line. |
| ShipToLocation | String | False |
Location where the goods or services were delivered, as specified for the invoice line. |
| ShipToCustomerLocation | String | True |
Customer location associated with the invoice line delivery. |
| TaxControlAmount | Decimal | False |
User-entered amount ensuring the calculated tax matches the physical document. |
| AssessableValue | Decimal | False |
Deemed price at which the product is valued for tax calculation purposes. |
| ProductType | String | False |
Type of product, such as goods or services, determined by the inventory item attributes. |
| ProductCategory | String | False |
Taxable nature of a non-inventory item, used for tax calculation and reporting purposes. |
| ProductCategoryCodePath | String | False |
Code path used to uniquely identify a product category for tax reporting. |
| UserDefinedFiscalClassification | String | False |
Classification used for any tax requirements not defined by standard fiscal classification types. |
| UserDefinedFiscalClassificationCode | String | False |
User-entered code for a custom fiscal classification. |
| IntendedUse | String | False |
Tax driver used to determine applicable taxes for the invoice line. |
| IntendedUseCode | String | False |
Code identifying the intended use for tax purposes, used to help determine tax rates. |
| ProductFiscalClassification | String | False |
Tax classification used by tax authorities to categorize a product. |
| ProductFiscalClassificationCode | String | False |
Code used to uniquely identify the product fiscal classification. |
| ProductFiscalClassificationType | String | False |
Type of product fiscal classification used for tax purposes. |
| TransactionBusinessCategory | String | False |
Transaction category assigned to the invoice line for tax calculation. |
| TransactionBusinessCategoryCodePath | String | False |
Code path used to uniquely identify a transaction business category. |
| Requester | String | False |
Name of the person who requested the goods or services, used in the invoice approval workflow. |
| PurchasingCategory | String | True |
Category used to group purchases for tax and reporting purposes. |
| MatchType | String | True |
Indicates the matching type used for the invoice line, such as Purchase Order Match. |
| MatchOption | String | True |
Option used to control how the invoice line is matched, such as 2-way or 3-way matching. |
| MatchBasis | String | True |
Basis used to perform the match between the invoice line and purchase orders or receipts. |
| PurchaseOrderNumber | String | False |
Purchase order number matched to the invoice line. |
| PurchaseOrderLineNumber | Decimal | False |
Purchase order line number matched to the invoice line. |
| PurchaseOrderScheduleLineNumber | Decimal | False |
Schedule line number from the purchase order matched to the invoice line. |
| ReceiptNumber | String | False |
Receipt number associated with the invoice line. |
| ReceiptLineNumber | Long | False |
Receipt line number associated with the invoice line. |
| ConsumptionAdviceNumber | String | False |
Consignment advice number associated with the invoice line. |
| ConsumptionAdviceLineNumber | Decimal | False |
Line number of the consignment advice matched to the invoice line. |
| FinalMatchFlag | Bool | False |
Indicates whether this invoice line is the final match to a purchase order schedule, preventing further matching. |
| MultiperiodAccountingStartDate | Date | False |
Start date for multiperiod accounting for the invoice line. |
| MultiperiodAccountingEndDate | Date | False |
End date for multiperiod accounting for the invoice line. |
| MultiperiodAccountingAccrualAccount | String | False |
Account used for accruals in multiperiod accounting. |
| CreatedBy | String | True |
User who created the invoice line. |
| CreationDate | Datetime | True |
Date when the invoice line was created. |
| LastUpdateDate | Datetime | True |
Date when the invoice line was last updated. |
| LastUpdatedBy | String | True |
User who last updated the invoice line. |
| LastUpdateLogin | String | True |
Login session associated with the user who last updated the invoice line. |
| RequesterId | Long | False |
Unique identifier for the requester of the goods or services. |
| PrepaymentNumber | String | True |
Prepayment number linked to the invoice line. |
| PrepaymentLineNumber | Int | True |
Prepayment line number associated with the invoice line. |
| PrepaymentIncludedonInvoiceFlag | Bool | True |
Indicates whether the prepayment is included on the invoice. |
| ReferenceKeyTwo | String | True |
Secondary reference key used to uniquely identify the invoice line. |
| ProductTable | String | True |
Product table associated with the invoice line. |
| invoiceLineGdf | String | False |
Global descriptive flexfield for additional attributes related to the invoice line. |
| invoiceLineProjectDff | String | False |
Project descriptive flexfield used for managing project-specific invoice line data. |
| invoiceDistributions | String | False |
Used for managing distribution details of the invoice line. |
| invoiceLineDff | String | False |
Descriptive flexfield for user-defined attributes related to the invoice line. |
| Finder | String | True |
Search term or identifier used to locate and retrieve specific invoice line records. |
| InvoiceId | Long | True |
Unique identifier for the invoice related to the line item. |
| CUReferenceNumber | Int | False |
Reference number linking the child aggregates to parent tables. |
| EffectiveDate | Date | True |
Date parameter used to fetch resources that are effective as of the specified start date. |
Creates distribution records per invoice line, detailing account numbers, distribution dates, and expense allocations.
The Sync App uses the Oracle Fusion Cloud Financials API to process some of the filters having queryable=true in metadata. The Sync App processes other filters within the Sync App.
For example, the following query is processed server side:
SELECT * FROM [Cdata].[Financials].[InvoicesinvoiceLinesinvoiceDistributions] WHERE InvoiceDistributionId = 10003
Create an InvoicesinvoiceLinesinvoiceDistribution.
You need to provide InvoicesUniqId instead of InvoicesInvoiceId and InvoicelinesUniqId instead of InvoicelinesLineNumber, to insert the record.
INSERT into [Cdata].[Financials].[invoicesinvoiceLinesinvoiceDistributions](InvoicesUniqId,InvoicelinesUniqId,DistributionLineNumber,DistributionCombination,DistributionAmount,DistributionLineType) values (132432,'132432,10',46,'101.10.60230.462',3.25,'Item')
The Oracle Fusion Cloud Financials API uses InvoicesUniqId instead of InvoicesInvoiceId, InvoicelinesUniqId instead of InvoicelinesLineNumber and InvoiceDistributionUniqId instead of InvoiceDistributionId as a path parameter in the URL to update the record.
If you want to update a record directly using the id (without any other filter), you can update the record in the following way:
Update [Cdata].[Financials].[invoicesinvoiceLinesinvoiceDistributions] set Description='adsw' where InvoicelinesUniqId='1324325,45' and InvoicesUniqId=13243 and InvoiceDistributionUniqId=300000294882
Note: This does not require any extra GET request to retrieve the UniqId.
Alternatively, if you want to apply any other filter. Please use InvoicelinesLineNumber instead of InvoicelinesUniqId, InvoiceDistributionId instead of InvoiceDistributionUniqId and InvoicesInvoiceId instead of InvoicesUniqId. You can update the record in the following way:
Update [Cdata].[Financials].[invoicesinvoiceLinesinvoiceDistributions] set Description='adsw' where InvoicesInvocieId=1324325 and Description='asw'
Note : Update on aggregates are not allowed by API, use the child tables to add/update/delete aggregates.
The Oracle Fusion Cloud Financials API uses InvoicesUniqId instead of InvoicesInvoiceId, InvoicelinesUniqId instead of InvoicelinesLineNumber and InvoiceDistributionUniqId instead of InvoiceDistributionId as a path parameter in the URL to delete the record.
If you want to delete a record directly using the id (without any other filter), you can delete the record in the following way:
Delete from [Cdata].[Financials].[invoicesinvoiceLinesinvoiceDistributions] where InvoicesUniqId=132432 and InvoicelinesUniqId='1324325,46' and InvoiceDistributionUniqId=300000294882
Note: This does not require any extra GET request to retrieve the UniqId.
Alternatively, if you want to apply any other filter. Please use InvoicelinesLineNumber instead of InvoicelinesUniqId, InvoiceDistributionId instead of InvoiceDistributionUniqId and InvoicesInvoiceId instead of InvoicesUniqId. You can delete the record in the following way:
Delete from [Cdata].[Financials].[invoicesinvoiceLinesinvoiceDistributions] where InvoicelinesLineNumber=46 and Description='asdw'
| Name | Type | ReadOnly | Description |
| InvoicesInvoiceId [KEY] | Long | True |
Unique identifier of the invoice associated with the invoice distribution, linking the distribution to the main invoice. |
| InvoicesUniqId [KEY] | String | True |
Unique identifier used for insert, update, and delete operations, preferred over InvoicesInvoiceId when managing invoice distributions. |
| InvoicelinesLineNumber [KEY] | Int | True |
Unique line number for the invoice, representing the invoice line to which the distribution is associated. |
| InvoicelinesUniqId [KEY] | String | True |
Unique identifier for managing insert, update, and delete operations related to invoice lines, preferred over InvoicelinesLineNumber. |
| InvoiceDistributionId [KEY] | Long | True |
Unique identifier for the invoice distribution record. It links the distribution to its associated invoice line. |
| InvoiceDistributionUniqId [KEY] | String | True |
Unique identifier for managing insert, update, and delete operations related to invoice distributions, preferred over InvoiceDistributionId. |
| DistributionLineNumber | Long | False |
Line number associated with the invoice distribution, identifying its sequence and relationship to the invoice. |
| DistributionLineType | String | False |
Type of the distribution line, such as 'Item', 'Freight', or 'Miscellaneous', used to categorize the distribution. |
| IncomeTaxType | String | False |
Tax type associated with the supplier's 1099 classification. It can be used to determine the applicable tax type for the invoice distribution. |
| AccountingStatus | String | True |
Current accounting status of the invoice distribution, indicating whether it has been processed for accounting. |
| MatchedStatus | String | True |
Indicates the matching status of the invoice distribution, showing whether the distribution has been matched with related documents such as purchase orders. |
| ValidationStatus | String | False |
Indicates whether the invoice distribution has passed validation and if all invoice holds have been released. The default value is 'Not Validated'. |
| AccountingDate | Date | False |
Date when the invoice distribution is recorded in accounting. It can be provided during creation or populated from the invoice header. |
| DistributionAmount | Decimal | False |
The total amount of the invoice distribution, which must be provided during creation and represents the allocated value for that distribution. |
| AssetBook | String | False |
Asset book associated with the invoice distribution, used for asset tracking in Oracle Fusion Assets. |
| DistributionCombination | String | False |
The accounting flexfield used for the distribution's account. This can be provided manually or defaulted from the invoice line. |
| TrackAsAssetFlag | Bool | False |
Indicates whether the invoice distribution is associated with an asset and should be tracked in Oracle Fusion Assets. |
| BaseAmount | Decimal | True |
Base amount before tax and other adjustments for the invoice distribution. |
| CanceledFlag | Bool | False |
Indicates whether the invoice distribution has been canceled. Default is false; set to true if the distribution has been canceled. |
| Description | String | False |
Description of the invoice distribution, providing details about the allocation or item represented by the distribution. |
| IncomeTaxRegion | String | False |
Tax reporting region for the invoice distribution, used for 1099 suppliers to determine the income tax region. |
| ReversedFlag | Bool | False |
Indicates whether the invoice distribution is part of a reversal. Default is false; set to true for reversal entries. |
| InvoicedQuantity | Decimal | True |
Quantity of items invoiced for the distribution, matching the quantity invoiced for the related line. |
| UOM | String | True |
Unit of measure for the invoiced quantity, such as 'kg', 'box', etc. |
| UnitPrice | Decimal | True |
Price per unit of the invoiced items in the distribution. |
| PurchaseOrderDistributionLineNumber | Decimal | True |
Purchase order distribution line number matched to the invoice distribution. |
| PurchaseOrderNumber | String | True |
Purchase order number associated with the invoice distribution. |
| PurchaseOrderLineNumber | Decimal | True |
Purchase order line number matched to the invoice distribution. |
| PurchaseOrderScheduleLineNumber | Decimal | True |
Purchase order schedule line number matched to the invoice distribution. |
| ReceiptNumber | String | True |
Receipt number associated with the invoice distribution, representing goods receipt for the invoice line. |
| ReceiptLineNumber | Long | True |
Receipt line number associated with the invoice distribution. |
| ConsumptionAdviceNumber | String | True |
Consignment advice number linked to the invoice distribution. |
| ConsumptionAdviceLineNumber | Decimal | True |
Line number of the consignment advice linked to the invoice distribution. |
| AssociatedItemDistributionLineNumber | String | True |
Line number associated with the item distribution, helping to link the distribution to specific items. |
| FinalMatchFlag | Bool | True |
Indicates whether this invoice distribution is the final match for a purchase order, preventing further matches for that purchase order. |
| MultiperiodAccountingStartDate | Date | False |
Start date for multiperiod accounting applied to the invoice distribution. |
| MultiperiodAccountingEndDate | Date | False |
End date for multiperiod accounting applied to the invoice distribution. |
| MultiperiodAccountingAccrualAccount | String | False |
Account used for accruals in multiperiod accounting, representing deferred expenses for the distribution. |
| TaxRegimeName | String | True |
Name of the tax regime applied to the invoice distribution, helping to classify the distribution for tax purposes. |
| TaxName | String | True |
Name of the tax applied to the invoice distribution, such as 'VAT', 'Sales Tax', etc. |
| TaxRecoverable | String | True |
Indicates whether the tax paid on the invoice distribution is recoverable, used for tax reporting and management. |
| TaxRate | String | True |
The tax rate applied to the invoice distribution for the calculation of tax amount. |
| TaxRateName | String | True |
Name of the tax rate applied to the invoice distribution. |
| TaxType | String | True |
Type of tax applied to the invoice distribution, such as 'Sales Tax', 'Excise Tax', etc. |
| IntendedUse | String | False |
A tax driver used to determine applicable taxes for the distribution. Can be populated from the source document or entity setup. |
| IntendedUseCode | String | False |
Code that uniquely identifies the intended use for tax purposes in the invoice distribution. |
| CreatedBy | String | True |
User who created the invoice distribution. |
| CreationDate | Datetime | True |
Date when the invoice distribution was created. |
| LastUpdatedBy | String | True |
User who last updated the invoice distribution. |
| LastUpdateDate | Datetime | True |
Date when the invoice distribution was last updated. |
| LastUpdateLogin | String | True |
Login session associated with the user who last updated the invoice distribution. |
| PrepaymentNumber | String | True |
Prepayment number linked to the invoice distribution. |
| PrepaymentLineNumber | String | True |
Prepayment line number linked to the invoice distribution. |
| PrepaymentDistributionLineNumber | String | True |
Prepayment distribution line number linked to the invoice distribution. |
| PrepaymentAvailableAmount | Decimal | False |
Amount of the prepayment available to apply to the invoice distribution. |
| ChargeApplicableToDistId | Long | True |
Charge identifier for the distribution line, used for managing charges applicable to the distribution. |
| AllocationLineNumber | Int | True |
Line number used for the allocation of the invoice distribution. |
| AllocationDistributionLineNumber | Long | True |
Line number for the allocation of the distribution in the system. |
| BudgetDate | Date | False |
Budgetary date for funds check related to the invoice distribution. |
| FundsStatus | String | True |
Funds status for the invoice distribution, indicating whether funds are available for the distribution. |
| Finder | String | True |
Search term or identifier used for locating invoice distribution records. |
| InvoiceId | Long | True |
Unique identifier for the invoice associated with the distribution. |
| CUReferenceNumber | Int | False |
Reference number linking child aggregates to parent tables. |
| EffectiveDate | Date | True |
Date parameter used to fetch resources effective as of the specified start date. |
Manages credit memo records in Receivables, including creation, retrieval, and referencing for financial adjustments.
| Name | Type | ReadOnly | Description |
| CustomerTransactionId [KEY] | Long | False |
The unique identifier of the credit memo transaction, used to link and reference the specific credit memo in the system. |
| CustomerTransactionUniqId [KEY] | String | True |
The unique identifier of the credit memo. Use this value for insert, update, and delete operations, wherever applicable, instead of CustomerTransactionId. |
| TransactionNumber | String | False |
The unique number assigned to the credit memo, used to track and identify the credit memo for financial processing. |
| TransactionDate | Date | False |
The date when the credit memo was created or processed, serving as the reference date for accounting and payment activities. |
| CreatedBy | String | True |
The user who created the credit memo record, providing an audit trail for the creation process. |
| CreationDate | Datetime | True |
The date and time when the credit memo was created, which helps in tracking the timeline of credit memo entries. |
| LastUpdatedBy | String | True |
The user who last updated the credit memo record, ensuring traceability of modifications. |
| LastUpdateDate | Datetime | True |
The date and time when the credit memo was last updated, marking the latest modification. |
| CreditMemoCurrency | String | False |
The currency code representing the currency in which the credit memo was issued, essential for multi-currency transactions. |
| BusinessUnit | String | False |
The business unit under which the credit memo is created. It defines the division within the organization that manages the transaction. |
| TransactionType | String | False |
The type of transaction assigned to the credit memo, such as Refund, Adjustment, or Reversal, which classifies the purpose of the credit memo. |
| TransactionSource | String | False |
The source system or process that generated the credit memo, helping to track and categorize the origin of the transaction. |
| AccountingDate | Date | False |
The accounting date for the credit memo, used for posting to financial ledgers and determining the relevant period for recognition. |
| LegalEntityIdentifier | String | False |
The identifier of the legal entity under which the credit memo is created, distinguishing the entity for legal and tax purposes. |
| CreditReason | String | False |
The reason provided for creating the credit memo, such as a pricing error, customer refund, or returned goods. |
| BillToCustomerNumber | String | False |
The account number of the bill-to customer, representing the customer who is being billed for the credit memo. |
| BillToSite | String | False |
The site number of the bill-to customer, specifying the physical location or branch where the billing occurs. |
| BillToCustomerName | String | False |
The name of the bill-to customer, used for addressing the credit memo to the correct entity. |
| EnteredAmount | Decimal | True |
The amount of the credit memo in the entered currency, reflecting the financial value being credited. |
| DocumentNumber | Long | False |
The document sequence number assigned to the credit memo, serving as a unique reference for document tracking and filing. |
| CrossReference | String | False |
A reference field from the transaction source used to track the original transaction or related documents for auditing purposes. |
| CustomerReference | String | False |
An additional reference document or code used by the customer to provide further context or details regarding the credit memo. |
| CustomerReferenceDate | Date | False |
The date when the customer requested the credit memo, used to establish the timeline for customer interactions. |
| BillingDate | Date | False |
The balance-forward bill date, relevant if the credit memo applies to an ongoing billing cycle. |
| PurchaseOrder | String | False |
The purchase order number linked to the credit memo, allowing for reconciliation between purchase and payment records. |
| SpecialInstructions | String | False |
Any special instructions accompanying the credit memo, providing additional guidance for processing or customer service. |
| CreditMemoComments | String | False |
The user-provided comments detailing important notes about the credit memo, useful for internal reference or customer communication. |
| DefaultTaxationCountry | String | False |
The country used for tax purposes related to the credit memo, determining the applicable tax jurisdiction. |
| FreightShipDate | Date | False |
The date when the items associated with the credit memo were shipped, used for freight and shipping reconciliations. |
| Carrier | String | False |
The shipping carrier responsible for transporting goods related to the credit memo. |
| FreightShippingReference | String | False |
The waybill reference number for the freight shipment, used to track the movement of goods. |
| FreightFOB | String | False |
The point of transfer for ownership of goods, indicating where the risk and responsibility shift from seller to buyer. |
| ConversionRateType | String | False |
Defines the method of currency conversion used for the credit memo, such as Spot, Corporate, User, or Fixed, for multi-currency transactions. |
| ConversionRate | Decimal | False |
The currency conversion rate applied to the credit memo transaction, converting it to the ledger currency. |
| ConversionRateDate | Date | False |
The date used to determine the conversion rate for the credit memo transaction, ensuring accurate exchange rate usage. |
| FirstPartyRegistrationNumber | String | False |
The tax registration number of the company issuing the credit memo, used for tax reporting and compliance. |
| ThirdPartyRegistrationNumber | String | False |
The tax registration number of the customer receiving the credit memo, necessary for tax reporting and compliance. |
| ShipToCustomerName | String | False |
The name of the customer receiving the goods or services billed in the credit memo. |
| ShipToCustomerNumber | String | False |
The account number of the customer receiving the goods or services in the credit memo. |
| ShipToCustomerSite | String | False |
The site number where the goods or services are shipped to the customer. |
| FreightCreditAmount | String | False |
The amount of freight credited by the credit memo, typically related to shipping adjustments or refunds. |
| PrimarySalesperson | String | False |
The number identifying the primary salesperson associated with the credit memo transaction. |
| Intercompany | String | False |
Indicates whether the credit memo is part of an intercompany transaction, involving different entities within the same organization. |
| TransactionBalanceDue | Decimal | True |
The outstanding balance on the credit memo that needs to be paid by the customer. |
| DeliveryMethod | String | True |
The method used to deliver the credit memo, such as E-Mail, Paper, or XML, for customer communication. |
| PrintStatus | String | True |
The status indicating whether the credit memo has been printed, for tracking physical document generation. |
| PrintDate | Date | True |
The date when the credit memo was printed, helping to confirm document dispatch timelines. |
| GenerateBill | String | False |
Indicates whether a bill should be generated for the credit memo, marking it for further processing in the billing system. |
| DocumentFiscalClassifcation | String | True |
The tax classification of the credit memo, based on regulatory requirements for special documentation accompanying the transaction. |
| PayingCustomerName | String | False |
The name of the customer who is responsible for paying for the goods or services covered by the credit memo. |
| PayingCustomerSite | String | False |
The site number of the customer making the payment for the credit memo. |
| PayingCustomerAccount | String | False |
The account number of the paying customer, who is responsible for paying the credit memo amount. |
| BillToContact | String | False |
The contact details for the bill-to customer, used for correspondence regarding the credit memo. |
| ShipToContact | String | False |
The contact details for the ship-to customer, used for correspondence regarding shipping and delivery. |
| SoldToPartyNumber | String | False |
The unique number identifying the sold-to customer on the credit memo, used for internal tracking. |
| PurchaseOrderDate | Date | False |
The date the associated purchase order was created, serving as a reference for the original transaction. |
| CreditMemoStatus | String | False |
The current status of the credit memo, such as Complete, Incomplete, or Frozen, indicating its processing stage. |
| InternalNotes | String | False |
Internal user-defined notes related to the credit memo, typically for internal use or clarification. |
| PurchaseOrderRevision | String | False |
The revision number associated with the purchase order, indicating any changes or updates to the original order. |
| StructuredPaymentReference | String | False |
An industry-standard reference used for linking credit memo transactions to payments and customer accounts. |
| AllowCompletion | String | False |
Indicates whether the credit memo has been reviewed and is ready for completion. Valid value is 'Y' for allowed. |
| ControlCompletionReason | String | False |
The reason provided for determining whether a transaction is allowed to complete, helping track the status of the transaction. |
| RecipientEmail | String | False |
The email address of the customer or contact who receives notifications or printed versions of the credit memo. |
| receivablesCreditMemoTransactionDFF | String | False |
A field used exclusively for inserting new records. For updates or deletes, child table operations should be used. |
| notes | String | False |
Field used exclusively for inserting new records. For updates or deletes, child table operations should be used. |
| receivablesCreditMemoDistributions | String | False |
This field is for inserting new records only. Use child table operations for updates or deletes. |
| receivablesCreditMemoDFF | String | False |
This field is for insert-only operations. Use child table operations for updates or deletions. |
| receivablesCreditMemoGdf | String | False |
This field is for insert-only operations. For updates or deletes, refer to child table operations. |
| receivablesCreditMemoLines | String | False |
This column is for insert-only use. For updates and deletions, child table operations should be used. |
| BindAccountingDate | Date | True |
The date used for accounting purposes in credit memo transactions, ensuring the correct accounting period. |
| BindAllowCompletion | String | True |
Indicates whether the credit memo transaction can be completed. Typically marked as 'Y' for allowed. |
| BindBillToCustomer | String | True |
The identifier for the bill-to customer associated with the credit memo. |
| BindBillToCustomerNumber | String | True |
The account number of the bill-to customer for the credit memo. |
| BindBillToSite | String | True |
The site number for the bill-to customer related to the credit memo. |
| BindBusinessUnit | String | True |
The business unit associated with the credit memo, tracking which division is handling the transaction. |
| BindCreditMemoCurrency | String | True |
The currency used for the credit memo, important for multi-currency transactions. |
| BindCreditMemoStatus | String | True |
The current status of the credit memo, indicating its processing stage. |
| BindCrossReference | String | True |
A cross-reference number for tracking linked transactions or related documents. |
| BindDeliveryMethod | String | True |
The delivery method for the credit memo, such as E-Mail or Paper. |
| BindDocumentNumber | Long | True |
The document number assigned to the credit memo for tracking purposes. |
| BindIntercompany | String | True |
Indicates whether the credit memo is part of an intercompany transaction, typically marked as 'Y' for intercompany. |
| BindPrimarySalesperson | String | True |
The primary salesperson associated with the credit memo transaction. |
| BindPrintStatus | String | True |
Indicates whether the credit memo has been printed. |
| BindPurchaseOrder | String | True |
The purchase order number linked to the credit memo. |
| BindShipToCustomerName | String | True |
The name of the ship-to customer for the credit memo. |
| BindShipToSite | String | True |
The site number of the ship-to customer for the credit memo. |
| BindTransactionDate | Date | True |
The date when the credit memo transaction occurred. |
| BindTransactionNumber | String | True |
The transaction number for the credit memo. |
| BindTransactionSource | String | True |
The source system that generated the credit memo transaction. |
| BindTransactionType | String | True |
The type of the transaction, such as adjustment or refund, associated with the credit memo. |
| Finder | String | True |
A reference key or search term used to find the credit memo record in the system. |
Controls the creation, retrieval, and management of receivables invoices, streamlining billing and revenue tracking.
The Sync App uses the Oracle Fusion Cloud Financials API to process some of the filters having queryable=true in metadata. The Sync App processes other filters within the Sync App.
For example, the following query is processed server side:
SELECT * FROM [Cdata].[Financials].[ReceivablesInvoices] WHERE CustomerTransactionId = 10003
Create a ReceivablesInvoices.
INSERT INTO [Cdata].[Financials].[ReceivablesInvoices] (BillToCustomerNumber,FreightAmount) VALUES ('2112', 150.22)
If you want to add child views/tables along with the parent table, you can add the child in following ways:
Using TEMP table:
INSERT into ReceivablesInvoicesreceivablesInvoiceLinesreceivablesInvoiceLineTaxLines#TEMP(TaxAmount,TaxRegimeCode,TaxRateCode,CUReferenceNumber) values (680,'FUS_STCC_REGIME-UES','VAT20',1)
INSERT into ReceivablesInvoicesreceivablesInvoiceLinesreceivablesInvoiceLineTaxLines#TEMP(TaxAmount,TaxRegimeCode,TaxRateCode,CUReferenceNumber) values (741,'FUS_STCC_REGIME-UES','VAT20',2)
INSERT into ReceivablesInvoicesreceivablesInvoiceLines#TEMP(receivablesInvoiceLineTaxLines,LineNumber,Quantity,UnitSellingPrice,TaxClassificationCode,CUReferenceNumber) values ('ReceivablesInvoicesreceivablesInvoiceLinesreceivablesInvoiceLineTaxLines#TEMP',46,21,2,'VAT20',1)
INSERT into ReceivablesInvoicesreceivablesInvoiceLines#TEMP(receivablesInvoiceLineTaxLines,LineNumber,Quantity,UnitSellingPrice,TaxClassificationCode,CUReferenceNumber) values ('ReceivablesInvoicesreceivablesInvoiceLinesreceivablesInvoiceLineTaxLines#TEMP',47,25,27,'VAT20',2)
INSERT INTO [Cdata].[Financials].[ReceivablesInvoices] (BillToCustomerNumber,FreightAmount,receivablesInvoiceLines) VALUES ('2112', 150.22,'ReceivablesInvoicesreceivablesInvoiceLines#TEMP')
Note : you can use CUReferenceNumber to map the child views/tables to their parent. For example, receivablesInvoiceLines having CUReferenceNumber 1, will have the child aggregates having CUReferenceNumber 1.
Directly providing the aggregate:
INSERT INTO [Cdata].[Financials].[ReceivablesInvoices] (BillToCustomerNumber,FreightAmount,receivablesInvoiceLines) VALUES ('2112', 150.22,'[
{
"LineNumber": 3,
"Quantity": 45,
"UnitSellingPrice": 45,
"TaxClassificationCode":"VAT20"
}
]')
The Oracle Fusion Cloud Financials API uses CustomerTransactionUniqId instead of CustomerTransactionId as a path parameter in the URL to update the record.
If you want to update a record directly using the id (without any other filter), you can update the record in the following way:
Update [Cdata].[Financials].[ReceivablesInvoices] set Comments='abcd' where CustomerTransactionUniqId = 454545454;
Note: This does not require any extra GET request to retrieve the UniqId.
Alternatively, if you want to apply any other filter. Please use CustomerTransactionId instead of CustomerTransactionUniqId. You can update the record in the following way:
Update [Cdata].[Financials].[ReceivablesInvoices] set Comments='abcd' where CustomerTransactionId = 454545454 and comments='aaw';
Note : Update on aggregates are not allowed by API, use the child tables to add/update/delete aggregates.
The Oracle Fusion Cloud Financials API uses CustomerTransactionUniqId instead of CustomerTransactionId as a path parameter in the URL to delete the record.
If you want to delete a record directly using the id (without any other filter), you can delete the record in the following way:
Delete from [Cdata].[Financials].[ReceivablesInvoices] where CustomerTransactionUniqId = 454545454;
Note: This does not require any extra GET request to retrieve the UniqId.
Alternatively, if you want to apply any other filter. Please use CustomerTransactionId instead of CustomerTransactionUniqId. You can delete the record in the following way:
Delete from [Cdata].[Financials].[ReceivablesInvoices] where CustomerTransactionId = 454545454 and comments='aaw';
| Name | Type | ReadOnly | Description |
| CustomerTransactionId [KEY] | Long | False |
The unique identifier for the invoice within the Receivables module. This ID is used to reference the specific transaction for accounting and reporting purposes. |
| CustomerTransactionUniqId [KEY] | String | True |
A unique identifier assigned to the invoice that replaces CustomerTransactionId for insert, update, and delete operations. This field ensures consistency across transaction modifications. |
| DueDate | Date | False |
The date on which the invoice installment is due to be paid by the customer. This date is important for determining payment deadlines and overdue statuses. |
| ConversionDate | Date | False |
The date used for applying a specific conversion rate to convert the invoice currency to the ledger currency. This date may vary from the transaction date depending on the accounting requirements. |
| ConversionRate | Decimal | False |
The exchange rate applied to convert the invoice's currency to the ledger currency. This rate ensures that financial data is accurately represented in the organization's reporting currency. |
| InvoiceCurrencyCode | String | False |
The code representing the currency in which the invoice was originally issued. This field ensures that transactions are tracked and reported in the correct currency. |
| SpecialInstructions | String | False |
Any specific instructions or notes provided with the invoice, often used for internal purposes or to convey important details to the customer. |
| CrossReference | String | False |
A reference to the source document that generated this invoice. This could be a sales order or purchase order that links the invoice to the originating transaction. |
| DocumentNumber | Long | False |
A unique sequential number assigned to the invoice document. This is used for document identification, record-keeping, and integration with other systems. |
| TransactionNumber | String | False |
A unique identifier assigned to each invoice transaction. This number is used for tracking and reconciling payments and receipts related to the invoice. |
| TransactionDate | Date | False |
The date when the invoice was created. This date is crucial for accounting and reporting purposes, marking the start of the payment cycle. |
| TransactionType | String | False |
The type of transaction that this invoice represents (for example, sale, refund, adjustment). This field categorizes the invoice for proper handling and accounting. |
| TransactionSource | String | False |
The source of the transaction that led to the creation of this invoice. It can help identify whether the invoice was generated from a manual entry or an automated process. |
| BillToCustomerNumber | String | False |
The account number of the customer being billed. This is used for customer identification and managing accounts receivable. |
| BillToSite | String | False |
The unique identifier for the billing site of the customer. It helps in distinguishing different locations or divisions within a customer’s organization that receive billing. |
| Comments | String | False |
User-defined comments attached to the invoice for providing additional context or instructions that may be relevant for processing or customer communication. |
| InternalNotes | String | False |
Notes intended for internal use only, often to provide details for staff members regarding invoice adjustments, exceptions, or special handling instructions. |
| PaymentTerms | String | False |
The conditions under which payment is expected for this invoice, such as net 30, net 60, or due upon receipt. These terms define the time frame for the customer’s payment. |
| LegalEntityIdentifier | String | False |
A unique identifier for the legal entity under which the invoice is generated. This helps to distinguish between different legal entities within the organization for compliance and tax reporting. |
| ConversionRateType | String | False |
The categorization of conversion rates applied to the invoice, such as Spot, Corporate, User, or Fixed. This determines which exchange rate is used during the conversion process. |
| PurchaseOrder | String | False |
The purchase order number associated with this invoice. This links the invoice to the corresponding purchase order for the goods or services provided. |
| PurchaseOrderDate | Date | False |
The date when the purchase order was issued. This date helps track the timeline from order to invoicing, ensuring proper alignment of accounting periods. |
| PurchaseOrderRevision | String | False |
The revision number of the purchase order linked to the invoice. This is useful when changes are made to a purchase order after its initial creation. |
| FirstPartyRegistrationNumber | String | False |
The tax registration number of the deploying company. This is required for tax reporting and ensures the company’s compliance with tax regulations. |
| ThirdPartyRegistrationNumber | String | False |
The tax registration number of the bill-to customer. This number is important for tax purposes and to verify the customer’s tax status. |
| InvoicingRule | String | False |
The accounting rule applied to the invoice for revenue recognition, such as 'In Advance' or 'In Arrears'. This determines how and when revenue from the invoice is recognized. |
| ShipToCustomerName | String | False |
The name of the customer receiving the goods or services. This may differ from the bill-to customer and is used to accurately track shipments and deliveries. |
| ShipToCustomerNumber | String | False |
The unique registry identifier of the customer receiving the shipment. This identifier ensures proper tracking of the shipment within the customer’s account. |
| BillingDate | Date | False |
The date when the balance forward bill for the customer is generated. This is used for recurring billing scenarios where the invoice consolidates multiple charges over a period. |
| BillToPartyId | Long | True |
A unique identifier assigned to the bill-to customer. This is critical for associating the invoice with the correct customer account for payment processing. |
| BusinessUnit | String | False |
The business unit under which the invoice is created. It helps in categorizing transactions by the part of the organization responsible for the transaction. |
| InvoiceStatus | String | False |
Indicates the current status of the invoice, such as 'Complete', 'Incomplete', or 'Frozen'. This is used for tracking the progress of the invoice through the approval and payment processes. |
| AccountingDate | Date | False |
The date that is used for accounting purposes to recognize the revenue and expenses associated with the invoice. This may differ from the transaction date. |
| ShipToSite | String | False |
The unique identifier for the ship-to location of the customer. This helps in managing logistics and ensuring goods are shipped to the correct site. |
| PayingCustomerName | String | False |
The name of the customer responsible for paying the invoice. This may be different from the bill-to customer if payments are made by a third party. |
| PayingCustomerSite | String | False |
The identifier for the site responsible for making payments on the invoice. This is useful for tracking payments when there are multiple payment locations for a customer. |
| BillToCustomerName | String | False |
The name of the customer being billed for the goods or services. This is typically the entity responsible for paying the invoice. |
| FreightAmount | Decimal | False |
The amount charged for shipping and handling related to the invoice. This amount is added to the total invoice amount if applicable. |
| Carrier | String | False |
The name of the shipping carrier responsible for delivering the goods. This field helps track which logistics provider is used for shipment. |
| ShipDate | Date | False |
The date when the items listed on the invoice were shipped to the customer. This date is important for tracking delivery timelines and calculating due dates. |
| ShippingReference | String | False |
The reference number or waybill provided by the carrier for the shipment. This helps in tracking the shipment status and handling customer inquiries. |
| BillToContact | String | False |
The contact details of the bill-to customer, such as the name, phone number, and email address. This is useful for communication regarding the invoice. |
| ShipToContact | String | False |
The contact details of the ship-to customer, which may differ from the bill-to contact. This ensures proper communication about shipments. |
| PrintOption | String | False |
The option indicating whether the invoice should be printed. This field may include options like 'Print', 'Do Not Print', or 'Print on Demand'. |
| CreatedBy | String | True |
The user who initially created the invoice record in the system. This information is important for auditing and tracking user actions. |
| CreationDate | Datetime | True |
The date and time when the invoice record was created in the system. This is useful for tracking the creation timeline of invoices. |
| LastUpdatedBy | String | True |
The user who last updated the invoice record. This is valuable for tracking changes and ensuring proper management of invoice data. |
| LastUpdateDate | Datetime | True |
The date and time when the invoice record was last updated. It helps to monitor any modifications to the invoice after its creation. |
| PayingCustomerAccount | String | False |
The account number for the customer responsible for making payments on the invoice. |
| SoldToPartyNumber | String | False |
A unique identifier for the sold-to customer, typically used for customer management and invoicing purposes. |
| RemitToAddress | String | False |
The address where payments for the invoice should be sent. This ensures that payments are directed to the correct location. |
| DefaultTaxationCountry | String | False |
The country in which the invoice transaction takes place for tax purposes. This country determines the applicable tax rates and regulations. |
| EnteredAmount | Decimal | True |
The original amount of the invoice before any adjustments, taxes, or discounts are applied. |
| InvoiceBalanceAmount | Decimal | True |
The remaining balance amount due on the invoice after partial payments or adjustments. |
| Prepayment | String | False |
Indicates whether the invoice requires prepayment for goods and services. This can help manage upfront payment requirements before order fulfillment. |
| Intercompany | String | False |
Identifies whether the invoice is part of an intercompany transaction, which typically involves transactions between different legal entities within the same organization. |
| DocumentFiscalClassification | String | False |
The classification assigned to the invoice for tax purposes, required by tax authorities for documentation compliance. |
| BankAccountNumber | String | False |
The bank account number associated with the customer for payment purposes. This is useful for processing electronic payments. |
| CreditCardAuthorizationRequestIdentifier | String | False |
The unique authorization request identifier for credit card payments, generated by the tokenization service to authorize the payment. |
| CreditCardExpirationDate | String | False |
The expiration date of the credit card used for payment. This ensures the validity of the credit card when processing payments. |
| CreditCardIssuerCode | String | False |
The code representing the credit card issuer, such as Visa, MasterCard, or American Express. |
| CreditCardTokenNumber | String | False |
A token number generated by the tokenization service corresponding to the credit card used for payment. This enhances security and prevents fraud. |
| CreditCardVoiceAuthorizationCode | String | False |
The voice authorization code provided by the tokenization service when a credit card payment is manually authorized via phone. |
| CreditCardErrorCode | String | False |
An error code that indicates why a credit card authorization failed, helping to diagnose issues during payment processing. |
| CreditCardErrorText | String | False |
The error message associated with a failed credit card authorization, providing additional information about the failure. |
| CardHolderLastName | String | False |
The last name of the credit card holder, used for verification purposes when processing payments. |
| CardHolderFirstName | String | False |
The first name of the credit card holder, used for verification purposes when processing payments. |
| ReceiptMethod | String | False |
The method by which the payment for the invoice is received, such as Credit Card, Bank Transfer, or Cash. |
| SalesPersonNumber | String | False |
The identifier of the primary salesperson associated with the invoice. This is used for commission calculations and sales tracking. |
| StructuredPaymentReference | String | False |
A unique reference used to identify a payment transaction across systems, ensuring proper reconciliation and payment matching. |
| InvoicePrinted | String | False |
Indicates whether the invoice has been printed at least once, used for managing print statuses in billing operations. |
| LastPrintDate | Date | False |
The date when the invoice was last printed. This helps to track the history of printed invoices. |
| OriginalPrintDate | Date | False |
The date when the invoice was initially printed. This serves as the original print date for historical reference. |
| DeliveryMethod | String | False |
The method used to deliver printed invoices, such as email, paper, or portal upload. This determines how invoices are distributed to customers. |
| String | False |
The email address of the bill-to customer who will receive the invoice if delivered electronically. | |
| AllowCompletion | String | False |
Indicates whether the invoice can be completed based on its review status. A value of 'Y' indicates that the transaction can be completed. |
| ControlCompletionReason | String | False |
The reason for completing or finalizing the transaction, indicating why the invoice is ready for closure. |
| receivablesInvoiceDFF | String | False |
Used for inserting data into the invoice. For updates and deletions, the corresponding child table operations should be used. |
| receivablesInvoiceInstallments | String | False |
Used for inserting invoice installment details. Updates and deletions should be handled through child table operations. |
| receivablesInvoiceDistributions | String | False |
Used for inserting invoice distribution details. Updates and deletions are handled through child table operations. |
| notes | String | False |
A field used for inserting notes related to the invoice. For updates and deletions, child table operations should be used. |
| receivablesInvoiceGdf | String | False |
Used for inserting generalized data fields (GDF) related to the invoice. Updates and deletions are handled through child table operations. |
| receivablesInvoiceLines | String | False |
Used for inserting invoice line item details. Updates and deletions are handled through child table operations. |
| receivablesInvoiceTransactionDFF | String | False |
Used for inserting transaction-specific DFF (Descriptive Flexfields) data. Updates and deletions are handled through child table operations. |
| Finder | String | True |
A field used for searching specific invoice records within the database. |
| FirstPartyTaxRegistration | String | True |
The tax registration number of the company issuing the invoice. |
| ThirdPartyTaxRegistration | String | True |
The tax registration number of the customer receiving the invoice. |
Tracks standard incoming payments (for example, checks, wire transfers), mapping them to customer accounts for settlement.
The Sync App uses the Oracle Fusion Cloud Financials API to process some of the filters having queryable=true in metadata. The Sync App processes other filters within the Sync App.
For example, the following query is processed server side:
SELECT * FROM [Cdata].[Financials].[StandardReceipts] WHERE StandardReceiptId = 10003
Create an StandardReceipt.
INSERT INTO [Cdata].[Financials].[StandardReceipts] (RemittanceBankAccountNumber,ReceiptMethod,Amount,Currency,ReceiptNumber,BusinessUnit) VALUES ('XXXXXXX8642','Check (Directly/No Remit)',2212.75,'USD','140811-11','ABCD')
If you want to add child views/tables along with the parent table, you can add the child in following ways:
Using TEMP table:
INSERT into StandardReceiptsremittanceReferences#TEMP(ReceiptMatchBy,ReferenceNumber,ReferenceAmount) values ('Purchase Order','SK_PO_1012',25.35);
INSERT INTO [Cdata].[Financials].[StandardReceipts] (RemittanceBankAccountNumber,ReceiptMethod,Amount,Currency,ReceiptNumber,BusinessUnit,remittanceReferences) VALUES ('XXXXXXX8642','Check (Directly/No Remit)',2212.75,'USD','140811-11','ABCD','StandardReceiptsremittanceReferences#TEMP')
Directly providing the aggregate:
INSERT INTO [Cdata].[Financials].[StandardReceipts] (RemittanceBankAccountNumber,ReceiptMethod,Amount,Currency,ReceiptNumber,BusinessUnit,remittanceReferences) VALUES ('XXXXXXX8642','Check (Directly/No Remit)',2212.75,'USD','140811-11','ABCD','[{
"ReceiptMatchBy":"Purchase Order",
"ReferenceNumber":"SK_PO_1012",
"ReferenceAmount":8774.45
}]')
The Oracle Fusion Cloud Financials API uses StandardReceiptUniqId instead of StandardReceiptId as a path parameter in the URL to update the record.
If you want to update a record directly using the id (without any other filter), you can update the record in the following way:
Update [Cdata].[Financials].[StandardReceipts] set Comments='abcd' where StandardReceiptUniqId=454545454;
Note: This does not require any extra GET request to retrieve the UniqId.
Alternatively, if you want to apply any other filter. Please use StandardReceiptId instead of StandardReceiptUniqId. You can update the record in the following way:
Update [Cdata].[Financials].[StandardReceipts] set Comments='abcd' where StandardReceiptId=454545454 and CustomerAccountNumber="1004";
Note : Update on aggregates are not allowed by API, use the child tables to add/update/delete aggregates.
The Oracle Fusion Cloud Financials API uses StandardReceiptUniqId instead of StandardReceiptId as a path parameter in the URL to delete the record.
If you want to delete a record directly using the id (without any other filter), you can delete the record in the following way:
Delete from [Cdata].[Financials].[StandardReceipts] where StandardReceiptUniqId=454545454;
Note: This does not require any extra GET request to retrieve the UniqId.
Alternatively, if you want to apply any other filter. Please use StandardReceiptId instead of StandardReceiptUniqId. You can delete the record in the following way:
Delete from [Cdata].[Financials].[StandardReceipts] where StandardReceiptId=454545454 and CustomerAccountNumber="1004";
| Name | Type | ReadOnly | Description |
| StandardReceiptId [KEY] | Long | False |
The unique identifier of the standard receipt, used to reference and manage the receipt in the system. |
| StandardReceiptUniqId [KEY] | String | True |
The unique identifier for the standard receipt. This value should be used in insert, update, and delete operations, replacing StandardReceiptId where applicable. |
| ReceiptNumber | String | False |
The unique number assigned to the standard receipt, used for tracking and managing the receipt in the financial system. |
| BusinessUnit | String | False |
A unit within the organization that performs specific business functions. Business units are used to classify receipts for reporting and management purposes. |
| ReceiptMethod | String | False |
The method of payment or receipt used, such as cash, check, or bank transfer. |
| ReceiptDate | Date | False |
The date when the standard receipt was created or processed. |
| DocumentNumber | Long | False |
The document sequence number associated with the standard receipt, used for document management and identification. |
| Amount | Decimal | False |
The total amount of the standard receipt in the receipt's currency. |
| Currency | String | False |
The currency used for the standard receipt, reflecting the type of money in which the receipt is issued. |
| ConversionRateType | String | False |
The type of conversion rate used for converting the receipt currency into the ledger's functional currency. |
| ConversionDate | Date | False |
The date on which the conversion rate was applied to the receipt, typically aligned with the transaction date. |
| ConversionRate | Decimal | False |
The specific conversion rate between the receipt's currency and the ledger's functional currency, used for financial reporting. |
| State | String | True |
The state of the current payment entry progress, indicating the status of funds applied to the receipt. Valid states include APPLIED, UNAPPLIED, UNIDENTIFIED, INSUFFICIENT FUNDS, REVERSE PAYMENT, and STOP PAYMENT. |
| Status | String | True |
The current status of the entered payment, indicating the processing stage. Valid statuses include CONFIRMED, CLEARED, APPROVED, and REMITTED. |
| RemittanceBankName | String | True |
The name of the bank used for remitting funds related to the standard receipt. |
| RemittanceBankBranch | String | True |
The name of the specific bank branch handling the remittance for the standard receipt. |
| RemittanceBankAccountNumber | String | False |
The account number at the remittance bank where the funds for the standard receipt are deposited. |
| RemittanceBankDepositDate | Date | False |
The date when the funds for the standard receipt were deposited by the remittance bank. |
| RemittanceBankAllowOverride | String | False |
An option that allows for overriding the remittance account used during the receipt process. |
| CustomerName | String | False |
The name of the customer associated with the standard receipt, typically reflecting the payer or the entity receiving the receipt. |
| TaxpayerIdentificationNumber | String | True |
The Tax Indentification Number (TIN) of the customer associated with the standard receipt, used for tax reporting and identification. |
| CustomerSite | String | False |
The customer site associated with the receipt, indicating the physical or legal address associated with the transaction. |
| CustomerAccountNumber | String | False |
The account number of the customer within the receivables system, used for account tracking and reconciliation. |
| CustomerBank | String | True |
The name of the bank where the customer holds their account, used for financial transactions related to the receipt. |
| CustomerBankBranch | String | True |
The specific branch of the bank where the customer holds their account, used for detailed banking operations. |
| CustomerBankAccountNumber | String | False |
The bank account number held by the customer, which is linked to the standard receipt for payment processing. |
| UnappliedAmount | Decimal | True |
The portion of the receipt that has not yet been applied to any transactions or balances in the system. |
| AccountedAmount | Decimal | True |
The portion of the receipt that has been accounted for in the ledger currency, used for financial reporting. |
| AccountingDate | Date | False |
The date when the standard receipt is accounted in the financial records. |
| MaturityDate | Date | False |
The date when the standard receipt reaches maturity and payment is expected or due. |
| PostmarkDate | Date | False |
The date when the receipt was postmarked, typically used for cash receipt processing or deposit timing. |
| ReceiptAtRisk | String | True |
Indicates whether the receipt is at risk with the remittance bank, typically referring to issues like a potential reversal or a stop payment. |
| ReceivablesSpecialist | String | True |
The specialist within the receivables department responsible for managing and overseeing the standard receipt. |
| Comments | String | False |
User-defined comments providing additional context or information about the receipt. |
| CreditCardTokenNumber | String | False |
The token number generated by a tokenization service provider to securely represent a credit card number used for the standard receipt. |
| CreditCardAuthorizationRequestIdentifier | Long | False |
The identifier associated with the credit card authorization request used to verify the transaction. |
| CardHolderFirstName | String | False |
The first name of the credit card holder who is associated with the standard receipt. |
| CardHolderLastName | String | False |
The last name of the credit card holder associated with the standard receipt. |
| CreditCardIssuerCode | String | False |
The code representing the credit card issuer, such as Visa, MasterCard, or American Express. |
| CreditCardExpirationDate | String | False |
The expiration date of the credit card used for the payment of the standard receipt. |
| VoiceAuthorizationCode | String | False |
The voice authorization code provided by the tokenization service for phone-based credit card authorization. |
| ReversalCategory | String | True |
The category of the reversal, if the standard receipt is reversed, indicating the reason for the reversal. |
| ReversalReason | String | True |
The reason for reversing the standard receipt, used for tracking and reporting purposes. |
| ReversalDate | Date | True |
The date when the standard receipt was reversed, if applicable. |
| ReversalComments | String | True |
Comments associated with the reversal of the standard receipt, used to document the reason for reversal. |
| ReceiptBatchName | String | True |
The name of the batch to which the standard receipt belongs, typically used for organizing and processing multiple receipts together. |
| ReceiptBatchDate | Date | True |
The date when the receipt batch was processed, used for tracking the timing of grouped receipt entries. |
| StructuredPaymentReference | String | False |
A standardized reference code used to identify the transaction and its payments between the customer and the bank. |
| CreatedBy | String | True |
The user who created the standard receipt record, used for auditing and tracking purposes. |
| CreationDate | Datetime | True |
The date and time when the standard receipt record was created in the system. |
| LastUpdateDate | Datetime | True |
The date and time when the standard receipt record was last updated in the system. |
| LastUpdatedBy | String | True |
The user who last updated the standard receipt record, used for auditing and tracking purposes. |
| remittanceReferences | String | False |
This field is used for insert operations and should not be used for update or delete actions directly. Refer to the child table for these operations. |
| standardReceiptGdf | String | False |
This field is used for insert operations only. For updates and deletions, refer to the child table's operations. |
| standardReceiptDFF | String | False |
This field is used for insert operations only. For updates and deletions, refer to the child table's operations. |
| Finder | String | True |
A generic identifier used for finding the standard receipt in queries or searches. |
Controls creation and updates of tax registrations, linking registered entities to corresponding tax codes and authorities.
The Sync App uses the Oracle Fusion Cloud Financials API to process some of the filters having queryable=true in metadata. The Sync App processes other filters within the Sync App.
For example, the following query is processed server side:
SELECT * FROM [Cdata].[Financials].[TaxRegistrations] WHERE RegistrationId = 10003
Create a TaxRegistrations.
INSERT INTO [Cdata].[Financials].[TaxRegistrations] (PartyTypeCode,PartySiteNumber,TaxRegimeCode) VALUES ('THIRD_PARTY_SITE', '1151', 'US SALES AND USE TAX')
The Oracle Fusion Cloud Financials API uses RegistrationUniqId instead of RegistrationId as a path parameter in the URL to update the record.
If you want to update a record directly using the id (without any other filter), you can update the record in the following way:
Update [Cdata].[Financials].[TaxRegistrations] set RegistrationNumber='67794246-AL' where RegistrationUniqId = 454545454;
Note: This does not require any extra GET request to retrieve the UniqId.
Alternatively, if you want to apply any other filter. Please use RegistrationId instead of RegistrationUniqId. You can update the record in the following way:
Update [Cdata].[Financials].[TaxRegistrations] set RegistrationNumber='67794246-AL' where RegistrationId = 454545454 and CustomerName='Test';
Note : Update on aggregates are not allowed by API, use the child tables to add/update/delete aggregates.
| Name | Type | ReadOnly | Description |
| PartyTypeCode | String | False |
The code that defines the party type (for example, 'Supplier',' Customer') for the tax profile. |
| PartyName | String | False |
The name of the party (company or individual) associated with the tax profile. |
| PartyNumber | String | False |
The unique identifier for the party to which the tax registration belongs. |
| PartySiteNumber | String | False |
The site number associated with the party's tax registration. |
| TaxRegimeCode | String | False |
The code representing the tax regime under which the registration is issued, such as VAT. |
| Tax | String | False |
The tax code applicable to the tax registration for the party. |
| TaxJurisdictionCode | String | False |
The code indicating the tax jurisdiction (location) where the tax registration is valid. |
| TaxPointBasis | String | False |
Specifies the basis of the tax point (for example, delivery-based or invoice-based) for tax reporting. |
| RegistrationTypeCode | String | False |
The type of tax registration, such as VAT or Sales Tax, that is associated with the party. |
| RegistrationStatusCode | String | False |
The status of the tax registration, indicating whether it is active, pending, etc. |
| RepresentativePartyTaxName | String | False |
The name of the party representing the taxpayer in the registration. |
| RegistrationReasonCode | String | False |
The reason for obtaining the tax registration, such as starting business operations. |
| EffectiveFrom | Date | False |
The date from which the tax registration is valid. |
| EffectiveTo | Date | False |
The date until which the tax registration is valid. |
| LegalRegistrationAddress | String | False |
The registered address associated with the tax registration. |
| ValidationType | String | False |
The type of validation used for ensuring the correctness of the tax registration. |
| ValidationLevel | String | False |
The level of validation applied to prevent duplicate tax registration numbers (for example, ERROR, WARNING). |
| ValidationRule | String | False |
The code for the specific validation rule applied to tax registration numbers. |
| RegistrationNumber | String | False |
The unique tax registration number assigned by the tax authority. |
| RegistrationSourceCode | String | False |
The source code indicating where the tax registration originates from. |
| IssuingTaxAuthority | String | False |
The tax authority responsible for issuing the tax registration. |
| DefaultRegistrationFlag | Bool | False |
Indicates whether this is the default registration for the party. The default is FALSE. |
| RoundingRuleCode | String | False |
The rounding rule applied to tax calculations for this registration. Defines how rounding is performed (for example, round up, round down). |
| InclusiveTaxFlag | Bool | False |
Indicates whether the tax registration includes tax in its calculations (default is FALSE). |
| BankAccountNumber | String | False |
The bank account number associated with the tax registration. |
| TaxClassificationCode | String | False |
The tax classification code relevant to this tax registration. |
| UniquenessValidationLevel | String | False |
The validation level applied to ensure no duplicate tax registration numbers are used. |
| Country | String | True |
The country where the tax registration is applicable. |
| PartyCountryCode | String | True |
The country code used to identify the tax registration jurisdiction. |
| BankBranchId | Long | False |
The unique identifier for the bank branch associated with the tax registration. |
| BankId | Long | False |
The unique identifier for the bank where the party's tax-related transactions are managed. |
| CollTaxAuthorityId | Long | False |
The unique identifier for the collecting tax authority associated with the registration. |
| LegalLocationId | Long | False |
The unique identifier for the legal location tied to the tax registration. |
| PartyTaxProfileId | Long | False |
The unique identifier for the tax profile associated with the party. |
| RoundingLevelCode | String | False |
Defines the level of rounding applied to tax amounts during calculations, such as HEADER or LINE. |
| TaxAuthorityId | Long | False |
The unique identifier of the tax authority managing the tax registration. |
| RegistrationId [KEY] | Long | False |
The system-generated identifier for the tax registration record. |
| RegistrationUniqId [KEY] | String | True |
A unique identifier to be used for insert, update, and delete operations, instead of RegistrationId. |
| PartyTaxAllowOffsetTaxFlag | Bool | False |
Indicates whether the party tax profile allows offset tax calculations. Default is FALSE. |
| PartyTaxRoundingLevelCode | String | False |
Specifies the rounding level for taxes in the party's tax profile. |
| PartyTaxInclusiveTaxFlag | Bool | False |
Indicates whether the party's tax profile supports inclusive tax calculations. Default is FALSE. |
| PartyTaxClassificationCode | String | False |
The classification code for tax purposes associated with the party's tax profile. |
| PartyTaxRoundingRuleCode | String | False |
The rounding rule code associated with the party's tax profile. |
| PartyTaxProcessForApplicabilityFlag | Bool | False |
Indicates whether the party tax profile is applied during the tax determination process. |
| CountryCode | String | False |
The code used to validate the tax registration number for the party. |
| Finder | String | True |
A helper field for searching or filtering tax registration records. |
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| AccountCombinationsLOV | Provides a reference of valid General Ledger account combinations, ensuring accurate segment values for financial reporting and ledger analysis. |
| AccountCombinationsShorthandAliasesLOV | Maintains shorthand alias definitions for quick entry of account combinations, streamlining data input in accounting processes. |
| AccountingCalendarsLOV | Displays available accounting or commitment calendars, detailing periods and dates for budgeting and transaction alignment. |
| AccountingPeriodsLOV | Lists period details (for example, open, closed) within a specified accounting calendar, aiding period-based reporting and reconciliation. |
| AccountingPeriodStatusLOV | Tracks the current status of each accounting period (for example, open, closed) within a calendar, preventing unauthorized postings. |
| BankAccountUserRules | Enables configuration of country-specific validations and label changes on bank account fields for streamlined account setup. |
| BudgetaryControlResults | Shows results of budgetary control checks, helping users identify whether labor schedules or requisitions exceed set budgets. |
| BudgetaryControlResultsBudgetImpacts | Provides budget impact data associated with labor schedules, including any reductions in available funds due to transactions. |
| BudgetaryControlResultsBudgetTransactions | Supports internal budget adjustments by displaying validation info on transactions affecting Enterprise Performance Management budgets. |
| CashBankBranchesLOV | Enables queries on bank branch details, supporting cash management and setup of payment or receipt methods. |
| CashBanksLOV | Facilitates lookups for bank information, ensuring valid bank references for payment or receipt processing. |
| ChartOfAccountsLOV | Outlines details of a chart of accounts structure, including segments and hierarchies for robust financial tracking. |
| CurrencyConversionTypesLOV | Shows available currency conversion types (for example, Corporate, Spot, User), automatically assigning exchange rates to transactions. |
| CurrencyRates | Retrieves currency exchange rates for specified dates and currency pairs, informing multi-currency postings and reports. |
| CustomerAccountSitesLOV | Displays customer account site details, linking customers to specific billing or shipping addresses for transaction processing. |
| DebitAuthorizations | Manages debit authorizations, including creation or updates, allowing users to handle automated debit agreements. |
| DebitAuthorizationsdebitAuthorizationVersions | Tracks version history of debit authorizations, ensuring an audit trail of any modifications made to authorization terms. |
| DisbursementPaymentMethodsLOV | Queries valid disbursement payment methods (for example, check, EFT), ensuring payment configuration aligns with organizational rules. |
| ErpBusinessEvents | Stores or updates status for business events that trigger processes like approvals or notifications in ERP workflows. |
| Erpintegrations | Automates bulk data import/export with configurable callbacks and error notifications, streamlining integration tasks. |
| ExpenseAccommodationsPolicies | Defines accommodations-related expense rules, specifying reimbursement rates, limits, or eligibility for lodging costs. |
| ExpenseAccommodationsPoliciesexpenseAccommodationsPolicyLines | Stores line-level policy details for accommodations expense rules, including thresholds and specific lodging policy items. |
| ExpenseAirfarePolicies | Defines airfare-related expense rules and eligibility criteria, specifying permitted costs and class restrictions for business travel. |
| ExpenseAirfarePoliciesexpenseAirfarePolicyLines | Provides detailed line items for airfare policy rules, including maximum limits, exceptions, and additional fare conditions. |
| ExpenseCashAdvances | Tracks employee cash advances for travel or business-related expenses, capturing key data such as status, requested amounts, and repayment details. |
| ExpenseCashAdvancesAttachments | Enables document uploads and management (for example, receipts or justifications) for recorded cash advances. |
| ExpenseCashAdvancesCashAdvanceDff | Offers descriptive flexfields for adding custom attributes to cash advance records, supporting unique organizational needs. |
| ExpenseConversionRateOptions | Establishes expense-specific conversion rate policies for multiple currencies, ensuring correct reimbursement calculations. |
| ExpenseConversionRateOptionsconversionRateTolerances | Defines allowable variances in currency conversion rates for certain currencies or business units, supporting exceptions in expense reimbursements. |
| ExpenseCreditCardTransactions | Captures corporate card transaction data (dates, amounts, merchant info) for automated expense reconciliation and policy checks. |
| ExpenseDelegations | Allows authorized delegation of expense-related tasks between employees, detailing start/end dates and permissible actions. |
| ExpenseDffContexts | Houses descriptive flexfield contexts for expenses and reports, enabling tailored data collection for various business use cases. |
| ExpenseDffSegments | Details individual descriptive flexfield segments linked to expenses, supporting extended data capture and reporting. |
| ExpenseDistributions | Shows how an expense item’s cost is allocated across multiple accounts or cost centers, ensuring financial accuracy. |
| ExpenseDistributionsPJCDFF | Captures project-specific descriptive flexfields for expense distributions, integrating project details with expense tracking. |
| ExpenseEntertainmentPolicies | Establishes company rules for entertainment-related spending, including meal, event, or other hospitality expenses. |
| ExpenseEntertainmentPoliciesexpenseEntertainmentPolicyLines | Specifies line-level detail within entertainment policies, defining allowable amounts, categories, and exclusions. |
| ExpenseLocations | Manages standard expense location data (cities, countries, regions) used to categorize and validate expense submissions. |
| ExpenseMealsPolicies | Defines meal expense guidelines, limits, and other policy details for business trips or events. |
| ExpenseMealsPoliciesexpenseMealsPolicyLines | Breaks down meal policy rules into line items, detailing per-diem amounts, eligibility, and exceptions. |
| ExpenseMileagePolicies | Sets reimbursement rules for mileage claims, including distance rates and allowable vehicle types. |
| ExpenseMileagePoliciesexpenseMileagePolicyLines | Contains line-level specifics for mileage policy, supporting different mileage rates or exceptions based on region or vehicle. |
| ExpenseMiscPolicies | Covers miscellaneous expense categories that don’t fall under standard policies, detailing eligibility and maximum thresholds. |
| ExpenseMiscPoliciesexpenseMiscPolicyLines | Describes specific line items under miscellaneous policies, such as office supplies or other uncommon expense types. |
| ExpenseOrganizationSettings | Holds setup options at the business unit level, configuring how expenses are processed, approved, or reimbursed. |
| ExpensePerDiemCalculations | Calculates trip-specific per diem amounts for employee expenses, factoring in policy rules and travel duration. |
| ExpensePerDiemPolicies | Stores the overarching per diem guidelines, including allowable rates and daily caps for travel reimbursements. |
| ExpensePerDiemPoliciesexpensePerDiemPolLines | Provides a breakdown of per diem policy lines, specifying coverage, meal breakdowns, or location-based rates. |
| ExpensePerDiemPoliciesexpensePerDiemPolValues | Tracks percentage-based per diem policy values, enabling scaled calculations for partial days or specific travel scenarios. |
| ExpensePersons | Contains person-centric details (business unit, currency preferences) tied to expense transactions and approvals. |
| ExpensePreferences | Stores an individual’s default expense settings, such as preferred currency or default cost center, streamlining expense entry. |
| ExpensePreferredTypes | Lists commonly used expense types for chatbot or quick expense entry, improving user efficiency and consistency. |
| ExpenseProfileAttributes | Stores extended user-specific expense profile data (for example, employee roles, entitlements), enhancing customization for expense submissions. |
| ExpenseReportsAttachments | Manages attachments (for example, receipts, authorizations) linked at the expense report level, aiding record-keeping and compliance. |
| ExpenseReportsExpense | Maintains line-level expense items within a report, capturing essential details like expense type, amount, and project allocations. |
| ExpenseReportsExpenseAttachments | Enables users to upload documents for individual expense items, reinforcing traceability and validation. |
| ExpenseReportsExpenseduplicateExpenses | Highlights potential duplicate expenses within a report, flagging lines that share similar attributes for review. |
| ExpenseReportsExpenseExpenseAttendee | Lists attendees or participants for specific expense items, ensuring accurate reimbursements for group-related expenses. |
| ExpenseReportsExpenseExpenseDff | Provides descriptive flexfields for additional, organization-specific data on individual expense items. |
| ExpenseReportsExpenseExpenseDistribution | Shows how costs from a single expense line are allocated across multiple accounts, departments, or cost centers. |
| ExpenseReportsExpenseExpenseDistributionPJCDFF | Offers project-centric descriptive flexfields for expense item distributions, integrating project cost details. |
| ExpenseReportsExpenseexpenseErrors | Captures validation errors related to an expense item, allowing users to address issues before final submission. |
| ExpenseReportsExpenseExpenseItemization | Breaks down a single expense into multiple sub-items (for example, hotel bill itemization), improving transparency and accuracy. |
| ExpenseReportsExpensematchedExpenses | Identifies expense lines matched with existing records (such as credit card transactions), reducing redundant entries. |
| ExpenseReportsexpenseNotes | Stores remarks or instructions from approvers or auditors regarding the entire expense report, aiding clarity and resolution. |
| ExpenseReportsExpensePayment | Details payment-related information (dates, amounts) for reimbursed expense reports, ensuring visibility into disbursement status. |
| ExpenseReportsExpenseReportDff | Includes custom flexfield data at the expense report header level, aligning the report with unique organizational processes. |
| ExpenseReportsprocessingDetails | Logs status changes and processing steps (for example, approvals, rejections) for an expense report, providing an audit trail. |
| ExpensesAttachments | Handles attachments directly tied to individual expenses, enhancing record completeness and verification. |
| ExpensesduplicateExpenses | Alerts users to expenses that may have been entered multiple times, aiding in cost control and policy enforcement. |
| ExpenseSetupOptions | Consolidates company-wide expense configurations and preferences, defining processes like workflow routing and policy thresholds. |
| ExpensesExpenseAttendee | Tracks the individuals associated with an expense, capturing data such as names and roles for cost-sharing analysis. |
| ExpensesExpenseDff | Holds descriptive flexfield references for an individual expense, enabling custom data collection and categorization. |
| ExpensesExpenseDistribution | Allocates the cost of an expense across multiple accounts, ensuring precise financial reporting. |
| ExpensesExpenseDistributionPJCDFF | Captures project-related flexfields for expense distributions, detailing project codes or tasks linked to the expenditure. |
| ExpensesexpenseErrors | Logs validation or policy errors detected in an expense record, prompting corrective actions prior to submission. |
| ExpensesExpenseItemization | Allows for subdividing a single expense item into multiple cost components (for example, a multi-day hotel stay), improving clarity. |
| ExpensesmatchedExpenses | Syncs submitted expenses with matched records (for example, credit card data), preventing duplicates and maintaining consistency. |
| ExpenseTemplates | Stores a library of standardized expense templates by business unit (for example, travel, relocation), driving efficient expense entry. |
| ExpenseTemplatesexpenseTypes | Defines the specific expense types and applicable policies within a given expense template, ensuring consistent categorization. |
| ExpenseTemplatesexpenseTypesitemizedExpenseTypes | Defines itemized expense categories within a template, allowing granular reporting and policy enforcement for expenses with multiple cost components. |
| ExpenseTemplatesexpenseTypespreferredAgencyLists | Associates preferred travel or service agencies with specific expense types in an expense template, ensuring employees use approved vendors. |
| ExpenseTemplatesexpenseTypespreferredMerchantLists | Specifies pre-approved merchants for given expense types in a template, streamlining compliance and spend oversight. |
| ExpenseTemplatesmobileExpenseTypes | Manages expense types specifically enabled for mobile entry, supporting on-the-go expense capture and policy adherence. |
| ExpenseTypes | Defines and maintains various expense classifications (for example, travel, lodging), guiding users to select the correct cost category. |
| ExpenseTypesitemizedExpenseTypes | Specifies subcategories for detailed expense entries under a parent expense type, enhancing accuracy and reporting granularity. |
| ExpenseTypespreferredAgencyLists | Links preferred agency details (for example, travel agencies) to particular expense types, helping users select valid partners. |
| ExpenseTypespreferredMerchantLists | Catalogs approved merchants for specific expense types, ensuring policy compliance and negotiated rates. |
| ExternalBankAccounts | Stores external bank account details for payments or reimbursements, supporting account creation, modifications, and usage tracking. |
| ExternalBankAccountsaccountOwners | Tracks the owners associated with an external bank account, defining authorization and responsibility for transactions. |
| FedBudgetExecutionControls | Manages budget execution rules for federal accounting requirements, ensuring compliance with government financial guidelines. |
| FedBudgetExecutionControlsfedBudgetControlSegments | Specifies the segment rules within federal budget controls, dictating how funds are tracked and restricted across various accounts. |
| FinBusinessUnitsLOV | Lists defined Financials business units, clarifying operational scope (for example, ledger, default currency) for each unit. |
| Finders | Displays available finder functions and their queryable attributes for different views, aiding in data retrieval and analysis. |
| InstrumentAssignments | Assigns payment instruments (for example, checks, electronic transfers) to specific payees or transactions, ensuring controlled disbursement. |
| IntercompanyOrganizationsLOV | Provides a list of intercompany organizations, facilitating cross-entity transactions and consolidated financial reporting. |
| IntercompanyTransactionTypesLOV | Displays recognized intercompany transaction types, specifying processing rules and ensuring consistent handling in multi-entity environments. |
| InterimDocumentsPayables | Holds temporary payables documents pending validation and payment, enabling partial or staged invoice creation. |
| InvoicesappliedPrepayments | Shows prepayment amounts applied to a given invoice, helping track remaining balances and total obligations. |
| Invoicesattachments | Stores attachments linked to an invoice header (for example, supporting documents), ensuring transparent record-keeping. |
| InvoicesavailablePrepayments | Lists prepayments not yet applied to invoices, indicating funds available to offset future payables. |
| InvoicesinvoiceGdf | Holds global descriptive flexfields at the invoice level, capturing additional region-specific or business-specific attributes. |
| InvoicesinvoiceInstallmentsinvoiceInstallmentDff | Allows user-defined flexfields for invoice installments, enabling specialized reporting on partial payments or custom categories. |
| InvoicesinvoiceInstallmentsinvoiceInstallmentGdf | Manages global descriptive flexfields for invoice installments, facilitating regionally unique or enterprise-wide data requirements. |
| InvoicesinvoiceLinesinvoiceDistributionsinvoiceDistributionDff | Enables custom descriptive flexfields on invoice distributions, allowing organizations to store additional data for reporting or auditing. |
| InvoicesinvoiceLinesinvoiceDistributionsinvoiceDistributionGdf | Holds global descriptive flexfields for invoice distributions, accommodating region-specific or enterprise-wide fields and validations. |
| InvoicesinvoiceLinesinvoiceDistributionsinvoiceDistributionProjectDff | Captures project-relevant details in a flexfield format for invoice distributions, integrating cost-tracking with project management. |
| InvoicesinvoiceLinesinvoiceLineDff | Provides descriptive flexfields at the invoice line level, supporting specialized data collection for each line item. |
| InvoicesinvoiceLinesinvoiceLineGdf | Contains global descriptive flexfields for invoice lines, ensuring compliance with various regional or organizational requirements. |
| InvoicesinvoiceLinesinvoiceLineProjectDff | Tracks project details for individual invoice lines in a flexfield format, linking payables data to project cost structures. |
| LedgersLOV | Offers a lookup of defined ledgers, including primary, secondary, or reporting ledgers, enabling multi-ledger financial tracking. |
| LegalEntitiesLOV | Lists recognized legal entities, indicating each entity’s legislative compliance and responsibilities in the corporate structure. |
| LegalJurisdictionsLOV | Provides a reference to legal jurisdictions with specific legal authorities, aiding tax and regulatory compliance. |
| LegalReportingUnitsLOV | Enumerates legal reporting units, which represent the smallest entities requiring statutory reporting within a business structure. |
| MemoLinesLOV | Allows retrieval of valid memo lines used in Receivables, defining standardized text or charge descriptions for financial documents. |
| PartyFiscalClassifications | Captures fiscal classification data for parties (for example, customers, suppliers), determining applicable tax or regulatory treatment. |
| PartyFiscalClassificationsfiscalClassificationTypeTaxRegimeAssociations | Associates fiscal classification types with relevant tax regimes for correct tax calculation and compliance. |
| PartyTaxProfiles | Holds tax profile information for a party, including tax registrations and configuration, ensuring proper tax handling and reporting. |
| PayablesOptions | Centralizes configuration for Payables, such as defaulting rules and processing parameters, shaping invoice and payment workflows. |
| PayablesPaymentTerms | Defines the rules (for example, net 30, net 60) for paying a supplier, setting installment schedules and discount opportunities. |
| PayablesPaymentTermspayablesPaymentTermsLines | Specifies the line-level breakdown of each payment term, detailing how installments or discounts are structured across due dates. |
| PayablesPaymentTermspayablesPaymentTermsSets | Maps payment terms to reference data sets, allowing different business units or legal entities to share or customize terms. |
| PayablesPaymentTermspayablesPaymentTermsTranslations | Stores multilingual translations of payment terms, facilitating global operations with localized term descriptions. |
| PayablesTaxReportingEntities | Maintains entities required for tax reporting (for example, 1099 in the U.S.), linking tax obligations to specific organizational segments. |
| PayablesTaxReportingEntitiespayablesTaxReportingEntityLine | Captures multiple tax reporting lines under a single entity, supporting consolidated or segmented 1099 reporting configurations. |
| PayeeBankAccountsLOV | Displays valid bank accounts for payees, helping confirm account details during disbursements or refunds. |
| PaymentsExternalPayees | Defines external payees (for example, suppliers, vendors) for payments, enabling creation and modification of payee records. |
| PaymentsExternalPayeesexternalPartyPaymentMethods | Lists payment methods (check, EFT, ACH, etc.) available to a specific external payee, ensuring valid disbursement choices. |
| PaymentTermsLOV | Provides a quick lookup of defined Receivables payment terms, such as net due days or early payment discount schedules. |
| PreferredCurrenciesLOV | Enumerates currency preferences used by users or business units, enabling automated conversions and standardized reporting. |
| ReceiptMethodAssignments | Manages the assignment of receipt methods (for example, cash, check, credit card) to customer accounts or sites, controlling how payments are received. |
| ReceivablesAdjustments | Allows modification of existing invoices, credit memos, or other transactions, adjusting charges, freight, taxes, or lines. |
| ReceivablesAdjustmentsreceivablesAdjustmentDFF | Enables custom fields for receivables adjustments, capturing additional business details or classification codes. |
| ReceivablesBusinessUnitsLOV | Lists valid business units for the Receivables module, identifying each organization’s operational scope and ledger association. |
| ReceivablesCreditMemosattachments | Enables adding or reviewing attachments linked to credit memos, ensuring supporting documentation for transactions. |
| ReceivablesCreditMemosnotes | Holds note objects for credit memos, capturing additional instructions, clarifications, or comments. |
| ReceivablesCreditMemosreceivablesCreditMemoDFF | Enables descriptive flexfields on credit memos, capturing custom data points relevant to an organization’s needs. |
| ReceivablesCreditMemosreceivablesCreditMemoDistributions | Tracks distribution entries for credit memos, detailing account allocations and supporting ledger postings. |
| ReceivablesCreditMemosreceivablesCreditMemoDistributionsreceivablesCreditMemoDistributionDFF | Provides descriptive flexfields for credit memo distribution lines, adding specialized data for comprehensive financial tracking. |
| ReceivablesCreditMemosreceivablesCreditMemoGdf | Houses global descriptive flexfields for credit memos, accommodating region-specific or corporate-wide fields. |
| ReceivablesCreditMemosreceivablesCreditMemoLines | Represents each line item of a credit memo, specifying product, amounts, and adjustments for the transaction. |
| ReceivablesCreditMemosreceivablesCreditMemoLinesattachments | Facilitates document attachments at the credit memo line level, ensuring full traceability of line-specific data. |
| ReceivablesCreditMemosreceivablesCreditMemoLinesreceivablesCreditMemoLineDFF | Enables descriptive flexfields for individual credit memo lines, capturing extended transaction details. |
| ReceivablesCreditMemosreceivablesCreditMemoLinesreceivablesCreditMemoLineGdf | Holds global descriptive flexfields for credit memo lines, supporting worldwide or business-specific data requirements. |
| ReceivablesCreditMemosreceivablesCreditMemoLinesreceivablesCreditMemoLineTaxLines | Stores tax line details for credit memo lines, specifying calculated taxes, jurisdictions, and associated rates. |
| ReceivablesCreditMemosreceivablesCreditMemoLinesreceivablesCreditMemoLineTransactionDFF | Manages descriptive flexfields for credit memo transactions at the line level, enhancing finance data granularity. |
| ReceivablesCreditMemosreceivablesCreditMemoTransactionDFF | Applies descriptive flexfields at the credit memo transaction level, capturing custom attributes for the entire memo. |
| ReceivablesCustomerAccountActivities | Consolidates activities for a customer’s accounts, including transactions, receipts, and credit applications within Receivables. |
| ReceivablesCustomerAccountActivitiescreditMemoApplications | Lists credit memo applications tied to customer account activities, enabling partial or full offset of outstanding transactions. |
| ReceivablesCustomerAccountActivitiescreditMemoApplicationscreditMemoApplicationDFF | Supports descriptive flexfields for credit memo applications, storing additional data during the application process. |
| ReceivablesCustomerAccountActivitiescreditMemos | Displays credit memos issued to a customer’s account, including on-account memos and standard credit memos. |
| ReceivablesCustomerAccountActivitiesstandardReceiptApplications | Lists standard receipt applications for a customer’s account activities, showing how receipts are allocated to open items. |
| ReceivablesCustomerAccountActivitiesstandardReceiptApplicationsstandardReceiptApplicationDFF | Enables custom descriptive flexfields for standard receipt applications, capturing extra data or references. |
| ReceivablesCustomerAccountActivitiesstandardReceipts | Shows standard receipts recorded for a customer’s account, reflecting payments received for goods or services. |
| ReceivablesCustomerAccountActivitiestransactionAdjustments | Details any adjustments (increases or decreases) applied to a customer’s transactions, reflecting corrections or policy updates. |
| ReceivablesCustomerAccountActivitiestransactionPaymentSchedules | Tracks payment schedules (for example, installments) for a customer’s transactions, ensuring consistent collections and visibility. |
| ReceivablesCustomerAccountActivitiestransactionsPaidByOtherCustomers | Highlights instances where a different customer remits payment on behalf of the primary customer’s outstanding transactions. |
| ReceivablesCustomerAccountSiteActivities | Presents activities linked to both the customer account and the specific billing site, providing a unified transaction overview. |
| ReceivablesCustomerAccountSiteActivitiescreditMemoApplications | Lists credit memo applications for site-level transactions, allowing offsets or adjustments to outstanding amounts at the site. |
| ReceivablesCustomerAccountSiteActivitiescreditMemoApplicationscreditMemoApplicationDFF | Supports custom descriptive flexfields for credit memo applications at the account site level, capturing specialized data. |
| ReceivablesCustomerAccountSiteActivitiescreditMemos | Shows credit memos associated with the customer’s site, covering both standard and on-account credits. |
| ReceivablesCustomerAccountSiteActivitiesstandardReceiptApplications | Tracks standard receipt applications at the site level, mapping applied payments to site-specific invoices or transactions. |
| ReceivablesCustomerAccountSiteActivitiesstandardReceiptApplicationsstandardReceiptApplicationDFF | Holds custom descriptive flexfields for receipt applications at the account site level, capturing extra data for reporting or integrations. |
| ReceivablesCustomerAccountSiteActivitiesstandardReceipts | Lists standard receipts managed at the account site, indicating payments received for site-specific transactions. |
| ReceivablesCustomerAccountSiteActivitiestransactionAdjustments | Tracks adjustments (credits, debits) to site-based transactions, ensuring accurate account records and resolving discrepancies. |
| ReceivablesCustomerAccountSiteActivitiestransactionPaymentSchedules | Displays scheduled payments for site-level transactions (for example, installment plans), enhancing cash flow planning and visibility. |
| ReceivablesCustomerAccountSiteActivitiestransactionsPaidByOtherCustomers | Identifies cross-customer payments applied to site-related transactions, aiding reconciliation when a third party settles balances. |
| ReceivablesInvoicesattachments | Manages the supporting documents attached to a receivables invoice, ensuring compliance and clarity for invoice recipients. |
| ReceivablesInvoicesnotes | Captures notes or comments linked to an invoice, adding contextual information for collectors, auditors, or customers. |
| ReceivablesInvoicesreceivablesInvoiceDFF | Enables descriptive flexfields for receivables invoices, storing additional details aligned to business processes. |
| ReceivablesInvoicesreceivablesInvoiceDistributions | Allocates invoice lines to accounting segments, creating detailed distribution records for financial analysis. |
| ReceivablesInvoicesreceivablesInvoiceDistributionsreceivablesInvoiceDistributionDFF | Holds custom descriptive flexfields for invoice distributions, aiding specialized reporting or data capture. |
| ReceivablesInvoicesreceivablesInvoiceGdf | Contains global descriptive flexfields at the invoice level, supporting multi-regional billing and compliance requirements. |
| ReceivablesInvoicesreceivablesInvoiceInstallments | Details installment-based billing within an invoice, reflecting the portion due amounts and their corresponding dates. |
| ReceivablesInvoicesreceivablesInvoiceInstallmentsreceivablesInvoiceInstallmentGDF | Leverages global descriptive flexfields for invoice installments, handling cross-border or specialized business needs. |
| ReceivablesInvoicesreceivablesInvoiceInstallmentsreceivablesInvoiceInstallmentNotes | Stores notes or instructions for specific invoice installments, ensuring clarity around partial payment obligations. |
| ReceivablesInvoicesreceivablesInvoiceLines | Outlines each item or service included in a receivables invoice, capturing unit price, quantity, and tax details. |
| ReceivablesInvoicesreceivablesInvoiceLinesattachments | Facilitates attaching supporting files at the line level, clarifying charges or providing proof of delivery. |
| ReceivablesInvoicesreceivablesInvoiceLinesreceivablesInvoiceLineDFF | Adds descriptive flexfields at the line item level, extending invoice functionality with custom fields. |
| ReceivablesInvoicesreceivablesInvoiceLinesreceivablesInvoiceLineGdf | Employs global descriptive flexfields for invoice lines, supporting globalized business scenarios and complex data requirements. |
| ReceivablesInvoicesreceivablesInvoiceLinesreceivablesInvoiceLineTaxLines | Captures tax calculations and jurisdictions for each invoice line, facilitating accurate compliance and tax reporting. |
| ReceivablesInvoicesreceivablesInvoiceLinesreceivablesInvoiceLineTransactionDFF | Allows custom descriptive flexfields for transaction-level data on invoice lines, providing extended tracking and analysis. |
| ReceivablesInvoicesreceivablesInvoiceTransactionDFF | Adds descriptive flexfields for the entire invoice transaction, enabling more detailed recordkeeping of billing activities. |
| StandardReceiptsattachments | Manages attached documentation (for example, bank slips) for each standard receipt, ensuring proof of payment and audit trails. |
| StandardReceiptsremittanceReferences | Enables adding references for payments, such as remittance advice numbers, assisting bank reconciliation and inquiries. |
| StandardReceiptsstandardReceiptDFF | Hosts descriptive flexfields on standard receipts, allowing extra details or tracking codes for internal processes. |
| StandardReceiptsstandardReceiptGdf | Employs global descriptive flexfields for receipts, meeting international or business-specific data requirements. |
| TaxAuthorityProfiles | Provides a lookup of tax authority profiles, outlining configuration for various tax authorities and compliance rules. |
| TaxClassifications | Lists tax classification attributes used for calculating and reporting tax obligations, enabling precise categorization. |
| TaxExemptions | Manages records of exempted transactions or entities, allowing authorized users to view, add, or modify tax exemption details. |
| TaxPayerIdentifiers | Stores taxpayer identification data (for example, TIN, VAT ID), facilitating correct tax reporting for businesses or individuals. |
| ThirdPartyFiscalClassifications | Associates suppliers or customers with fiscal classifications, determining how transactions are taxed or reported. |
| ThirdPartySiteFiscalClassifications | Manages fiscal classifications at the site level (for example, supplier site), defining local tax or regulatory requirements. |
| ThirdPartySiteTaxReportingCodeAssociations | Links site-level entities to tax reporting codes, ensuring accurate data capture for compliance and audit needs. |
| ThirdPartyTaxReportingCodeAssociations | Establishes tax reporting code relationships for third parties, enabling efficient retrieval of tax data across transactions. |
| TransactionSourcesLOV | Displays recognized Receivables transaction sources (for example, manual, import), guiding consistent transaction entry practices. |
| TransactionTaxLines | Allows the creation, retrieval, and modification of manual tax lines for a transaction, ensuring accurate tax posting. |
| TransactionTypesLOV | Presents valid Receivables transaction types (for example, invoice, debit memo) for referencing in billing and revenue processes. |
| ValueSets | Holds value set definitions, ensuring controlled vocabularies and standardized validation for various fields. |
| ValueSetsvalidationTable | Specifies the underlying validation table for value sets, directing how lookups and data checks occur. |
| ValueSetsValues | Lists permissible values in a specific value set, enforcing consistency in data entry across modules. |
| WithholdingTaxLines | Maintains entries for withholding tax computations, supporting creation, retrieval, and updates to withholdings on transactions. |
| WorkflowUsers | Records details of workflow participants, mapping users to roles or steps in financial approvals and notifications. |
Provides a reference of valid General Ledger account combinations, ensuring accurate segment values for financial reporting and ledger analysis.
| Name | Type | Description |
| AccountType | String | Specifies the type of account as defined in the Account Combinations table of the Oracle Financials Cloud, used to categorize accounts in financial transactions. |
| JgzzReconFlag | String | Indicates whether the account combination is part of the reconciliation process, marking whether journal entries associated with it are subject to reconciliation. |
| DetailBudgetingAllowedFlag | String | Indicates whether detailed budgeting is allowed for the account combination, determining the granularity of budget control for that account. |
| FinancialCategory | String | Defines the financial category of the account, helping classify accounts into categories such as revenue, expense, asset, or liability within the system. |
| Reference3 | String | A reference field used in the Account Combinations table, potentially for custom categorization or identifying specific account details. |
| DetailPostingAllowedFlag | String | Indicates whether detailed postings are permitted for the account combination, determining the level of detail recorded in journal entries. |
| SummaryFlag | String | Indicates whether the account combination is used for summary-level posting, as opposed to detailed transaction entries in the financial records. |
| StartDateActive | Date | The start date when the account combination became active and available for use in financial transactions and reporting. |
| EndDateActive | Date | The end date when the account combination was deactivated, no longer available for use in transactions or reporting. |
| EnabledFlag | String | Indicates whether the account combination is enabled for use in the system, controlling whether it can be selected in financial transactions. |
| _CODE_COMBINATION_ID [KEY] | Long | The unique identifier for the account combination, used to reference a specific combination of account segments in financial transactions. |
| _CHART_OF_ACCOUNTS_ID | Long | The identifier of the chart of accounts that the account combination belongs to, linking it to a specific set of account structures within the financial system. |
| Bind_ValidationDate | Date | The date used to bind and validate the account combination for certain operations or validations, ensuring the account structure is valid for the given period. |
| Finder | String | A field used to search or identify specific account combinations based on certain criteria in the Account Combinations table. |
| Var0 | String | A user-defined variable field in the Account Combinations table, allowing additional custom data to be associated with the account combination. |
| Var1 | String | A user-defined variable field in the Account Combinations table, providing additional flexibility for custom attributes related to the account combination. |
| Var2 | String | A user-defined variable field for storing custom values or additional information about the account combination, often used for business-specific needs. |
| Var3 | String | A user-defined variable for custom data, enabling the inclusion of additional, often business-specific, attributes related to account combinations. |
| Var4 | String | A user-defined field for storing additional custom information about the account combination, offering flexibility for specific organizational requirements. |
| Var5 | String | A customizable field for storing extra information or attributes for the account combination, tailored to the specific needs of the business. |
| Var6 | String | A custom user-defined field within the account combination structure, allowing for the inclusion of additional relevant information. |
| Var7 | String | A customizable field used for storing extra attributes or data specific to the account combination, offering flexibility in the schema. |
| Var8 | String | A user-defined field that can hold additional custom data about the account combination, enabling business-specific tracking or categorization. |
| Var9 | String | A customizable variable field that stores extra, custom-defined attributes for the account combination, used for business-specific purposes. |
| VarCsr | String | A user-defined variable for storing custom values related to the account combination, allowing additional context or categorization. |
| VarSin | String | A user-defined field for storing custom information associated with the account combination, providing extra flexibility for specific business needs. |
Maintains shorthand alias definitions for quick entry of account combinations, streamlining data input in accounting processes.
| Name | Type | Description |
| ShorthandAliasCode [KEY] | String | The shorthand alias code used to uniquely identify a shorthand alias for account combinations in the AccountCombinationsShorthandAliasesLOV table. |
| StartDateActive | Date | The date when the shorthand alias for the account combination becomes active, marking the start of its validity period. |
| EndDateActive | Date | The date when the shorthand alias for the account combination is no longer active, indicating the end of its validity period. |
| EnabledFlag | String | A flag indicating whether the shorthand alias for account combinations is currently enabled ('Y' for enabled, 'N' for disabled). |
| ShaName | String | The name of the shorthand alias, providing a human-readable reference for the account combination alias. |
| ShaDesc | String | A detailed description of the shorthand alias, giving additional context or information about the alias and its intended use. |
| _CHART_OF_ACCOUNTS_ID [KEY] | Long | The unique identifier for the chart of accounts to which this shorthand alias belongs, linking the alias to a specific set of accounts. |
| Bind_ValidationDate | Date | The date when the shorthand alias was validated or bound, often used to track when an alias is associated with a valid account combination. |
| Finder | String | The search term or identifier used to find a specific shorthand alias within the AccountCombinationsShorthandAliasesLOV table, aiding in quick lookups. |
| Var0 | String | A placeholder variable in the AccountCombinationsShorthandAliasesLOV table, potentially used for custom attributes or flexible data storage. |
| Var1 | String | A placeholder variable in the AccountCombinationsShorthandAliasesLOV table, potentially used for custom attributes or flexible data storage. |
| Var2 | String | A placeholder variable in the AccountCombinationsShorthandAliasesLOV table, potentially used for custom attributes or flexible data storage. |
| Var3 | String | A placeholder variable in the AccountCombinationsShorthandAliasesLOV table, potentially used for custom attributes or flexible data storage. |
| Var4 | String | A placeholder variable in the AccountCombinationsShorthandAliasesLOV table, potentially used for custom attributes or flexible data storage. |
| Var5 | String | A placeholder variable in the AccountCombinationsShorthandAliasesLOV table, potentially used for custom attributes or flexible data storage. |
| Var6 | String | A placeholder variable in the AccountCombinationsShorthandAliasesLOV table, potentially used for custom attributes or flexible data storage. |
| Var7 | String | A placeholder variable in the AccountCombinationsShorthandAliasesLOV table, potentially used for custom attributes or flexible data storage. |
| Var8 | String | A placeholder variable in the AccountCombinationsShorthandAliasesLOV table, potentially used for custom attributes or flexible data storage. |
| Var9 | String | A placeholder variable in the AccountCombinationsShorthandAliasesLOV table, potentially used for custom attributes or flexible data storage. |
| VarCsr | String | A placeholder variable in the AccountCombinationsShorthandAliasesLOV table, potentially used for custom attributes or flexible data storage, related to customer-specific data. |
| VarSin | String | A placeholder variable in the AccountCombinationsShorthandAliasesLOV table, potentially used for custom attributes or flexible data storage, often associated with a specific system or identifier. |
Displays available accounting or commitment calendars, detailing periods and dates for budgeting and transaction alignment.
| Name | Type | Description |
| UserPeriodSetName | String | The name of the user-defined period set, used to group accounting periods within a specific calendar structure for easier management. |
| CalendarId [KEY] | Long | The unique identifier for the accounting calendar, linking to the AccountingCalendarsLOV and providing a reference to the calendar's properties and structure. |
| PeriodType | String | Indicates the type of accounting period (for example, monthly, quarterly) associated with the calendar, helping to classify the periods for financial reporting. |
| PeriodSetName | String | The name of the period set, which represents a collection of accounting periods within a given fiscal year or accounting cycle. |
| CalendarTypeCode | String | A code representing the type of accounting calendar (for example, Gregorian, fiscal) used to define the structure and rules for the calendar. |
| Description | String | A brief description or label for the accounting calendar, providing more context about its usage and the periods it defines. |
| PeriodSetId [KEY] | Long | The unique identifier for the period set within the accounting system, linking it to the corresponding calendar and its associated periods. |
| PeriodTypeId [KEY] | Long | The unique identifier for the period type, used to categorize accounting periods and align them with fiscal or calendar structures. |
| Finder | String | A search term or keyword used to locate specific accounting periods or calendar entries, aiding users in filtering results from the AccountingCalendarsLOV table. |
| SearchTerm | String | A general search term used for finding relevant accounting periods or calendar information based on user input, assisting in quick lookups. |
Lists period details (for example, open, closed) within a specified accounting calendar, aiding period-based reporting and reconciliation.
| Name | Type | Description |
| PeriodNameId [KEY] | String | The unique identifier for the period name in the AccountingPeriodsLOV table, used to reference specific accounting periods. |
| PeriodSetNameId [KEY] | String | The unique identifier for the period set name in the AccountingPeriodsLOV table, indicating the set of periods this record belongs to. |
| PeriodType | String | The type of accounting period, as defined in the AccountingPeriodsLOV table, such as 'Monthly' or 'Yearly'. |
| AdjustmentPeriodFlag | Bool | A flag indicating whether the period is an adjustment period. True means it's an adjustment period, and false means it's a regular period. |
| StartDate | Date | The start date for the accounting period, marking the beginning of the period in the AccountingPeriodsLOV table. |
| EndDate | Date | The end date for the accounting period, marking the conclusion of the period in the AccountingPeriodsLOV table. |
| EnteredPeriodName | String | The name of the period as entered in the AccountingPeriodsLOV table, representing how the period is labeled for user interaction. |
| PeriodYear | Long | The year of the accounting period, as recorded in the AccountingPeriodsLOV table, used for categorization and financial year tracking. |
| PeriodNumber | Long | The unique number assigned to the accounting period within a given year, helping to order and identify the period. |
| AccessSetIdVar | Long | The unique identifier for the access set, used to determine which users or roles can access the period data within the AccountingPeriodsLOV table. |
| BindJeBatchId | Long | The unique identifier for the journal entry batch linked to the accounting period in the AccountingPeriodsLOV table. |
| Finder | String | A searchable term or identifier used in the AccountingPeriodsLOV table to locate specific periods based on user queries. |
| PeriodSetNameIdVar | String | The variable representing the period set name ID, used to bind and identify the period set in queries and operations. |
| PeriodTypeVar | String | The variable representing the period type, used in dynamic queries or operations to specify the period type for filtering. |
| SearchTerm | String | A user-defined search term used to filter accounting periods, often used for locating specific records in the AccountingPeriodsLOV table. |
Tracks the current status of each accounting period (for example, open, closed) within a calendar, preventing unauthorized postings.
| Name | Type | Description |
| PeriodNameId [KEY] | String | The unique identifier for the period name in the AccountingPeriodStatusLOV table, representing a specific accounting period name. |
| ApplicationId [KEY] | Long | The unique identifier for the application in the AccountingPeriodStatusLOV table, linking the period to a specific application context. |
| LedgerId [KEY] | Long | The unique identifier for the ledger in the AccountingPeriodStatusLOV table, representing the financial ledger associated with the accounting period. |
| ClosingStatus | String | The status of the closing process for the accounting period, indicating whether the period has been closed or is still open. |
| EndDate | Date | The date when the accounting period ends, marking the last day of financial transactions for that period. |
| StartDate | Date | The date when the accounting period starts, marking the first day of financial transactions for that period. |
| EffectivePeriodNumber | Long | The effective period number within the accounting system, used for identifying the period in a chronological order of execution. |
| PeriodYear | Long | The year of the accounting period, used for grouping and reporting financial data by year. |
| PeriodNumber | Long | The unique number assigned to the accounting period within a given year, typically used for financial reporting purposes. |
| AdjustmentPeriodFlag | Bool | A flag indicating whether the period is an adjustment period, which can be used to make changes to prior accounting periods. |
| BindAccountingDate | Date | The date used for binding accounting entries, often related to when financial transactions are recorded or processed in the system. |
| BindAdjFlag | String | A flag that indicates whether adjustments are allowed or have been made for the accounting period being processed. |
| BindApplicationId | Long | The application identifier linked to the accounting period, used to associate the period with a specific financial application or system. |
| BindEffectivePeriodNum | Long | The effective period number used for binding the period to specific transaction entries in the accounting system. |
| BindLedgerId | Long | The ledger identifier associated with the accounting period, ensuring the correct ledger is used during the period's financial operations. |
| BuIdVar | Long | The unique identifier for the business unit, linking the accounting period to a specific organizational unit for reporting and financial analysis. |
| Finder | String | A search term or identifier used to locate specific accounting periods or related data within the system's query functions. |
| LedgerIdVar | Long | The variable ledger identifier, representing the ledger in use during specific financial processes for the accounting period. |
| SearchTerm | String | A term used to search for relevant accounting period data, typically used in queries or lookup operations in the financial system. |
| SearchTerms | String | A set of search terms or keywords used to filter and locate accounting period records in the system's search functionality. |
Enables configuration of country-specific validations and label changes on bank account fields for streamlined account setup.
| Name | Type | Description |
| CountrySpecificUIRuleId [KEY] | Long | The unique identifier for a specific country-based UI rule, used to manage country-specific UI behavior in Oracle Financials Cloud. |
| CountryCode | String | A code that uniquely identifies the country where the UI rule is implemented, enabling localized configurations and preferences for each country. |
| BankAccountFieldName | String | The specific field or attribute within the bank account configuration to which the country-specific display rule applies, ensuring that the UI is tailored to local requirements. |
| DisplayFlag | Bool | A flag that determines whether the associated attribute is visible on the user interface for the selected country, enabling customization of the display. |
| LabelCode | String | The display name of the attribute in the UI, localized for the specified country, providing a user-friendly label that is contextually relevant. |
| BankAccountFieldLabel | String | A descriptive label for the bank account field as defined in the BankAccountUserRules record, which helps users understand the purpose of the field in their local context. |
| RequiredFlag | Bool | A flag indicating whether the attribute is mandatory for users in the specified country, ensuring compliance with local requirements for bank account configurations. |
| ObjectVersionNumber | Int | A version number used to detect concurrency issues, comparing the object’s version at the start and end of a transaction to prevent overwriting updates from other sessions. |
| CreationDate | Datetime | The date and time when the BankAccountUserRules record was created, providing an audit trail for when the configuration was first established. |
| CreatedBy | String | The username or identifier of the user who created the BankAccountUserRules record, providing accountability and traceability. |
| LastUpdateDate | Datetime | The date and time when the BankAccountUserRules record was last updated, helping to track when changes to the configuration were made. |
| LastUpdatedBy | String | The username or identifier of the user who last updated the BankAccountUserRules record, ensuring changes can be attributed to the responsible user. |
| LastUpdateLogin | String | The login identifier for the session in which the last update to the BankAccountUserRules record occurred, enabling session-specific traceability. |
| PageName | String | The name of the page within the user interface where the country-specific UI rule is applied, guiding users to the relevant page for the localized configuration. |
| SeededFlag | Bool | A flag indicating whether the rule is part of predefined, default data for the country, differentiating between seeded and user-defined configurations. |
| SeedDataSource | String | The source of the predefined data for the country-specific rule, typically indicating whether it came from Oracle's default settings or another external data source. |
| Finder | String | A reference or search parameter associated with the BankAccountUserRules record, used to identify and retrieve specific user rules associated with bank accounts. |
Shows results of budgetary control checks, helping users identify whether labor schedules or requisitions exceed set budgets.
| Name | Type | Description |
| TransactionNumber | String | The unique identifier for the transaction within the BudgetaryControlResults table, used for tracking and referencing specific financial transactions. |
| EnteredAmount | Decimal | The amount of the transaction as entered by the user, representing the original monetary value before any currency conversion or adjustments. |
| EnteredCurrency | String | The currency in which the entered amount is denominated, indicating the original currency used for the transaction. |
| Amount | Decimal | The adjusted amount of the transaction after currency conversion, representing the final value in the system's base currency. |
| CurrencyCode | String | The code of the currency used for the transaction, which helps identify the currency type (for example, USD, EUR). |
| ControlBudgetId | Long | The unique identifier for the control budget associated with the transaction, used to track budget limits and allocations. |
| Name | String | The descriptive name or title associated with the BudgetaryControlResults entry, often representing the financial item or transaction. |
| PeriodName | String | The name of the period (for example, fiscal quarter or year) to which the transaction pertains, allowing for financial reporting by time. |
| BudgetCcid | Long | The unique identifier for the budget control center (CCID) linked to the transaction, which helps define the financial responsibility area. |
| ConversionDate | Date | The date on which currency conversion took place, used to determine the exchange rate applied to the transaction at that time. |
| ConversionRate | Decimal | The rate at which the entered amount was converted into the system's base currency, reflecting the exchange rate used during the conversion. |
| UserConversionType | String | The type of currency conversion applied by the user, providing context for how the conversion rate was selected or applied. |
| SourceHeaderId1 | String | The first identifier for the source header of the transaction, used to link the entry to the originating document or transaction source. |
| SourceHeaderId2 | String | The second identifier for the source header of the transaction, providing additional context or linkage to the original source. |
| SourceLineId1 | String | The first identifier for the source line of the transaction, connecting the entry to a specific line item in the source document. |
| SourceLineId2 | String | The second identifier for the source line of the transaction, further identifying a specific line item or part of the source document. |
| SourceLineId3 | String | The third identifier for the source line of the transaction, providing additional granularity for referencing detailed components of the source document. |
| SourceLineId4 | String | The fourth identifier for the source line of the transaction, offering further segmentation of the source document's line items. |
| SourceLineId5 | String | The fifth identifier for the source line of the transaction, adding further specificity when referencing detailed components of the source document. |
| DataSetId | Long | The unique identifier for the dataset associated with the transaction, used for grouping and organizing financial records within the system. |
| TransactionTypeCode | String | A code that identifies the type of transaction (for example, budget adjustment, allocation, or commitment), providing context for its purpose within the budgetary system. |
| DraftFlag | Bool | A flag indicating whether the transaction is in a draft status, allowing users to track entries before finalizing them for official processing. |
| ResultCode | String | The code that represents the outcome or status of the transaction, indicating whether it was successful, failed, or requires further review. |
| BudgetAccount | String | The identifier for the specific budget account involved in the transaction, used to assign the transaction to the correct budget category. |
| FundsConsumed | String | The amount of funds that have been consumed from the budget, showing how much of the allocated funds have been used by the transaction. |
| Status | String | The current status of the transaction (for example, pending, completed, or rejected), providing insight into its processing stage or approval state. |
| BalanceType | String | The type of balance associated with the transaction (for example, actual, forecasted, or budgeted), used to differentiate between various financial calculations. |
| ProjectBurden | String | The burden or cost associated with the project linked to the transaction, often used in the context of project-based financial tracking. |
| BudgetManager | String | The name or identifier of the person responsible for managing the budget associated with the transaction, providing accountability for budget oversight. |
| Finder | String | A unique identifier or reference used for searching or locating specific BudgetaryControlResults entries, typically used in query or reporting tools. |
Provides budget impact data associated with labor schedules, including any reductions in available funds due to transactions.
| Name | Type | Description |
| BudgetCcid [KEY] | Long | The unique identifier for the budget control record in the BudgetaryControlResultsBudgetImpacts table, used to link budget-related impacts to a specific budget control. |
| ControlBudgetId [KEY] | Long | The unique identifier for the control budget in the BudgetaryControlResultsBudgetImpacts table, used to associate the budget impacts with the respective control budget. |
| PeriodName [KEY] | String | The name or identifier of the financial period for the budgetary control results, used to track the specific time frame of the budget impacts. |
| TransactionNumber | String | The transaction number associated with a budgetary control impact, used to uniquely identify the financial transaction in the system. |
| Amount | Decimal | The monetary value of the budgetary impact recorded, representing the total amount of the transaction or budget adjustment. |
| EnteredAmount | Decimal | The amount entered manually or through a system integration, indicating the recorded value before any adjustments or calculations. |
| ResultCode | String | A code representing the result of the budgetary control process, indicating whether the transaction was approved, rejected, or pending. |
| CurrencyCode | String | The code representing the currency used for the budgetary control results, allowing for multi-currency support in financial transactions. |
| Name | String | The name or description of the budgetary control record, used to provide a clear label for the budget impact. |
| AccountedProjectAmount | Decimal | The amount of the budgetary impact that has been accounted for within the specific project, typically used in project-based financial reporting. |
| AccountedPayablesAmount | Decimal | The amount of the budgetary control impact attributed to accounts payable, indicating funds allocated for payments to vendors or suppliers. |
| AccountedReceiptsAmount | Decimal | The amount of the budgetary control impact attributed to accounts receivable, reflecting expected funds from customers or other sources. |
| ActualAmount | Decimal | The actual amount recorded for a transaction or budget adjustment, reflecting the real financial impact as opposed to estimated or budgeted figures. |
| ApprovedAuthorizationAmount | Decimal | The amount that has been authorized for expenditure, subject to approval within the budgetary control process. |
| ApprovedCommitmentAmount | Decimal | The amount that has been committed for future spending, typically for ongoing contracts or planned expenditures. |
| ApprovedObligationAmount | Decimal | The amount of funds that have been obligated for a specific purpose, indicating a legal or financial responsibility to spend. |
| BudgetAdjustmentAmount | Decimal | The amount by which the original budget has been adjusted, either through increases or decreases based on financial needs or decisions. |
| BudgetAmount | Decimal | The total approved budget amount, representing the allocated funds for a particular budget line or category. |
| CommitmentAmount | Decimal | The total amount of funds that have been committed but not yet spent, typically covering outstanding obligations or agreements. |
| DetailOtherAmount | Decimal | Any additional amounts related to other budgetary impacts that are not directly categorized under standard budget categories. |
| FundsAvailableAmount | Decimal | The amount of funds remaining available for expenditure within the current budget, reflecting unspent or remaining funds after commitments. |
| MiscExpendituresAmount | Decimal | The amount of miscellaneous expenditures that are outside of the predefined categories, often used for one-off or unforeseen expenses. |
| ObligationAmount | Decimal | The amount of funds that have been legally obligated for spending, including contracted expenses and financial commitments. |
| OtherAmount | Decimal | Any other amounts related to the budgetary control results that do not fit into the standard categories, representing additional financial factors. |
| UnreleasedBudgetAmount | Decimal | The portion of the budget that has not yet been released for spending, often due to approval processes or restrictions. |
| TotalConsumption | Decimal | The total amount of funds consumed or used from the budget, indicating how much of the budget has been spent or allocated. |
| BudgetAccount | String | The identifier for the specific budget account, used to track financial transactions within a given account in the budgetary system. |
| FundsConsumed | Decimal | The amount of funds that have been consumed or utilized from the available budget, contributing to the total consumption. |
| Status | String | The current status of the budgetary control results, such as active, completed, or pending, to indicate the stage of the financial process. |
| BudgetManager | String | The name or identifier of the budget manager responsible for overseeing and controlling the budgetary impacts and financial allocations. |
| AdditionalRequired | Decimal | The amount of additional funding required to meet the budgetary needs or resolve any shortfalls in the current budget. |
| DataSetId | Long | The unique identifier for the dataset that contains the budgetary control results, used for grouping and managing related financial data. |
| DraftFlag | String | A flag indicating whether the budgetary control results are in draft status, meaning they are not yet finalized or approved. |
| Finder | String | An identifier or code used to locate or search for specific budgetary control results within the database or financial system. |
| SourceHeaderId1 | String | The unique identifier for the first source header associated with the budgetary control impact, used for linking the record to its originating source. |
| SourceHeaderId2 | String | The unique identifier for the second source header, which may be used for additional linkage to another related financial source. |
| SourceLineId1 | String | The unique identifier for the first source line, allowing further specification of the source transaction or document related to the budgetary impact. |
| SourceLineId2 | String | The unique identifier for the second source line, providing additional detail for tracing the transaction or document origin. |
| SourceLineId3 | String | The unique identifier for the third source line, offering even further specificity for tracing the financial source of the impact. |
| SourceLineId4 | String | The unique identifier for the fourth source line, helping further detail the origin of the transaction or budgetary impact. |
| SourceLineId5 | String | The unique identifier for the fifth source line, providing additional granularity in identifying the source of financial impacts. |
| TransactionTypeCode | String | The code representing the type of financial transaction being recorded, such as a payment, adjustment, or allocation, providing context to the budgetary impact. |
Supports internal budget adjustments by displaying validation info on transactions affecting Enterprise Performance Management budgets.
| Name | Type | Description |
| TransactionNumber [KEY] | String | The unique identifier for the transaction in the BudgetaryControlResultsBudgetTransactions table, used to track specific transactions within the system. |
| LineNumber | String | The line number associated with the transaction, providing further detail about the specific entry within the budgetary control results. |
| ControlBudget | String | The budget control code that this transaction is associated with, indicating the specific budget being monitored. |
| ControlBudgetPeriod | String | The period of the control budget to which the transaction belongs, used for time-based budget control in the system. |
| BudgetAccount | String | The account within the budget to which this transaction is attributed, providing a financial classification for the transaction. |
| TransactionAmount | Decimal | The amount of the transaction, expressed in the appropriate currency, representing the financial impact on the budget. |
| ControlBudgetAmount | Decimal | The allocated amount for the control budget, showing the total sum assigned for monitoring and control during the specified period. |
| ReservedBudgetAmount | Decimal | The amount of the control budget that has been reserved for use, but not yet consumed, within the system. |
| BudgetTransactionType | String | The type of budget transaction, indicating whether the entry is a debit, credit, adjustment, or another type of financial transaction. |
| FundsAction | String | The action associated with the funds, such as allocation, reallocation, or adjustment, applied to the budget transaction. |
| BatchResult | String | The outcome of the batch process for the transaction, indicating whether the batch has been successfully processed or encountered issues. |
| BatchFatalErrorMessage | String | A message detailing any fatal errors encountered during the batch process, helping to diagnose issues preventing successful processing. |
| HeaderStatus | String | The status of the transaction's header, indicating whether the overall transaction has been approved, pending, or has encountered issues. |
| HeaderResult | String | The result of processing the transaction's header, including the outcome or error code from the header-level validation. |
| LineStatus | String | The status of the specific line item within the transaction, indicating whether it is pending, processed, or contains errors. |
| LineResult | String | The result of the line item processing, providing information on whether the line item was successfully processed or encountered an issue. |
| ActivityStatus | String | The status of any activity related to the transaction, which could include approval, completion, or waiting for further actions. |
| ActivityResult | String | The result of the activity tied to the transaction, indicating the outcome or errors associated with specific actions. |
| InitialBudgetBalance | Decimal | The starting balance for the budget before any transactions or adjustments have been applied, representing the original allocated budget amount. |
| BudgetAdjustmentBalance | Decimal | The balance reflecting any adjustments made to the budget, such as increases or decreases, over the course of the period. |
| TotalBudgetBalance | Decimal | The total budget balance after all adjustments, showing the final available amount after considering both initial balances and adjustments. |
| TotalConsumptionBalance | Decimal | The total amount of the budget that has been consumed by transactions, representing expenditures or usage against the available budget. |
| FundsAvailableBalance | Decimal | The remaining balance of funds available in the budget after accounting for both consumption and reservations. |
| BudgetManager | String | The identifier for the individual or role responsible for managing and overseeing the budget's use and monitoring within the organization. |
| ControlBudgetCurrency | String | The currency of the control budget, ensuring transactions are monitored and tracked in the appropriate monetary units. |
| TransactionCurrency | String | The currency in which the transaction is denominated, which could differ from the control budget's currency. |
| ConversionDate | Date | The date on which the currency conversion occurred, used to ensure accurate conversion rates are applied for multi-currency transactions. |
| ConversionRate | Decimal | The rate applied to convert the transaction amount from one currency to another, ensuring accurate financial calculations. |
| UserConversionType | String | The type of conversion applied to the transaction, such as manual or system-generated, providing clarity on the conversion process used. |
| Finder | String | A reference or search term associated with the transaction, used for tracking and identifying specific entries in the system. |
| SourceBudget | String | The original or source budget from which funds are being allocated or transferred, helping to trace the origin of the transaction within the budgetary framework. |
Enables queries on bank branch details, supporting cash management and setup of payment or receipt methods.
| Name | Type | Description |
| BranchPartyId [KEY] | Long | The unique identifier for the branch party within the CashBankBranchesLOV lookup table, used to link the branch to the party it represents. |
| BankBranchName | String | The name of the bank branch within the CashBankBranchesLOV lookup table, providing a human-readable identifier for the branch. |
| BranchNumber | String | The unique number assigned to the bank branch within the CashBankBranchesLOV lookup table, typically used for referencing and sorting branches. |
| BankName | String | The name of the bank associated with the branch within the CashBankBranchesLOV lookup table, helping to identify the institution for the branch. |
| BindBankHomeCountry | String | The country where the bank is based, linked to the branch in the CashBankBranchesLOV lookup table, important for cross-border transactions and legal compliance. |
| BindBankName | String | The name of the bank that operates the branch, linked to the branch within the CashBankBranchesLOV lookup table, used to identify the financial institution. |
| BindBankNumber | String | The bank’s unique identifier number for the branch, used within the CashBankBranchesLOV lookup table to link to specific bank locations. |
| BindBankPartyNumber | String | The unique identifier for the party associated with the bank, used within the CashBankBranchesLOV lookup table to link the branch to the relevant business or legal entity. |
| BindBranchName | String | The name of the branch associated with the bank in the CashBankBranchesLOV lookup table, used to differentiate between different branches within the same institution. |
| BindBranchNumber | String | The unique identifier for the branch within the bank, helping to distinguish between different branches of the same financial institution. |
| BindBranchPartyNumber | String | The unique identifier for the party associated with the branch, linking the branch to the party it represents within the CashBankBranchesLOV lookup table. |
| BindEFTSWIFTCode | String | The SWIFT code used for electronic funds transfers (EFT) for the bank branch, important for international transactions and cross-border payments. |
| Finder | String | A search field in the CashBankBranchesLOV lookup table, used to facilitate quick retrieval of branch data based on key identifiers like name or number. |
| SearchTerm | String | A keyword or term used in the search functionality within the CashBankBranchesLOV lookup table, helping to filter results based on user queries. |
Facilitates lookups for bank information, ensuring valid bank references for payment or receipt processing.
| Name | Type | Description |
| BankName | String | The name of the bank, as used in the CashBanksLOV table for identifying financial institutions. |
| BankNumber | String | The unique bank number assigned to the bank, used within the CashBanksLOV table to differentiate between various financial entities. |
| BankPartyId [KEY] | Long | The unique identifier of the bank party, used to reference the bank's associated entity or account party in the CashBanksLOV table. |
| BindBankName | String | The name of the bank to which the account is bound, included in the CashBanksLOV table for tracking bank-account associations. |
| BindBankNameAlt | String | An alternative name for the bound bank, providing a secondary reference for the bank in the CashBanksLOV table. |
| BindBankNumber | String | The number assigned to the bank account, which is bound in the CashBanksLOV table to ensure accurate financial tracking. |
| BindBankPartyNumber | String | The identifier for the bank party associated with the bound bank, used in the CashBanksLOV table to maintain clarity in party relationships. |
| BindCountryName | String | The name of the country in which the bound bank is located, helping to categorize the bank by region in the CashBanksLOV table. |
| BindDescription | String | A descriptive field used to provide additional context or details about the bound bank within the CashBanksLOV table. |
| BindHomeCountryCode | String | The country code of the bank's home country, used for categorization and compliance purposes within the CashBanksLOV table. |
| BindTaxpayerIdNumber | String | The Tax Indentification Number (TIN) associated with the bound bank, ensuring proper tax reporting and regulatory compliance. |
| Finder | String | A search term or identifier used for locating the relevant bank information within the CashBanksLOV table, typically used in query filtering. |
| SearchTerm | String | A user-defined search term used in the CashBanksLOV to quickly find specific banks or bank accounts based on custom criteria. |
Outlines details of a chart of accounts structure, including segments and hierarchies for robust financial tracking.
| Name | Type | Description |
| Name | String | The name assigned to the ChartOfAccountsLOV table, used for identification within the system and often displayed in user interfaces. |
| Description | String | A detailed description of the ChartOfAccountsLOV table, providing additional context or purpose of the chart for the end-user or system. |
| StructureInstanceId [KEY] | Long | The unique identifier for the structure instance associated with the ChartOfAccountsLOV table, linking the chart to a specific structure instance in the system. |
| StructureInstanceNumber | Long | The number representing the specific instance of the structure within the ChartOfAccountsLOV table, helping to distinguish between multiple instances of similar structures. |
| StructureInstanceCode | String | The code assigned to the structure instance in the ChartOfAccountsLOV table, typically used for reference in queries or reports. |
| EnabledFlag | Bool | A Boolean flag indicating whether the ChartOfAccountsLOV is enabled. When true, it is active and available for use in financial transactions. |
| Finder | String | The finder or search keyword associated with the ChartOfAccountsLOV table, typically used to assist in searching or locating a specific chart in the system. |
| SegmentLabelCodeVar | String | A variable that stores the segment label code for the ChartOfAccountsLOV table, which is used to label and organize segments in the chart of accounts. |
Shows available currency conversion types (for example, Corporate, Spot, User), automatically assigning exchange rates to transactions.
| Name | Type | Description |
| ConversionTypeId [KEY] | String | The unique identifier for the currency conversion type in the CurrencyConversionTypesLOV table, used to reference the specific conversion type within financial transactions. |
| UserConversionType | String | The user-defined conversion type for currencies, representing a customizable option for currency conversions that may differ from the standard conversion types. |
| Description | String | A detailed description of the currency conversion type, providing additional context or notes about how the conversion is applied or the purpose of the type. |
| Finder | String | A reference field used to search and locate specific currency conversion types in the CurrencyConversionTypesLOV table, typically used in search functionalities within the application. |
| SearchTerm | String | A term used in search queries to filter or locate currency conversion types within the CurrencyConversionTypesLOV table, often used to refine user searches in the system. |
Retrieves currency exchange rates for specified dates and currency pairs, informing multi-currency postings and reports.
| Name | Type | Description |
| FromCurrency [KEY] | String | The currency from which the conversion is performed, used in the CurrencyRates table to denote the source currency in exchange rate calculations. |
| ToCurrency | String | The currency to which the conversion is applied, specifying the target currency in the CurrencyRates table for exchange rate purposes. |
| UserConversionType [KEY] | String | Indicates the method or approach used by the user to determine the conversion rate, stored in the CurrencyRates table for tracking custom conversions. |
| ConversionDate [KEY] | Date | The date when the conversion rate is effective, used to record historical rates and ensure accurate currency conversion based on the specified date. |
| ConversionRate | Decimal | The numerical value representing the rate at which one currency can be converted into another, essential for currency conversion calculations in the CurrencyRates table. |
| ConversionType [KEY] | String | Specifies the type of conversion, such as 'spot' or 'forward', indicating the nature of the exchange rate used in the CurrencyRates table. |
| CurrencyConversionType | String | Describes the classification of currency conversion, such as 'manual' or 'automatic', used for tracking how the conversion was applied in the CurrencyRates table. |
| EndDate | String | The end date of the currency rate validity period, marking when a particular conversion rate expires and helping to define the effective range for currency exchange rates. |
| Finder | String | The identifier or method used to search for or locate specific conversion rates within the system, typically used to filter rates in the CurrencyRates table. |
| LedgerName | String | The name of the ledger associated with the currency rates, used in the CurrencyRates table to ensure the correct ledger is linked to the exchange rate data. |
| MaxRollDays | String | The maximum number of days a conversion rate can be rolled over or extended, used to define the period during which a rate can remain valid without re-evaluation. |
| StartDate | String | The start date for the currency conversion rate, used to establish the beginning of the rate’s validity period and track historical exchange rates in the CurrencyRates table. |
Displays customer account site details, linking customers to specific billing or shipping addresses for transaction processing.
| Name | Type | Description |
| CustomerName | String | The name of the customer associated with the account site, used for identification in the CustomerAccountSitesLOV table. |
| AccountNumber | String | The unique account number linked to the customer site, representing the specific financial account within the CustomerAccountSitesLOV table. |
| AccountDescription | String | A description of the account, providing additional context or details regarding the purpose or nature of the financial account in the CustomerAccountSitesLOV table. |
| TaxpayerIdentificationNumber | String | The unique identifier assigned by the tax authority to the customer, used for tax reporting and compliance purposes in the CustomerAccountSitesLOV table. |
| TaxRegistrationNumber | String | The registration number issued by the tax authority, used to track tax-related activities for the customer account in the CustomerAccountSitesLOV table. |
| CustomerAccountId | Long | The unique identifier for the customer account, linking the customer site to the overall customer account within the financial system. |
| PartyNumber | String | The identification number of the party (individual or organization) associated with the customer account site, used for party management and relationship tracking. |
| SiteName | String | The name of the site associated with the customer account, providing a clear label for the specific physical or operational location. |
| PrimarySite | String | A flag or indication of whether this site is the primary location for the customer account, often used for priority or default handling in operations. |
| SiteUseId [KEY] | Long | A unique identifier for the intended use or function of the site, specifying whether it is used for billing, shipping, or another purpose within the CustomerAccountSitesLOV table. |
| SetName | String | The name of the set to which the customer account site belongs, typically used for grouping related sites within a larger organizational structure. |
| Finder | String | An identifier or description of the method used to locate the customer account site, typically for internal search or query operations in the system. |
| SitePurpose | String | The specific purpose or function of the site, such as 'billing', 'shipping', or 'operational', used to categorize and manage customer sites effectively. |
Manages debit authorizations, including creation or updates, allowing users to handle automated debit agreements.
| Name | Type | Description |
| DebitAuthorizationReferenceNumber | String | The unique reference number associated with a debit authorization, used to identify the authorization in related transactions. |
| CustomerBankAccountNumber | String | The bank account number of the customer associated with the debit authorization, important for routing payments or charges. |
| BankName | String | The name of the bank that holds the customer’s account, used for identifying the institution involved in the debit authorization. |
| BankBranchName | String | The name of the specific branch of the bank where the customer's account is maintained, relevant for regional transaction processing. |
| BankAccountCountry | String | The country where the customer’s bank account is held, typically used for cross-border payment processing. |
| BankAccountCurrency | String | The currency in which the customer’s bank account operates, essential for ensuring correct financial transactions in multi-currency environments. |
| IBAN | String | The International Bank Account Number (IBAN) of the customer's bank account, used for international payment transfers. |
| BIC | String | The Bank Identifier Code (BIC) or SWIFT code for the customer's bank, used to route international payments to the correct bank. |
| LegalEntityName | String | The name of the legal entity associated with the debit authorization, often representing the organization responsible for the transaction. |
| CreditorIdentificationNumber | String | The unique identifier assigned to the creditor in a payment transaction, used to validate and authorize the payment request. |
| SigningDate | Date | The date on which the debit authorization was signed, marking the official start of the agreement. |
| CancellationDate | Date | The date when the debit authorization was canceled, ending the agreement and halting any further transactions. |
| TransactionType | String | The type of transaction associated with the debit authorization, such as a one-time payment, recurring payment, or cancellation. |
| Frequency | String | The frequency at which the payments or transactions are authorized, for example, monthly, annually, etc. |
| FinalCollectionDate | Date | The final date on which payments associated with the debit authorization is collected, marking the end of the collection period. |
| AuthorizationMethod | String | The method used to authorize the debit transaction, such as manual, electronic, or through a verified process. |
| VersionNumber | Int | The version number of the debit authorization, indicating updates or changes made to the original authorization agreement. |
| ReasonForAmendment | String | The reason for any amendments or changes made to the debit authorization after its original creation, providing context for updates. |
| EffectiveStartDate [KEY] | Date | The start date from which the debit authorization is effective, determining when payments or transactions should begin. |
| EffectiveEndDate [KEY] | Date | The end date after which the debit authorization is no longer valid, signaling the cessation of the authorization's applicability. |
| DirectDebitCount | Long | The total number of direct debit transactions processed under the authorization, reflecting the volume of payments initiated. |
| PrimaryIndicator | String | Indicates whether this is the primary authorization for the customer’s direct debit, marking it as the main source for payment processing. |
| Status | String | The current status of the debit authorization, such as active, canceled, pending, or expired, providing insight into the authorization's validity. |
| DebitAuthorizationId [KEY] | Long | The unique identifier for the debit authorization, used to reference and manage the specific authorization record in the system. |
| CustomerPartyIdentifier | Long | The unique identifier for the customer party involved in the debit authorization, linking the authorization to a specific customer in the system. |
| CustomerPartyNumber | String | A unique number assigned to the customer party for identification within the financial system, used for referencing the party in transactions. |
| CustomerPartyName | String | The full name of the customer party involved in the debit authorization, providing clarity on which party is responsible for the transaction. |
| CustomerBankAccountIdentifier | Long | The unique identifier for the customer’s bank account within the system, used to link the authorization to a specific account. |
| LegalEntityIdentifier | Long | The unique identifier for the legal entity associated with the debit authorization, used for organizational and legal purposes in transactions. |
| Finder | String | A search tool or keyword used for locating specific debit authorizations within the system based on defined criteria. |
| SysEffectiveDate | String | The system effective date that denotes when the data is considered valid within the financial system, used for system processing and reporting. |
| EffectiveDate | Date | A query parameter used to fetch resources that are effective as of the specified start date, ensuring only relevant data is retrieved. |
Tracks version history of debit authorizations, ensuring an audit trail of any modifications made to authorization terms.
| Name | Type | Description |
| DebitAuthorizationsDebitAuthorizationId [KEY] | Long | The unique identifier for each debit authorization within the Debit Authorizations table, used to track specific authorization records across versions. |
| DebitAuthorizationsEffectiveEndDate [KEY] | Date | The end date for the effective period of a debit authorization record, indicating when the authorization is no longer valid. |
| DebitAuthorizationsEffectiveStartDate [KEY] | Date | The start date for the effective period of a debit authorization record, signifying when the authorization becomes valid. |
| DebitAuthorizationId [KEY] | Long | The identifier for a debit authorization, linking to the corresponding entry in the Debit Authorizations table, used to track authorization details. |
| EffectiveStartDate | Date | The start date marking the beginning of the debit authorization's effective period, helping to define its active status. |
| EffectiveEndDate | Date | The end date marking the conclusion of the debit authorization's effective period, after which the authorization is no longer applicable. |
| DebitAuthorizationReferenceNumber | String | A unique reference number associated with a debit authorization, typically used to cross-reference with external systems or documentation. |
| VersionNumber [KEY] | Int | The version number of the debit authorization record, allowing tracking of amendments and revisions to the original authorization. |
| CreditorIdentificationNumber | String | The identification number assigned to the creditor involved in the debit authorization, used to verify the creditor's identity within the system. |
| LegalEntityName | String | The name of the legal entity associated with the debit authorization, important for legal and compliance tracking. |
| CustomerBankAccountNumber | String | The bank account number of the customer for which the debit authorization is created, used for processing payments or withdrawals. |
| IBAN | String | The International Bank Account Number (IBAN) associated with the customer’s bank account, used for international transactions. |
| CutomerBankAccountIdentifier | Long | A unique identifier for the customer’s bank account, linking it to the debit authorization record for specific processing. |
| ReasonForAmendment | String | The reason for any amendments made to the debit authorization, providing context for changes to the authorization records. |
| DirectDebitCount | Long | The number of direct debit transactions associated with a given debit authorization, providing insight into its usage. |
| CustomerBankAccountIdentifier | Long | An identifier for the customer’s bank account, used for referencing customer accounts in relation to debit authorizations. |
| CustomerPartyIdentifier | Long | A unique identifier for the customer party, linking the debit authorization to a specific customer or entity within the system. |
| CustomerPartyName | String | The name of the customer party associated with the debit authorization, important for identifying the relevant customer. |
| CustomerPartyNumber | String | The number assigned to the customer party, often used in external systems for identifying the customer or organization. |
| Finder | String | A search or reference term used for locating specific records related to a debit authorization or customer party within the system. |
| LegalEntityIdentifier | Long | A unique identifier for the legal entity, linking the debit authorization to a specific entity within the legal structure. |
| SysEffectiveDate | String | The system's effective date, indicating when the record or transaction becomes valid according to the internal system rules. |
| EffectiveDate | Date | The effective date parameter used to fetch records that are valid as of a specific start date, ensuring that only relevant records are returned. |
Queries valid disbursement payment methods (for example, check, EFT), ensuring payment configuration aligns with organizational rules.
| Name | Type | Description |
| PaymentMethodCode [KEY] | String | The code used to identify the payment method in the DisbursementPaymentMethodsLOV table, used to specify how payments is processed. |
| PaymentMethodName | String | The name associated with the payment method in the DisbursementPaymentMethods LOV table, providing a human-readable identifier for the payment method. |
| PaymentMethodDescription | String | A description of the payment method in the DisbursementPaymentMethods LOV table, detailing the features or purpose of the payment method. |
| BillsPayablePaymentMethodIndicator | String | Indicates whether the payment method can be used for bills payable, as identified in the DisbursementPaymentMethods LOV table. |
| MaturityDateOverride | Long | The overridden maturity date associated with the payment method, allowing adjustments to the default maturity date within the DisbursementPaymentMethods LOV table. |
| ApplicationId | Long | The unique identifier for the application related to the payment method, typically used to link the payment method to a specific financial application. |
| AutoPayeeAssignIndicator | String | Indicates whether the system should automatically assign payees when processing payments, as set in the DisbursementPaymentMethods LOV table. |
| Finder | String | A search term or identifier used to find specific payment methods within the DisbursementPaymentMethods LOV table, assisting in quick identification of methods. |
| PayeePartyId | Long | The identifier of the payee party associated with the payment method, linking the payment to the party receiving the payment. |
| PayeePartySiteId | Long | The unique identifier of the payee party site, which corresponds to the location or site where the payee's payment details are stored. |
| PayerLegalEntityId | Long | The unique identifier for the legal entity of the payer in the payment process, representing the entity responsible for making the payment. |
| PayerOrganizationId | Long | The identifier for the payer organization associated with the payment method, used to link payments to the organization making the disbursement. |
| PayerPayingOrgType | String | The type of organization making the payment, indicating whether the payer is a business entity, government agency, or other organization within the DisbursementPaymentMethods LOV table. |
| PaymentCurrencyCode | String | The currency code used for the payment, specifying the currency in which the payment is made according to the DisbursementPaymentMethods LOV table. |
| PaymentFunction | String | The function or role of the payment within the process, such as whether it is for a refund, disbursement, or other financial transaction type. |
| PayProcTrxnTypeCode | String | The code that defines the transaction type for the payment process, used to categorize payments within the DisbursementPaymentMethods LOV table. |
| SupplierSiteId | Long | The identifier of the supplier's site where payments is processed, linking the supplier's location to the payment method. |
Stores or updates status for business events that trigger processes like approvals or notifications in ERP workflows.
| Name | Type | Description |
| BusinessEventCode | String | The unique code representing the type of business event within Oracle Financials Cloud, used to classify and identify events in the system. |
| BusinessEventIdentifier | String | A unique identifier for each business event instance, ensuring distinct tracking of events across the system. |
| CreatedBy | String | The user or system entity responsible for creating the business event record, helping to trace the origin of the event. |
| CreationDate | Datetime | The timestamp indicating when the business event was created in the system, useful for audit and event lifecycle tracking. |
| EnabledFlag | Bool | A flag that indicates whether the business event is active and enabled in the system. A value of true means the event is enabled, and false means it is disabled. |
| LastUpdateDate | Datetime | The timestamp of the last update made to the business event record, reflecting the most recent change to the event. |
| LastUpdateLogin | String | The login identifier of the user who last updated the business event record, providing accountability for modifications. |
| LastUpdatedBy | String | The name or identifier of the user who made the last update to the business event record, helping to trace changes. |
| ErpBusinessEventId [KEY] | Long | The unique numerical identifier for each business event, ensuring the event can be reliably referenced and retrieved across related processes. |
| Finder | String | The search or filter identifier associated with the business event, allowing users to efficiently locate and interact with specific event records. |
Automates bulk data import/export with configurable callbacks and error notifications, streamlining integration tasks.
| Name | Type | Description |
| OperationName [KEY] | String | The name of the specific ERP Integration Service operation that is responsible for managing the inbound and outbound data flows, defining the type of interaction between the system and external sources. |
| DocumentId | String | A unique identifier for a file associated with a specific row in the system, used to track the document throughout its lifecycle in the ERP system. |
| DocumentContent | String | The actual content of the document, encoded in Base64 format for efficient transmission and storage within the system. |
| FileName | String | The name of the data file that is to be processed by the ERP Integration Service operation, typically indicating its contents or source. |
| ContentType | String | Specifies the type of content contained within the data file, providing context for the ERP Integration Service operation to determine how to process the file. |
| FileType | String | Defines the file type for determining which specific data or logs to download. Options include 'LOG' for log files, 'OUT' for output files, or no type specified to download both. |
| DocumentAccount | String | The account parameter used to search for files related to a particular security account within the ERP system, facilitating targeted searches for relevant data. |
| Comments | String | A field for appending additional comments to a file, used for documentation or providing context during processing. |
| ProcessName | String | The name of a specific business application’s data import process, which orchestrates the import of data from external sources into the system. |
| LoadRequestId | String | The unique identifier assigned to the load request that populates data into the product interface table, ensuring traceability of the data import process. |
| JobPackageName | String | The name of the job package within the Enterprise Scheduling Service that needs to be submitted to execute the scheduled job or task. |
| JobDefName | String | The name of the job definition in the Enterprise Scheduling Service job, detailing the specific job to be executed based on predefined parameters. |
| ReqstId | String | The unique identifier for the submitted job request within the Enterprise Scheduling Service, used to track the job throughout its lifecycle. |
| RequestStatus | String | Represents the current status of the Enterprise Scheduling Service job, such as 'pending', 'running', or 'completed', providing visibility into job progress. |
| JobName | String | The name of the job and the associated job package, separated by a comma, used to identify both the job and the package it belongs to. |
| ParameterList | String | A list of parameters required to execute the Enterprise Scheduling Service job. This list determines the order of the parameters, with blank entries for any parameters that are not passed. |
| NotificationCode | String | A two-digit code that defines the notification type and its timing, used to trigger notifications for specific operations like loadAndImportData or ExportBulkData. |
| CallbackURL | String | The URL where the ERP system sends job status updates upon completion, allowing external systems or services to track the job's outcome. |
| JobOptions | String | An input parameter for web service operations, specifying the variation of inbound bulk data processing and the type of output file generated after data processing. |
| StatusCode | String | A code representing the current status of the Enterprise Scheduling Service job, offering an indication of success, failure, or pending status. |
| ESSParameters | String | A list of parameters used to run the Enterprise Scheduling Service job, with each entry corresponding to a specific job parameter. Blank entries are used for parameters that are not provided. |
| Comment | String | A field for adding comments or notes related to the ERP integration, providing additional context for operations or troubleshooting. |
| DocAccount | String | An account identifier used in ERP integrations, associated with the specific document, facilitating searches and categorization of documents. |
| DocId | String | A unique identifier for a document in the ERP integration system, ensuring that the correct document is processed and tracked across operations. |
| FilePrefix | String | A prefix used to identify the file during integration operations, typically representing the type or source of the file for easier identification. |
| Finder | String | A field used to identify the search criteria or mechanism for locating specific ERP integrations, aiding in efficient querying and data retrieval. |
| RequestId | String | A unique identifier for the integration request, ensuring that the request is tracked and processed within the system for proper handling and completion. |
Defines accommodations-related expense rules, specifying reimbursement rates, limits, or eligibility for lodging costs.
| Name | Type | Description |
| AccommodationsPolicyId [KEY] | Long | The unique identifier for the accommodation policy within the ExpenseAccommodationsPolicies table, used to reference a specific policy. |
| PolicyName | String | The name of the accommodation policy, which describes the general terms and conditions for expense accommodations. |
| Description | String | A detailed description of the accommodation policy, providing additional context or rules governing its application. |
| StatusCode | String | The code representing the current status of the accommodation policy, such as 'Active' or 'Inactive.' |
| Status | String | A textual representation of the accommodation policy's status, reflecting whether it is currently enabled or disabled. |
| CurrencyOptionCode | String | A code representing the chosen currency option for the accommodation policy, determining how currency is handled in related transactions. |
| CurrencyOption | String | A textual description of the currency option selected for the accommodation policy, such as 'Local' or 'Foreign.' |
| CurrencyCode | String | The code of the currency associated with the accommodation policy, typically using ISO 4217 standards (for example, USD). |
| Currency | String | The name of the currency used in the accommodation policy, such as USD or EUR. |
| EnabledSeasonRateFlag | Bool | A flag indicating whether season-specific rates are enabled for the accommodation policy. When true, season rates are applied. |
| EnabledRoleFlag | Bool | A flag that determines if role-based rules are applied within the accommodation policy. If true, different roles may have different accommodation rules. |
| PolicyRoleCode | String | A code representing the role-specific rules within the accommodation policy, defining which roles are eligible for specific accommodations. |
| PolicyRole | String | A description of the role within the accommodation policy, such as 'Manager' or 'Employee,' which may influence the applicability of the policy. |
| EnabledLocationFlag | Bool | A flag indicating whether the accommodation policy is location-specific. If true, the policy applies only to specific locations. |
| LocationTypeCode | String | A code identifying the type of location where the accommodation policy is applicable, such as 'Office' or 'Conference Room.' |
| LocationType | String | The type of location to which the accommodation policy applies, providing more details about where it is enforced. |
| ZoneTypeCode | String | A code representing the type of zone, such as 'Domestic' or 'International,' that is relevant to the accommodation policy. |
| ZoneType | String | A textual description of the zone type, categorizing the geographic or operational zones where the accommodation policy is enforced. |
| PolicyEnforcementCode | String | A code indicating how the accommodation policy is enforced, such as 'Strict' or 'Flexible,' defining the policy's enforcement rigor. |
| PolicyEnforcement | String | A description of how the accommodation policy is enforced, providing more details about the level of compliance expected. |
| PolicyViolationFlag | Bool | A flag that indicates whether violations of the accommodation policy are flagged. If true, violations trigger alerts or actions. |
| WarningTolerance | Decimal | The threshold for warning users about potential violations of the accommodation policy, expressed as a decimal percentage. |
| DispWarningToUserFlag | Bool | A flag indicating whether warnings about policy violations should be displayed to the user during processing. |
| PreventSubmissionFlag | Bool | A flag that, when set to true, prevents the submission of a request if it violates the accommodation policy. |
| ErrorTolerance | Decimal | The allowable error tolerance for policy violations, specified as a decimal percentage before enforcement actions are triggered. |
| CreationDate | Datetime | The date and time when the accommodation policy was created, used for tracking the policy's history. |
| CreatedBy | String | The name or identifier of the user who created the accommodation policy, helping track ownership and responsibility. |
| LastUpdateDate | Datetime | The date and time when the accommodation policy was last updated, providing insight into the policy's current state. |
| LastUpdatedBy | String | The name or identifier of the user who last updated the accommodation policy, helping track who modified the policy. |
| LastUpdateLogin | String | The login ID of the user who last updated the accommodation policy, assisting with audit and tracking of changes. |
| EnabledGenderFlag | Bool | A flag that indicates whether the accommodation policy includes gender-based rules or allowances. If true, gender-based settings are considered. |
| Finder | String | A specific identifier or code used to search for or locate accommodation policies within the system, assisting with query and retrieval. |
Stores line-level policy details for accommodations expense rules, including thresholds and specific lodging policy items.
| Name | Type | Description |
| ExpenseAccommodationsPoliciesAccommodationsPolicyId [KEY] | Long | The unique identifier for the accommodations policy in the ExpenseAccommodationsPolicies table, used to link to individual expense accommodation policy lines. |
| PolicyLineId [KEY] | Long | The unique identifier for a policy line within the accommodations policy, referencing the specific expense accommodation line associated with this policy. |
| AccommodationsPolicyId | Long | The identifier for the accommodation policy, used to associate a particular policy with its related expense accommodation details. |
| TypeOfRateCode | String | A code indicating the type of rate applied to the accommodation, such as a standard rate, discounted rate, or negotiated rate. |
| DailyLimit | Decimal | The maximum allowable daily expense amount for accommodations, set as part of the policy guidelines for expense management. |
| CurrencyCode | String | The ISO code for the currency used in the accommodations policy, indicating the currency in which the limits and expenses are calculated. |
| Currency | String | The name of the currency used in the accommodation policy (for example, USD, EUR). |
| StartDate | Date | The date when the accommodation policy becomes effective, marking the beginning of its validity period. |
| EndDate | Date | The date when the accommodation policy expires, indicating the end of the policy's validity period. |
| RoleId | Long | The unique identifier for the role associated with the accommodation policy, specifying which user or role is linked to the policy. |
| RoleName | String | The name of the role linked to the accommodation policy, typically representing a user role such as 'Manager' or 'Employee'. |
| GeographyId | Long | The unique identifier for the geographic location associated with the accommodation policy, which can link to a specific region or area. |
| ZoneCode | String | A code representing the geographical zone where the accommodation policy applies, typically used to group locations by regions or zones. |
| Zone | String | The name of the geographical zone to which the accommodation policy applies, often used to specify areas like North America or Europe. |
| GeolocName | String | The name of the geographical location (for example, city or region) where the accommodation policy is applicable, used for location-specific policies. |
| RawCountry | String | The raw country name as provided in the accommodation policy, which may need further processing or standardization. |
| RawState | String | The raw state or province name associated with the accommodation policy, potentially subject to formatting or normalization. |
| RawCounty | String | The raw county or district name where the accommodation policy applies, typically subject to further refinement for consistency. |
| RawCity | String | The raw city name associated with the accommodation policy, which may require additional processing for uniformity. |
| SeasonStartMonth | Int | The month when the accommodation policy's season starts, defining the period during which specific rates or limits apply. |
| SeasonStartDay | Int | The day of the month when the accommodation policy's season begins, providing the exact start date for seasonal rate changes. |
| SeasonEndMonth | Int | The month when the accommodation policy's season ends, marking the conclusion of the applicable seasonal rates or limits. |
| SeasonEndDay | Int | The day of the month when the accommodation policy's season concludes, specifying the end date for seasonal accommodations. |
| StatusCode | String | A code that represents the current status of the accommodation policy, such as 'Active', 'Inactive', or 'Suspended'. |
| Status | String | A textual description of the current status of the accommodation policy, providing context such as 'Policy Active' or 'Policy Expired'. |
| CreationDate | Datetime | The date and time when the accommodation policy was first created in the system, used for tracking its lifecycle. |
| CreatedBy | String | The name or ID of the user who created the accommodation policy, allowing for tracking of user actions in policy creation. |
| LastUpdateDate | Datetime | The date and time when the accommodation policy was last updated, providing information on the most recent modification. |
| LastUpdatedBy | String | The name or ID of the user who last updated the accommodation policy, used for auditing purposes and tracking changes. |
| LastUpdateLogin | String | The login identifier of the user who made the last update to the accommodation policy, assisting in security and access auditing. |
| Finder | String | The identifier or description used to locate or filter accommodation policies, providing a means for quick searching and referencing. |
Defines airfare-related expense rules and eligibility criteria, specifying permitted costs and class restrictions for business travel.
| Name | Type | Description |
| AirfarePolicyId [KEY] | Long | The unique identifier for each airfare policy in the ExpenseAirfarePolicies table. |
| ObjectVersionNumber | Int | Indicates the version number of the airfare policy, used for concurrency control in updates. |
| PolicyName | String | The name assigned to the airfare policy, which can be used to distinguish it from other policies. |
| Description | String | A detailed description of the airfare policy, providing context and rules related to the policy's use. |
| EnabledRoleFlag | Bool | A flag that indicates whether the role associated with this policy is enabled or not. |
| PolicyRoleCode | String | The unique code representing the role that is assigned to this airfare policy. |
| EnabledFlightTypeFlag | Bool | A flag indicating whether this airfare policy applies to specific flight types, such as economy or business class. |
| EnabledFlightDurationFlag | Bool | A flag indicating whether this airfare policy considers the duration of flights for determining eligibility. |
| FlightDurationCode | String | The code representing the flight duration range (for example, short, medium, long) that this policy applies to. |
| PolicyEnforcementCode | String | A code that specifies how the policy is enforced, such as automated checks or manual approval. |
| DispWarningToUserFlag | Bool | A flag indicating whether users will receive a warning if they try to make a booking that violates this policy. |
| CreationDate | Datetime | The date and time when this airfare policy was first created in the system. |
| CreatedBy | String | The user who initially created this airfare policy in the system. |
| LastUpdateDate | Datetime | The date and time when this airfare policy was last updated. |
| LastUpdatedBy | String | The user who last updated this airfare policy. |
| LastUpdateLogin | String | The login session ID of the user who last updated this airfare policy. |
| Status | String | The current status of the airfare policy, such as active, inactive, or archived. |
| StatusCode | String | A code representing the specific status of the airfare policy. |
| PolicyEnforcement | String | The mechanism used to enforce the policy, such as approval workflows or automated restrictions. |
| PolicyRole | String | The role associated with the airfare policy, determining which users or departments are subject to its rules. |
| Finder | String | A search term or identifier that is used to find specific airfare policies in the system. |
Provides detailed line items for airfare policy rules, including maximum limits, exceptions, and additional fare conditions.
| Name | Type | Description |
| ExpenseAirfarePoliciesAirfarePolicyId [KEY] | Long | The unique identifier for the airfare policy in the ExpenseAirfarePolicies table, used to link related entries in the expense management system. |
| PolicyLineId [KEY] | Long | The unique identifier for the policy line in the ExpenseAirfarePolicies table, specifying individual rules or configurations within an airfare policy. |
| ObjectVersionNumber | Int | The version number of the object, used for concurrency control to manage changes and ensure data consistency in the ExpenseAirfarePolicies table. |
| AirfarePolicyId | Long | The identifier for the specific airfare policy linked to the expense, used to track which policy governs a particular set of airfare rules. |
| TypeOfRateCode | String | The code that defines the type of rate applied to the airfare, helping to classify rates such as standard or discounted for different policy types. |
| FlightClassCode | String | The code that specifies the class of flight, indicating whether it’s economy, business, or first class, to be used in conjunction with travel policies. |
| FlightClassCodeDomestic | String | The code for the class of flight for domestic travel, used to differentiate between domestic and international travel policy rules. |
| FlightClassCodeInternat | String | The code for the class of flight for international travel, specifically identifying travel policies for flights crossing international borders. |
| StartDate | Date | The start date for the application of this airfare policy line, indicating when the policy or rule becomes effective. |
| EndDate | Date | The end date for the application of this airfare policy line, marking when the policy or rule will no longer be applicable. |
| RoleId | Long | The unique identifier for the role associated with this airfare policy line, used to specify the position or responsibility tied to the policy. |
| RoleName | String | The name of the role linked to the airfare policy line, helping to identify which employees or departments are subject to the policy. |
| FlightDurationThreshold | Decimal | The threshold value for flight duration, used to determine applicable policies based on how long a flight lasts (for example, domestic vs international). |
| InvalidCode | String | The code indicating whether the airfare policy line is invalid, typically used for deactivated or obsolete policies. |
| CreationDate | Datetime | The date and time when the airfare policy line was created, providing an audit trail for policy changes. |
| CreatedBy | String | The user or system that created the airfare policy line, providing accountability for policy creation. |
| LastUpdateDate | Datetime | The most recent date and time the airfare policy line was updated, reflecting changes to the policy or its terms. |
| LastUpdatedBy | String | The user or system that last updated the airfare policy line, enabling tracking of modifications for auditing purposes. |
| LastUpdateLogin | String | The login identifier of the user or system responsible for the last update to the airfare policy line, assisting in identifying changes. |
| Invalid | String | Indicates whether the airfare policy line is marked as invalid, which could signal deactivation or removal from active use. |
| Status | String | The current status of the airfare policy line, such as active, pending, or expired, indicating whether it is in use or not. |
| StatusCode | String | The code representing the specific status of the airfare policy line, providing a standardized way to categorize the policy's current state. |
| Finder | String | A unique identifier used in the Finder function to search and retrieve specific airfare policy lines in the system based on set criteria. |
Tracks employee cash advances for travel or business-related expenses, capturing key data such as status, requested amounts, and repayment details.
| Name | Type | Description |
| AdjustedAmount | Decimal | Amount specified by an auditor during an audit, used to reflect any adjustments made to the initial cash advance amount. |
| AdvanceStatus | String | Status of the cash advance, indicating its current stage or approval status. References the lookup type EXM_CASH_ADVANCE_STATUS for predefined values. |
| Amount | Decimal | Total amount of the cash advance requested by the employee, before any adjustments or payments. |
| AssignmentId | Long | Unique identifier for the assignment associated with the employee's request for a cash advance, used to track the specific job or role. |
| BusinessUnit | String | The business unit associated with the cash advance, representing the organizational segment responsible for the cash advance request. |
| CashAdvanceId [KEY] | Long | Unique identifier for a cash advance transaction, allowing the system to reference and track specific advance records. |
| CashAdvanceNumber | String | A unique number assigned to each cash advance to facilitate identification and tracking of the transaction. |
| CashAdvanceType | String | Type of cash advance requested. The default value is TRAVEL, with additional types defined in the lookup type EXM_CASH_ADVANCE_TYPE. |
| CreatedBy | String | The user who initially created the cash advance record, providing accountability and audit tracking. |
| CreationDate | Datetime | The date and time when the cash advance record was created, useful for tracking the history of the record. |
| Currency | String | The currency in which the cash advance is requested, indicating the monetary unit for the transaction. |
| CurrencyCode | String | The standardized code representing the currency of the cash advance (for example, USD, EUR). |
| EmployeeNumber | String | The unique employee number associated with the individual requesting the cash advance, used for payroll and Human Resources (HR) records. |
| ExchangeRate | Decimal | The exchange rate applied when converting the cash advance amount into a different currency, if applicable. |
| LastUpdateDate | Datetime | The date and time when the cash advance record was last updated, tracking changes or amendments to the record. |
| LastUpdateLogin | String | The session login identifier for the user who last modified the cash advance record, providing traceability of changes. |
| LastUpdatedBy | String | The user who made the last update to the cash advance record, enabling accountability for modifications. |
| Location | String | The geographic location related to the upcoming trip, used to associate the cash advance with a specific travel destination. |
| PaymentAmount | Decimal | The actual amount paid to the employee as part of the cash advance, after any necessary deductions or adjustments. |
| PaymentCurrency | String | The currency used for the payment made to the employee for the cash advance. |
| PaymentCurrencyCode | String | The code representing the currency used for the cash advance payment (for example, USD, GBP for British Pound). |
| PaymentMethodCode | String | The code indicating the payment method used to disburse the cash advance (for example, Direct Deposit, Check). |
| PersonId | Long | Unique identifier for the person requesting the cash advance, linking the request to their employee or contractor profile. |
| PersonName | String | Full name of the employee or contractor requesting the cash advance, used for identification purposes. |
| Purpose | String | A brief description of the purpose or reason for the cash advance, providing context for the request (for example, travel, office supplies). |
| SettlementDate | Date | The date when the cash advance is to be applied to an employee's expense report, ensuring proper reconciliation of funds. |
| StatusCode | String | A code representing the current status of the cash advance, such as Pending, Approved, or Paid, helping track its progress. |
| SubmittedDate | Date | The date when the cash advance was submitted for approval or processing, providing a timeline for the request. |
| TripEndDate | Date | The date when the trip associated with the cash advance is scheduled to end, helping track travel-related expenses. |
| TripId | Long | Unique identifier for the trip linked to the cash advance, allowing for better management of travel-related financials. |
| TripStartDate | Date | The date when the trip associated with the cash advance begins, serving as a reference point for travel expenses. |
| UnappliedAmount | Decimal | The remaining balance of the cash advance that has not yet been applied to an employee's expense report. |
| Description | String | A textual description of the cash advance, providing further details or context about the request. |
| SequoiaAdvanceStatus | String | The status of the Sequoia advance associated with the cash advance, tracking its specific workflow or approval process. |
| SequoiaStatusCode | String | A code that indicates the Sequoia status related to the cash advance, helping to monitor its integration with other systems. |
| Finder | String | A keyword or identifier used in searches related to cash advances or financial records, assisting in query filtering. |
| EffectiveDate | Date | A parameter used to fetch resources that are effective as of a specified start date, ensuring data is current as per business requirements. |
Enables document uploads and management (for example, receipts or justifications) for recorded cash advances.
| Name | Type | Description |
| ExpenseCashAdvancesCashAdvanceId [KEY] | Long | The unique identifier assigned to each cash advance record, used to track and reference cash advances within the system. |
| AttachedDocumentId [KEY] | Long | The identifier for the document attached to the cash advance record, enabling linkage to relevant documentation. |
| LastUpdateDate | Datetime | The timestamp indicating the most recent date and time the record was updated, providing an audit trail for changes. |
| LastUpdatedBy | String | The username of the individual who last modified the record, ensuring traceability of updates. |
| DatatypeCode | String | A code that specifies the type of data, helping to categorize and validate the information stored in the record. |
| FileName | String | The name of the file attached to the record, providing an easy way to identify and reference the file. |
| DmFolderPath | String | The path to the folder where the attachment is stored, assisting in locating and managing document storage locations. |
| DmDocumentId | String | The document identifier linked to the attachment, used to reference the source document within the document management system. |
| DmVersionNumber | String | The version number of the document from which the attachment was created, ensuring version control and consistency in document management. |
| Url | String | The URL representing the web link to the attached resource, used when the attachment is a web-based resource. |
| CategoryName | String | The classification or category of the attachment, helping to organize and filter attachments based on their type. |
| UserName | String | The login credentials of the user who uploaded or created the attachment, enabling user accountability. |
| Uri | String | The URI of the attachment when the source is related to Topology Manager, providing a reference link to the specific resource. |
| FileUrl | String | The complete URL pointing directly to the file, used for direct access or download of the attachment. |
| UploadedText | String | The text content for a new text-based attachment, capturing non-binary data such as notes or descriptions in an attachment. |
| UploadedFileContentType | String | The content type of the uploaded file, helping to categorize the file type. |
| UploadedFileLength | Long | The size, in bytes, of the uploaded file, used for managing storage and handling file transfer limits. |
| UploadedFileName | String | The desired name assigned to the uploaded file, which may differ from the original file name for internal organization. |
| ContentRepositoryFileShared | Bool | A Boolean flag indicating whether the file is shared across multiple users or systems, impacting access permissions. |
| Title | String | The title or name of the attachment, providing a brief and descriptive label for easy identification. |
| Description | String | A detailed description of the attachment, offering context or additional information about the content of the attachment. |
| ErrorStatusCode | String | The error code, if applicable, providing a numeric or alphanumeric identifier for any issues encountered during the attachment process. |
| ErrorStatusMessage | String | The error message, if applicable, offering a textual explanation of the issues or failures encountered during the attachment process. |
| CreatedBy | String | The username of the user who created the record, enabling identification of the originator of the record. |
| CreationDate | Datetime | The date and time when the record was initially created, offering a historical reference for when the data was first entered into the system. |
| FileContents | String | The actual contents of the attachment when the file is a text-based resource, representing the data included in the attachment. |
| ExpirationDate | Datetime | The expiration date for the attachment content, indicating when the file or document is no longer valid or accessible. |
| LastUpdatedByUserName | String | The username of the person who last updated the record, ensuring proper tracking of changes. |
| CreatedByUserName | String | The username of the person who created the record, providing accountability for initial data entry. |
| AsyncTrackerId | String | A unique identifier for tracking the status of asynchronous file uploads, aiding in managing the upload process. |
| FileWebImage | String | A Base64-encoded representation of the file's image in .png format, displayed when the attachment is a convertible image. |
| DownloadInfo | String | A JSON-formatted string containing metadata and instructions needed to programmatically download the file attachment. |
| PostProcessingAction | String | The action to be performed on the attachment after it is uploaded, such as indexing or sending for review. |
| CashAdvanceId | Long | The unique identifier for the cash advance record, used to reference a specific cash advance transaction within the system. |
| Finder | String | A search parameter that helps filter or locate specific records based on a defined criteria, such as a name, code, or reference number. |
| EffectiveDate | Date | The date on which the resource or record becomes effective. This parameter is used to fetch records that are valid as of the specified date, ensuring the selection of up-to-date data. |
Offers descriptive flexfields for adding custom attributes to cash advance records, supporting unique organizational needs.
| Name | Type | Description |
| ExpenseCashAdvancesCashAdvanceId [KEY] | Long | The unique identifier for the cash advance record, used to reference individual cash advances within the ExpenseCashAdvances table. |
| CashAdvanceId [KEY] | Long | The identifier that links the cash advance record to the related data in the ExpenseCashAdvancesCashAdvanceDff table, providing a reference for additional details. |
| _FLEX_Context | String | The context value associated with the cash advance in the ExpenseCashAdvancesCashAdvanceDff table, typically used for flexible data management or metadata. |
| _FLEX_Context_DisplayValue | String | A display-friendly version of the context value from the _FLEX_Context column, intended for user-facing interfaces or reports. |
| Finder | String | A generic term used to describe a search or filter parameter, potentially used to identify or locate specific cash advance records in queries or reports. |
| EffectiveDate | Date | A date value used to fetch cash advance records that are effective as of the specified date, helping ensure the accuracy of time-sensitive data retrieval. |
Establishes expense-specific conversion rate policies for multiple currencies, ensuring correct reimbursement calculations.
| Name | Type | Description |
| ConversionRateId [KEY] | Long | The unique identifier for the conversion rate in the ExpenseConversionRateOptions table, used to distinguish different conversion rate records. |
| CreatedBy | String | The user or system responsible for creating the record in the ExpenseConversionRateOptions table, providing auditability of data creation. |
| CreationDate | Datetime | The date and time when the record in the ExpenseConversionRateOptions table was created, used for tracking the creation timeline. |
| DefaultConversionRateFlag | Bool | A flag indicating whether the conversion rate is the default one for the given business unit or expense type, influencing automatic rate selection. |
| DisplayWarningToUser | String | A message or instruction displayed to the user, alerting them of important details or actions related to the expense conversion rate. |
| ErrorTolerance | Decimal | The acceptable margin of error when applying the conversion rate to expenses, ensuring calculations are within a defined range of accuracy. |
| ConversionRateType | String | The type of conversion rate (for example, fixed, dynamic) used in the ExpenseConversionRateOptions, specifying the method for calculating expense conversions. |
| LastUpdateDate | Datetime | The date and time when the record in the ExpenseConversionRateOptions table was last updated, useful for tracking changes to the conversion rate configuration. |
| LastUpdateLogin | String | The login ID of the user who last updated the record in the ExpenseConversionRateOptions table, providing accountability for changes. |
| LastUpdatedBy | String | The name or ID of the user who last modified the record in the ExpenseConversionRateOptions table, allowing for audit and tracking of updates. |
| WarningTolerance | Decimal | The threshold at which a warning is triggered when the expense conversion exceeds an acceptable tolerance level, helping to catch potential errors. |
| BusinessUnit | String | The business unit associated with the conversion rate, enabling the system to apply specific rates based on organizational structure or financial requirements. |
| Finder | String | A search identifier or criteria used within the ExpenseConversionRateOptions table, helping users or the system locate relevant conversion rate records quickly. |
Defines allowable variances in currency conversion rates for certain currencies or business units, supporting exceptions in expense reimbursements.
| Name | Type | Description |
| ExpenseConversionRateOptionsConversionRateId [KEY] | Long | The unique identifier for the conversion rate option associated with a specific tolerance in the ExpenseConversionRateOptions conversion rate tolerance table. |
| ConversionRateToleranceId [KEY] | Long | The unique identifier for the tolerance rule applied to the conversion rate in the ExpenseConversionRateOptions conversion-rate tolerance table. |
| CreatedBy | String | The user or system responsible for creating the record in the ExpenseConversionRateOptions conversion-rate tolerance table. |
| CreationDate | Datetime | The date and time when the record was created in the ExpenseConversionRateOptions conversion-rate tolerance table. |
| CurrencyCode | String | The code representing the currency for which the conversion rate tolerance is defined in the ExpenseConversionRateOptions table. |
| DefaultConversionRateFlag | Bool | A flag indicating whether this conversion rate is the default for the specified tolerance in the ExpenseConversionRateOptions table (true if default). |
| DisplayWarningToUser | String | A message or instruction to display to the user when the conversion rate tolerance is exceeded in the ExpenseConversionRateOptions table. |
| ErrorTolerance | Decimal | The threshold value for error tolerance, defining the acceptable deviation from the expected conversion rate in the ExpenseConversionRateOptions table. |
| ConversionRateId | Long | The unique identifier for the conversion rate that is being applied in the ExpenseConversionRateOptions conversion-rate tolerance table. |
| LastUpdateDate | Datetime | The date and time when the record was last updated in the ExpenseConversionRateOptions conversion-rate tolerance table. |
| LastUpdateLogin | String | The login identifier of the user or system that last updated the record in the ExpenseConversionRateOptions conversion-rate tolerance table. |
| LastUpdatedBy | String | The name or identifier of the user or system that last updated the record in the ExpenseConversionRateOptions conversion-rate tolerance table. |
| WarningTolerance | Decimal | The threshold value for warning tolerance, defining the acceptable range before triggering a warning to the user in the ExpenseConversionRateOptions table. |
| Currency | String | The currency being considered in the ExpenseConversionRateOptions conversion-rate tolerance table, used to determine applicable conversion rates. |
| Finder | String | An identifier or reference used to locate specific records or sets of records within the ExpenseConversionRateOptions conversion-rate tolerance table. |
Captures corporate card transaction data (dates, amounts, merchant info) for automated expense reconciliation and policy checks.
| Name | Type | Description |
| CreatedBy | String | The identifier of the user or system that created the record in the ExpenseCreditCardTransactions table, providing an audit trail for the transaction. |
| CreationDate | Datetime | The date and time when the record was created in the ExpenseCreditCardTransactions table, indicating when the transaction was originally logged. |
| CreditCardTrxnId [KEY] | Long | A unique identifier for each credit card transaction in the ExpenseCreditCardTransactions table, used to reference and track individual transactions. |
| LastUpdateDate | Datetime | The date and time when the record was last updated, providing a timestamp for any modifications made to the transaction data. |
| LastUpdateLogin | String | The login ID associated with the most recent update to the record in the ExpenseCreditCardTransactions table, allowing identification of the user who made the change. |
| LastUpdatedBy | String | The identifier of the user who last updated the record in the ExpenseCreditCardTransactions table, ensuring traceability of updates to the transaction. |
| Finder | String | A reference or label used for searching and identifying records in the ExpenseCreditCardTransactions table, often for filtering or categorization purposes. |
Allows authorized delegation of expense-related tasks between employees, detailing start/end dates and permissible actions.
| Name | Type | Description |
| PersonName | String | The name of the person associated with the expense delegation, typically the employee who is delegating the responsibility. |
| PersonId | Long | The unique identifier of the person initiating the expense delegation, linking the record to the respective employee in the system. |
| DelegatePersonId | Long | The unique identifier of the delegatee, representing the person to whom the expense delegation is assigned. |
| DelegateName | String | The name of the person who has been delegated expense authority, typically a manager or supervisor. |
| Comments | String | Additional comments or notes related to the expense delegation, providing context or clarification on the delegation process. |
| CreatedBy | String | The name or identifier of the user who created the expense delegation record in the system. |
| CreationDate | Datetime | The date and time when the expense delegation record was created, marking the start of the delegation period. |
| DelegationId [KEY] | Long | The unique identifier for the expense delegation record, used to track and reference specific delegations in the system. |
| EnableAccountsFlag | Bool | A flag indicating whether accounts functionality is enabled for the specific expense delegation, determining if account-related data can be processed. |
| EnableProjectsFlag | Bool | A flag indicating whether project-related functionality is enabled for the expense delegation, determining if project data can be associated with the delegation. |
| EndDate | Date | The date when the expense delegation expires or ends, after which the delegation is no longer valid. |
| InactiveEmployeeFlag | Bool | A flag indicating whether the employee involved in the expense delegation is marked as inactive, preventing them from processing future delegations. |
| LastUpdateDate | Datetime | The date and time when the expense delegation record was last updated, providing tracking for any changes to the record. |
| LastUpdateLogin | String | The login ID or identifier of the user who last updated the expense delegation record, allowing for audit tracking. |
| LastUpdatedBy | String | The name or identifier of the user who last modified the expense delegation record, providing accountability for changes made. |
| Finder | String | A keyword or reference used to search or locate specific expense delegation records in the system, often used for filtering or querying purposes. |
| SysEffectiveDate | String | The system's effective date, often used to track changes or view the status of records as of a particular date in the system. |
| EffectiveDate | Date | A query parameter used to fetch resources that are effective as of the specified start date, helping to retrieve records valid on or after the given date. |
Houses descriptive flexfield contexts for expenses and reports, enabling tailored data collection for various business use cases.
| Name | Type | Description |
| RowIdentifier [KEY] | String | Unique identifier for each row in the ExpenseDffContexts table, used to distinguish individual records. |
| ApplicationId | Long | The ID of the application to which the expense descriptive flexfield (DFF) context belongs, linking it to a specific financial application. |
| DescriptiveFlexfieldCode | String | Code identifying the specific descriptive flexfield associated with the expense context, used for categorizing and referencing flexfield data. |
| ContextCode | String | A unique code representing the context of the descriptive flexfield, used to group and differentiate between various flexfield setups. |
| ContextIdentifier | String | A unique identifier for the context within the descriptive flexfield, used for referencing the specific configuration in business operations. |
| EnabledFlag | Bool | Flag indicating whether the descriptive flexfield context is enabled for use. A true value means it is active, while false means it is disabled. |
| ProtectedFlag | Bool | Indicates whether the descriptive flexfield context is protected from modifications. A true value means the context cannot be altered by users. |
| MultirowFlag | Bool | Flag specifying if the descriptive flexfield context supports multiple rows of data. A true value means it allows multiple entries. |
| TranslatableFlag | Bool | Indicates whether the descriptive flexfield context is translatable into different languages. A true value means the context can be localized. |
| CreationDate | Datetime | Date and time when the expense DFF context was created, providing a record of its initialization. |
| CreatedBy | String | User who created the expense descriptive flexfield context, often used for auditing purposes. |
| LastUpdateDate | Datetime | Date and time when the expense DFF context was last updated, indicating the most recent modification. |
| LastUpdatedBy | String | User who last updated the expense descriptive flexfield context, helpful for tracking changes in the system. |
| LastUpdateLogin | String | Login identifier associated with the last update to the expense DFF context, used for tracking session information during updates. |
| Name | String | The name given to the expense descriptive flexfield context, used to identify it within the financial system. |
| Description | String | A brief description of the expense DFF context, providing additional details for users about its purpose and usage. |
| InstructionHelpText | String | Text providing instructional help for users on how to fill out or use the expense descriptive flexfield context. |
| Finder | String | The search mechanism or query associated with the expense descriptive flexfield context, used to help locate related records or data. |
Details individual descriptive flexfield segments linked to expenses, supporting extended data capture and reporting.
| Name | Type | Description |
| RowIdentifier [KEY] | String | The unique identifier for each row in the ExpenseDffSegments table, ensuring each entry can be referenced individually. |
| ApplicationId | Long | The ID that links the segment to a specific application within Oracle Financials Cloud, identifying which application this segment belongs to. |
| DescriptiveFlexfieldCode | String | The code associated with the descriptive flexfield in the ExpenseDffSegments table, used to categorize the segment in the system. |
| ContextCode | String | The code representing the specific context or environment in which the ExpenseDffSegments are applied, often used for customization or filtering. |
| SegmentCode | String | A unique identifier for the segment within the ExpenseDffSegments table, used to differentiate various segments of data. |
| SegmentIdentifier | String | A distinct identifier for the segment, typically representing the specific data or segment in the financial system. |
| ColumnName | String | The name of the column within the ExpenseDffSegments table, which corresponds to a specific attribute or data point for the segment. |
| SequenceNumber | Int | The sequence number that defines the order of the segments within the ExpenseDffSegments table, helping maintain proper data structure. |
| EnabledFlag | Bool | Indicates whether the segment is enabled for use within the application. A true value means the segment is active. |
| RequiredFlag | Bool | Shows whether the segment is mandatory when inputting or processing data. A true value means the segment must be filled out. |
| ValueSetId | Long | The ID that links the segment to a specific value set, which defines the acceptable values for this segment in the system. |
| DefaultType | String | Specifies the type of default value applied to the segment, such as 'fixed', 'dynamic', or 'user-defined'. |
| DefaultValue | String | The default value assigned to the segment, which appears if no other value is provided by the user or system. |
| DefaultValueNumber | Decimal | The numeric default value for the segment, used when the default type is set to a numeric value. |
| DefaultValueDate | Date | The date default value for the segment, used when the default type is set to a date. |
| DefaultValueTimestamp | Datetime | The timestamp default value for the segment, capturing both date and time when no other input is provided. |
| DerivationValue | String | The value used to derive or calculate the segment's value, often determined by business rules or formulas. |
| RangeType | String | Defines the type of range applicable to the segment, such as 'date range', 'numeric range', or other constraints. |
| ReadOnlyFlag | Bool | Indicates whether the segment is read-only, preventing users from modifying its value if set to true. |
| DisplayType | String | The display type for the segment, defining how it appears to users, such as a text field, dropdown list, or checkbox. |
| DisplayWidth | Int | Specifies the width of the segment's display field in the user interface, determining how much space it occupies on the screen. |
| DisplayHeight | Int | Specifies the height of the segment's display field in the user interface, controlling its vertical space on the screen. |
| CheckboxCheckedValue | String | The value assigned to the segment when a checkbox is checked, representing the selected state of the checkbox. |
| CheckboxUncheckedValue | String | The value assigned to the segment when a checkbox is unchecked, representing the unselected state of the checkbox. |
| DynamicURL | String | A URL that is dynamically generated for the segment, used to link the segment to external resources or applications. |
| UOMClass | String | The unit of measure class associated with the segment, helping to define the measurement standards for financial data entry. |
| IndexedFlag | Bool | Indicates whether the segment is indexed, improving search performance and data retrieval within the system. |
| MultirowUniqueKeyFlag | Bool | Shows whether the segment is part of a multi-row unique key, ensuring that the segment value is unique across multiple rows. |
| BiEnabledFlag | Bool | Indicates whether Business Intelligence (BI) functionality is enabled for the ExpenseDffSegments table. A value of true signifies that BI features are active, while false means they are disabled. |
| BiEqualizationTag | String | The tag used to denote whether equalization adjustments are applied within the ExpenseDffSegments. This helps identify specific financial calculations related to equalization within the segments. |
| ShowValueDescription | String | Describes the value to be displayed for the ExpenseDffSegments, helping users understand the context or meaning of a given segment when viewed in the application. |
| CreationDate | Datetime | The timestamp of when the ExpenseDffSegment was initially created. This helps track when the segment was first recorded in the system. |
| CreatedBy | String | The identifier of the user or process that created the ExpenseDffSegment. This provides a way to trace the origin of the segment data. |
| LastUpdateDate | Datetime | The timestamp of the most recent update made to the ExpenseDffSegment. This helps identify when the segment was last modified. |
| LastUpdatedBy | String | The identifier of the user or process that last modified the ExpenseDffSegment. This helps track who made changes to the segment. |
| LastUpdateLogin | String | The login ID used by the user or process that last updated the ExpenseDffSegment. This can assist in auditing who accessed the segment for modifications. |
| Name | String | The name assigned to the ExpenseDffSegment, which serves as its unique identifier within the system. This name is used to differentiate between different segments. |
| Description | String | A detailed description of the ExpenseDffSegment, providing context about its purpose and use within the financial system. |
| Prompt | String | The prompt text associated with the ExpenseDffSegment. This text is typically used in user interfaces to prompt users for input when working with the segment. |
| ShortPrompt | String | A shortened version of the prompt text for the ExpenseDffSegment. It is used in places where space is limited but the essential prompt still needs to be displayed. |
| TerminologyHelpText | String | A helpful text that explains the terminology used in the ExpenseDffSegment. This assists users in understanding specialized terms or concepts associated with the segment. |
| InFieldHelpText | String | Provides guidance to users directly within the fields related to the ExpenseDffSegment. This helps users enter data correctly by providing contextual instructions. |
| Finder | String | The lookup code or identifier used for searching or retrieving the ExpenseDffSegment in the system. This is often used in query operations or to filter records. |
Shows how an expense item’s cost is allocated across multiple accounts or cost centers, ensuring financial accuracy.
| Name | Type | Description |
| CodeCombinationId | Long | The unique identifier for the accounting code combination, used to allocate an expense to the appropriate cost center, account, and other relevant dimensions in the accounting system. |
| CostCenter | String | The business unit or organizational entity that is responsible for the expense, helping to categorize costs within the company structure. |
| CreatedBy | String | The user or system that initiated the creation of the expense distribution record, allowing for traceability and accountability. |
| CreationDate | Datetime | The date and time when the expense distribution record was created, providing a timeline for tracking and auditing purposes. |
| ExpenseDistId [KEY] | Long | A unique identifier for each expense distribution entry, enabling the system to track the allocation of expenses to the correct accounts and reports. |
| ExpenseId | Long | The unique identifier for the expense that corresponds to a specific distribution, used to associate all distributions with a single expense entry. |
| ExpenseReportId | Long | The unique identifier for the expense report that contains the expense distribution, providing a connection between individual expenses and their report. |
| LastUpdateDate | Datetime | The date and time when the expense distribution record was last modified, which helps track changes or updates to the expense details over time. |
| LastUpdateLogin | String | The user or system responsible for the most recent update to the expense distribution record, useful for auditing and tracking changes. |
| LastUpdatedBy | String | The person or process that last updated the expense distribution record, ensuring accountability and traceability for modifications. |
| OrgId | Long | The unique identifier for the organization associated with the user creating the expense, linking the expense to a specific organizational unit within the company. |
| ReimbursableAmount | Decimal | The total amount of money to be reimbursed to the employee or individual for the expense distribution, reflecting the amount the company owes. |
| Company | String | The company to which the expense is allocated, ensuring that the expense is charged to the correct legal entity or business unit within the organization. |
| BusinessUnit | String | The specific business unit or department within the company responsible for the expense distribution, aiding in cost allocation and financial reporting. |
| Finder | String | A keyword or term used to search or locate expense distribution records in the system, enabling efficient tracking and querying of expenses. |
Captures project-specific descriptive flexfields for expense distributions, integrating project details with expense tracking.
| Name | Type | Description |
| ExpenseDistributionsExpenseDistId [KEY] | Long | The unique identifier for the expense distribution record, used to reference individual expense distributions in the ExpenseDistributionsPJCDFF table. |
| ExpenseDistId [KEY] | Long | The unique identifier for a specific expense distribution entry within the ExpenseDistributionsPJCDFF table, linking it to other related data. |
| _FLEX_Context | String | A pseudocolumn storing context information for the flexfield associated with the expense distribution, used to capture additional, flexible data attributes. |
| _FLEX_Context_DisplayValue | String | A pseudocolumn that stores the displayable value for the flexfield context, providing a user-friendly representation of the context data. |
| Finder | String | A field used to search or locate records within the ExpenseDistributionsPJCDFF table, typically storing search parameters or criteria for quick reference. |
Establishes company rules for entertainment-related spending, including meal, event, or other hospitality expenses.
| Name | Type | Description |
| AttendeeTypesFlag | Bool | Indicates whether the policy applies to specific types of attendees within the ExpenseEntertainmentPolicies schema. A true value means the policy includes attendee type differentiation. |
| CreatedBy | String | The identifier of the user who created the ExpenseEntertainmentPolicy record. Useful for tracking the origin of the policy in the system. |
| CreationDate | Datetime | The date and time when the ExpenseEntertainmentPolicy record was created. This helps track the timeline of policy establishment. |
| CurrencyCode | String | The currency code used for the financial transactions associated with the ExpenseEntertainmentPolicy record. Ensures the policy adheres to the appropriate currency standards. |
| CurrencyOptionCode | String | Represents the currency option selected for the ExpenseEntertainmentPolicy record. This may define a specific currency handling or exchange strategy. |
| Description | String | A detailed explanation or additional notes about the ExpenseEntertainmentPolicy record, providing context or outlining specific terms of the policy. |
| DispWarningToUserFlag | Bool | Indicates whether a warning should be displayed to the user during the execution of an operation related to the ExpenseEntertainmentPolicy record. Useful for flagging potential issues. |
| EmployeeAttendeeAmountCode | String | A code representing the amount associated with employee attendees in the ExpenseEntertainmentPolicy record. This may refer to limits or calculations specific to employee-related expenses. |
| EmployeeAttendeeInformationFlag | Bool | Indicates whether employee attendee information is included in the policy. When true, it signifies that employee details must be considered in policy compliance. |
| EmployerCreationFlag | Bool | A flag indicating whether the creation of the ExpenseEntertainmentPolicy record involves the employer's details. This can be used for employer-specific policy rules. |
| EmployeeRequiredAsAttendeeFlag | Bool | Specifies whether employees are required to be listed as attendees in certain types of expense entertainment scenarios under this policy. |
| EmployeeRateDeterminantFlag | Bool | Indicates whether the employee rate is a determining factor in calculating the allowable expenses for an event under the policy. When true, it impacts expense calculations. |
| EnabledRateLimitFlag | Bool | Indicates whether a rate limit is active under this ExpenseEntertainmentPolicy record, limiting the amount that can be spent per attendee or event. |
| EntertainmentPolicyId [KEY] | Long | The unique identifier for each ExpenseEntertainmentPolicy record, used to reference and manage policies in the database. |
| ErrorTolerance | Decimal | The allowable tolerance level for errors in financial transactions under the ExpenseEntertainmentPolicy record. This ensures that small discrepancies do not cause rejections. |
| IndividAttendeeAmountFlag | Bool | Indicates whether the amount allocated for individual attendees is flagged for special handling or review under the policy. |
| LastUpdateDate | Datetime | The date and time when the ExpenseEntertainmentPolicy record was last updated. This helps track changes and updates to the policy over time. |
| LastUpdatedBy | String | The identifier of the user who last updated the ExpenseEntertainmentPolicy record. This field is useful for auditing and tracking modifications. |
| LastUpdateLogin | String | The login identifier used when the ExpenseEntertainmentPolicy record was last updated, providing insight into the access and update history. |
| NonEmployeeAttendeeAddrsCode | String | A code representing the address information for non-employee attendees within the ExpenseEntertainmentPolicy, facilitating address-related processing. |
| NonEmployeeAttendeeAmountCode | String | A code representing the amount associated with non-employee attendees in the ExpenseEntertainmentPolicy record. Used to calculate or track expenses related to non-employees. |
| NonEmployeeAttendeeTypeCode | String | A code categorizing non-employee attendees under the policy, helping to define which attendee types the policy applies to. |
| NonEmployeeCreationFlag | Bool | Indicates whether the creation of the ExpenseEntertainmentPolicy record involves non-employee details. This flag allows the policy to account for non-employee participants. |
| NonEmployeeJobTitleCode | String | A code used to represent the job title of non-employee attendees, enabling more refined categorization and policy application based on job roles. |
| NonEmployeeAttendeeInformationFlag | Bool | Indicates whether non-employee attendee information is required or considered for the policy. This affects how non-employee data is handled during policy processing. |
| NonEmployeeRateDeterminantFlag | Bool | Indicates whether the non-employee rate affects the calculations or limitations within the ExpenseEntertainmentPolicy record, ensuring non-employee expenses are treated appropriately. |
| NonEmployeeRequiredAttendeeFlag | Bool | Specifies whether non-employees must be listed as attendees in certain types of expense entertainment events under the policy. |
| PeriodDay | Int | Represents the specific day of the period associated with the ExpenseEntertainmentPolicy record, often used in reporting and policy enforcement based on day-based periods. |
| PeriodMonth | String | Indicates the month of the period related to the ExpenseEntertainmentPolicy record. This helps define time-specific policies or limits for expenses. |
| PolicyEnforcementCode | String | A code representing the method or criteria used to enforce the rules of the ExpenseEntertainmentPolicy record. This helps track how the policy is applied in practice. |
| PolicyName | String | The name of the ExpenseEntertainmentPolicy record, providing a quick reference to identify the specific policy being used or applied. |
| PolicyViolationFlag | Bool | Indicates whether a violation of the policy has occurred during the processing of an expense. A true value signals a breach of the policy conditions. |
| PreventSubmissionFlag | Bool | Indicates whether submissions are prevented under the ExpenseEntertainmentPolicies. A true value means submissions are blocked, while false allows submission. |
| RateLimitTypeCode | String | Defines the type of rate limit applied to the ExpenseEntertainmentPolicies. This code determines the method of rate limiting, such as by amount or frequency. |
| SingleInstanceLimitFlag | Bool | Specifies whether a single limit instance is allowed under the ExpenseEntertainmentPolicies. If true, only one instance of the policy is applicable, otherwise multiple instances may apply. |
| StatusCode | String | Indicates the current status of the ExpenseEntertainmentPolicies, such as active, inactive, or pending approval. |
| WarningTolerance | Decimal | Defines the tolerance threshold for warnings related to the ExpenseEntertainmentPolicies. It represents the allowable deviation before a warning is triggered. |
| YearlyLimitFlag | Bool | Indicates whether a yearly limit is applied under the ExpenseEntertainmentPolicies. If true, the policy includes a cap for annual expenses. |
| Status | String | The status of the ExpenseEntertainmentPolicies, which could include values such as 'active', 'inactive', 'pending', or other status indicators. |
| CurrencyOption | String | Specifies the currency option used within the ExpenseEntertainmentPolicies, determining how expenses are recorded and reported (for example, USD, EUR). |
| PolicyEnforcement | String | Describes the manner in which the ExpenseEntertainmentPolicies are enforced, including potential actions like approval requirements, limits, or other controls. |
| EmployeeAttendeeAmount | String | Represents the amount designated for employee attendees under the ExpenseEntertainmentPolicies, typically detailing allowable expense amounts per employee. |
| NonEmployeeAttendeeType | String | Defines the type of non-employee attendees that are considered under the ExpenseEntertainmentPolicies, such as contractors or external guests. |
| NonEmployeeAttendeeAmount | String | Specifies the expense amount allowed for non-employee attendees under the ExpenseEntertainmentPolicies. |
| NonEmployeeAttendeeAddrs | String | Holds the addresses for non-employee attendees under the ExpenseEntertainmentPolicies, potentially useful for reporting or logistical purposes. |
| NonEmployeeJobTitle | String | Defines the job title of non-employee attendees included in the ExpenseEntertainmentPolicies, which may affect eligibility or limits. |
| RateLimitType | String | Describes the specific rate limit applied within the ExpenseEntertainmentPolicies, such as daily, monthly, or other periodic limits. |
| NonEmployeeCreation | String | Indicates the creation process for non-employee attendees within the ExpenseEntertainmentPolicies, such as a manual entry or automated system assignment. |
| EmployerCreation | String | Refers to the creation process for employer-related entities under the ExpenseEntertainmentPolicies, such as an employer’s internal tracking or approval. |
| NonEmployeeRequiredAttendee | String | Indicates whether a non-employee attendee is required for the policy to apply, providing specific rules for attendee eligibility. |
| EmployeeRateDeterminant | String | Defines the determinant for employee rates under the ExpenseEntertainmentPolicies, such as specific conditions or formulas used to calculate allowable expenses. |
| NonEmployeeRateDeterminant | String | Specifies the rate determinant for non-employee attendees under the ExpenseEntertainmentPolicies, helping calculate allowable expenses for external participants. |
| Currency | String | The primary currency used in the ExpenseEntertainmentPolicies for expense recording and reporting, ensuring consistency across transactions. |
| NumberOfAttendeesFlag | Bool | Indicates whether the number of attendees is a significant factor in the ExpenseEntertainmentPolicies, which could influence approval or limits. |
| NumberOfAttendeesCurrencyCode | String | Specifies the currency code used for the number of attendees, reflecting the currency applicable to any per-attendee expenses. |
| NumberOfAttendeesAmount | Decimal | Represents the total amount allocated based on the number of attendees, potentially used to calculate expenses or apply limits in the ExpenseEntertainmentPolicies. |
| Finder | String | Identifies the entity or process responsible for identifying or locating attendees or participants under the ExpenseEntertainmentPolicies. |
Specifies line-level detail within entertainment policies, defining allowable amounts, categories, and exclusions.
| Name | Type | Description |
| ExpenseEntertainmentPoliciesEntertainmentPolicyId [KEY] | Long | The unique identifier for each entertainment policy in the expense entertainment policy lines, linking this record to the broader policy. |
| CreatedBy | String | The user or system that created this record in the ExpenseEntertainmentPolicies table, providing traceability for the record's creation. |
| CreationDate | Datetime | The timestamp when this record was created in the ExpenseEntertainmentPolicies table, aiding in tracking the creation timeline. |
| CurrencyCode | String | The code representing the currency used for the associated expense policy, allowing identification of the currency for policy calculations. |
| EndDate | Date | The date when the policy expires, marking the end of its validity period and the last possible date for its application. |
| EntertainmentPolicyId | Long | The unique identifier for the entertainment policy associated with this line, connecting the line to a specific policy in the system. |
| InvalidCode | String | A flag or identifier used to mark whether the expense policy line has been invalidated or contains errors. |
| LastUpdateDate | Datetime | The timestamp of the most recent update to this policy line, providing visibility into when the record was last modified. |
| LastUpdatedBy | String | The user or system that last updated this policy line, ensuring traceability of modifications made to the policy. |
| LastUpdateLogin | String | The login session identifier from which the last update was made, useful for tracking the source of changes. |
| PolicyLineId [KEY] | Long | A unique identifier for the specific line within the entertainment policy, distinguishing individual policy lines in the table. |
| SingleInstanceLimit | Decimal | The maximum allowable amount for a single instance of an expense under this entertainment policy line, typically used for per-event spending. |
| StartDate | Date | The date when the policy line becomes effective, marking the start of the period during which the policy is valid. |
| StatusCode | String | A code indicating the current status of the policy line (for example, active, expired, pending), useful for filtering and status tracking. |
| TypeOfAttendeCode | String | A code identifying the type of attendee for whom the policy applies, such as employee, guest, or other categories relevant to the policy. |
| YearlyLimit | Decimal | The maximum allowable annual amount for expenses under this policy line, typically used to enforce overall spending limits. |
| TypeOfAttende | String | A description of the type of attendee associated with the policy line, providing clarity on the eligible parties for expense reimbursement. |
| Status | String | The current status of the expense policy line (for example, active, inactive, expired), indicating whether the policy is currently in force. |
| Currency | String | The currency associated with the policy line, defining the financial unit used for all expense calculations and reimbursements. |
| Finder | String | A descriptive field that helps identify or search for specific policy lines in the system, often used for categorization or querying. |
Manages standard expense location data (cities, countries, regions) used to categorize and validate expense submissions.
| Name | Type | Description |
| GeographyId [KEY] | Long | The unique identifier for the geographical region associated with the expense location. This ID links the location to a specific region or area within the database. |
| EndDate | Date | The date on which the expense location became inactive or was terminated. This marks the end of the period during which the location was considered active. |
| Country | String | The country in which the expense location is situated. This value helps categorize locations by their national association for financial and reporting purposes. |
| State | String | The state or province in which the expense location is situated. It is used to refine location categorization within a country. |
| County | String | The county or administrative region associated with the expense location. This level of detail is useful for more granular reporting and analysis. |
| City | String | The specific city where the expense location is situated. This helps pinpoint the exact location for regional financial analysis. |
| Location | String | A descriptive name or identifier for the expense location, often including a building or office name, to help distinguish it from other locations. |
| StartDate | Date | The date on which the expense location became active or operational. This marks the beginning of the period during which the location was available for use. |
| EffectiveDate | Date | The date when the details of the expense location became effective. This may differ from the StartDate if adjustments or changes occurred after the location was first active. |
| Finder | String | A user-defined field that may represent the person or tool responsible for identifying or assigning the expense location within the system. |
Defines meal expense guidelines, limits, and other policy details for business trips or events.
| Name | Type | Description |
| MealsPolicyId [KEY] | Long | The unique identifier for each meal policy within the ExpenseMealsPolicies table, used to distinguish different meal policies. |
| PolicyName | String | The name of the expense meals policy, typically describing the scope or conditions under which the policy applies. |
| Description | String | A detailed description of the expense meals policy, outlining its purpose and guidelines for usage. |
| StatusCode | String | A code representing the current status of the expense meals policy, indicating whether it is active, inactive, or in another state. |
| Status | String | The status of the expense meals policy, providing a human-readable version of the status code, such as 'Active' or 'Inactive'. |
| SingleInstanceLimitFlag | Bool | Indicates whether the meal policy allows only a single instance of a meal to be reimbursed per claim. A true value means only one meal per claim. |
| DailyLimitFlag | Bool | Indicates whether the policy enforces a daily limit for meal expenses. A true value means there is a daily maximum limit for meal reimbursements. |
| CurrencyOptionCode | String | A code representing the currency option for the meal policy, used to determine which currency is applicable for meal reimbursements. |
| CurrencyOption | String | The specific currency option associated with the expense meals policy, such as USD or EUR. |
| CurrencyCode | String | The ISO code for the currency used in the meal policy, such as USD or EUR. |
| Currency | String | The name of the currency applied to the meal policy, like USD or EUR. |
| EnabledRoleFlag | Bool | Indicates whether the meal policy is enabled for specific roles. A true value means that the policy applies to certain roles within the organization. |
| PolicyRoleCode | String | A unique code identifying the role that is associated with the meal policy, such as 'Manager' or 'Employee'. |
| PolicyRole | String | The name or description of the role to which the meal policy applies, such as 'Manager', 'Employee', or other job roles. |
| EnabledLocationFlag | Bool | Indicates whether the meal policy is enabled for specific locations. A true value means the policy applies to designated locations. |
| LocationTypeCode | String | A code representing the type of location where the meal policy is applicable, such as 'Office' or 'Field'. |
| LocationType | String | The name or description of the type of location associated with the policy, such as 'Office' or 'Field'. |
| ZoneTypeCode | String | A code identifying the zone type where the meal policy is applicable, used for categorizing areas or regions within the company. |
| ZoneType | String | The name or description of the zone type that the policy covers, such as 'Domestic' or 'International'. |
| PolicyEnforcementCode | String | A code specifying the enforcement mechanism for the meal policy, such as automatic checks or manual approvals. |
| PolicyEnforcement | String | A description of how the meal policy is enforced, including any automated checks or manual oversight mechanisms. |
| PolicyViolationFlag | Bool | Indicates whether a policy violation occurred. A true value indicates that a rule or limit was violated during the claim process. |
| WarningTolerance | Decimal | The tolerance level for warning users about potential violations of the meal policy, typically expressed as a percentage above the policy limit. |
| DispWarningToUserFlag | Bool | Indicates whether a warning should be displayed to users when they are close to violating the policy. A true value means a warning is shown. |
| PreventSubmissionFlag | Bool | Indicates whether submission of a claim is prevented if it violates the policy. A true value means the claim will not be submitted. |
| ErrorTolerance | Decimal | The tolerance level for allowing errors beyond the defined policy limit, often a percentage of the total meal expenses. |
| CreationDate | Datetime | The date and time when the meal policy was created, used for tracking the policy’s origin and version history. |
| CreatedBy | String | The name or identifier of the user who created the meal policy, useful for auditing and tracking policy changes. |
| LastUpdateDate | Datetime | The date and time when the meal policy was last updated, reflecting any changes or modifications made to the policy. |
| LastUpdatedBy | String | The name or identifier of the user who last updated the meal policy, useful for tracking edits or adjustments. |
| LastUpdateLogin | String | The login identifier used during the last update of the meal policy, assisting with auditing and user activity tracking. |
| RatesSourceCode | String | A code representing the source of the rate used for meal reimbursements, typically indicating where the rate data is derived from. |
| RateIncludeMealsFlag | Bool | Indicates whether the rate includes meals as part of the reimbursement calculation. A true value means meals are included in the rate. |
| RateIncludeOtherFlag | Bool | Indicates whether other types of expenses are included in the rate. A true value means other reimbursements are factored into the total rate. |
| MealsRateSourceCode | String | A code identifying the specific source of the meals rate, such as 'Standard' or 'Custom'. |
| MealsRateSource | String | The name or description of the source used for the meals rate, providing context for how the rate was determined. |
| Finder | String | The search or filter term used to find specific expense meal policies, allowing users to quickly locate relevant policies. |
Breaks down meal policy rules into line items, detailing per-diem amounts, eligibility, and exceptions.
| Name | Type | Description |
| ExpenseMealsPoliciesMealsPolicyId [KEY] | Long | The unique identifier for each meal policy within the Expense Meals Policies table, used to associate specific policies with their related expense meal lines. |
| PolicyLineId [KEY] | Long | The unique identifier for each line item in the Expense Meals Policies table, linking the specific line entry to a broader policy. |
| MealsPolicyId | Long | The identifier for the meal policy in the Expense Meals Policies table, used to track and manage specific meal-related expense policies. |
| TypeOfRateCode | String | A code representing the type of rate applied to a meal policy, helping to categorize the rate structure (for example, flat, per person, etc.). |
| SingleInstanceLimit | Decimal | The maximum allowable amount for a single expense instance within the meal policy, used to enforce spending limits per meal. |
| DailyLimit | Decimal | The daily spending limit for meals, restricting total allowable meal expenses within a 24-hour period. |
| CurrencyCode | String | The ISO currency code for the meal policy expenses, indicating the currency in which limits and allowances are defined. |
| Currency | String | The name of the currency used in the meal policy, corresponding to the CurrencyCode for expense processing. |
| StartDate | Date | The effective date when the meal policy becomes active, marking the beginning of the validity period for the policy. |
| EndDate | Date | The expiration date when the meal policy is no longer valid, defining the end of the policy's applicability. |
| RoleId | Long | The identifier of the role associated with the meal policy, linking the policy to specific organizational roles (for example, manager, employee). |
| RoleName | String | The name of the role tied to the meal policy, indicating which user roles or departments are governed by this policy. |
| GeographyId | Long | The unique identifier for the geographical area associated with the meal policy, helping to associate policies with specific regions. |
| ZoneCode | String | A code representing the specific zone within a geography, often used to determine localized meal limits and rates. |
| Zone | String | The name of the zone associated with the meal policy, providing a more human-readable description of the geographic area covered. |
| GeolocName | String | The name of the geographical location tied to the meal policy, helping to identify the specific area within a zone or region. |
| RawCountry | String | The raw country name, as entered in the system, used to identify the country in which the meal policy is applicable. |
| RawState | String | The raw state or province name, reflecting the state-level region for which the meal policy applies. |
| RawCounty | String | The raw county name, used for more granular geographic identification within the broader region of the meal policy. |
| RawCity | String | The raw city name, specifying the exact city in which the meal policy is valid or applied. |
| StatusCode | String | A code indicating the current status of the meal policy line, such as active, inactive, or suspended. |
| Status | String | A descriptive status of the meal policy line, providing additional context about whether the policy line is currently in use or has been discontinued. |
| CreationDate | Datetime | The timestamp indicating when the meal policy line was first created in the system, helping to track its initiation. |
| CreatedBy | String | The identifier of the user who created the meal policy line, providing traceability for system changes. |
| LastUpdateDate | Datetime | The timestamp indicating the last time the meal policy line was updated, helping to track recent changes. |
| LastUpdatedBy | String | The identifier of the user who last updated the meal policy line, providing accountability for changes. |
| LastUpdateLogin | String | The login identifier of the user who last modified the meal policy line, offering additional context for auditing purposes. |
| Finder | String | A user-defined search term or keyword used for querying the Expense Meals Policies data, allowing for quick retrieval based on specific criteria. |
Sets reimbursement rules for mileage claims, including distance rates and allowable vehicle types.
| Name | Type | Description |
| AdditionalRatesListCode | String | The unique code representing the additional rates list associated with the ExpenseMileagePolicies record, used to define specific rate details. |
| ApplyThresholdByCode | String | A code specifying the method by which thresholds are applied in the ExpenseMileagePolicies record, such as by distance or cost. |
| ApplyThresholdBy | String | The criteria used to determine how thresholds are applied in the ExpenseMileagePolicies record, such as based on distance, time, or amount. |
| CalculationPassRateByDistFlag | Bool | A flag indicating whether the pass rate calculation is based on distance, used in the ExpenseMileagePolicies record for distance-based calculations. |
| CapturePassNamesFlag | Bool | A flag indicating whether to capture pass names, useful for logging or reporting pass-specific information in the ExpenseMileagePolicies record. |
| CommuteDistanceRequiredFlag | Bool | A flag specifying whether a commute distance is required for the ExpenseMileagePolicies record, ensuring that only valid commute data is processed. |
| CountryCode | String | A two-character country code that defines the region for the ExpenseMileagePolicies record, used to apply region-specific rules and rates. |
| Country | String | The full name of the country for the ExpenseMileagePolicies record, helping to identify the geographical context for the policy. |
| CreatedBy | String | The username or ID of the individual who created the ExpenseMileagePolicies record, useful for tracking policy creation. |
| CreationDate | Datetime | The date and time when the ExpenseMileagePolicies record was created, providing a timestamp for auditing and history tracking. |
| CurrencyCode | String | The code representing the currency used in the ExpenseMileagePolicies record, such as USD, EUR, or GBP, indicating the financial context. |
| Currency | String | The full name of the currency used in the ExpenseMileagePolicies record, offering a clearer context for financial operations within the policy. |
| CurrencyOptionCode | String | A code indicating the specific currency option available for the ExpenseMileagePolicies record, allowing for different currency configurations. |
| CurrencyOption | String | A description of the currency option available in the ExpenseMileagePolicies record, such as 'foreign' or 'local' to differentiate various choices. |
| Description | String | A textual description providing details about the specific ExpenseMileagePolicies record, useful for understanding the intent and scope of the policy. |
| DisplayAllUnitsFlag | Bool | A flag indicating whether all units of measurement should be displayed for the ExpenseMileagePolicies record, enabling full visibility of available options. |
| DistanceThresholdFlag | Bool | A flag that determines whether a distance threshold is applied within the ExpenseMileagePolicies record, ensuring compliance with predefined limits. |
| EligibilityDistance | Decimal | The minimum distance required for eligibility under the ExpenseMileagePolicies record, ensuring only valid mileage claims are considered. |
| EnabledAdditnlRatesFlag | Bool | A flag specifying whether additional rates are enabled for the ExpenseMileagePolicies record, allowing for the inclusion of extra rate details. |
| EnabledDeductCommuteFlag | Bool | A flag indicating whether commute-related deductions are enabled in the ExpenseMileagePolicies record, ensuring accurate expense calculations. |
| EnabledEligibilityFlag | Bool | A flag that enables or disables the eligibility conditions for the ExpenseMileagePolicies record, ensuring that only valid claims are processed. |
| EnabledFuelTypeFlag | Bool | A flag indicating whether fuel type selection is enabled for the ExpenseMileagePolicies record, allowing for specific fuel-related deductions or policies. |
| EnabledGenderFlag | Bool | A flag that determines whether gender-specific criteria are enabled in the ExpenseMileagePolicies record, potentially affecting rates or rules. |
| EnabledLocationFlag | Bool | A flag indicating whether location-based policies are enabled in the ExpenseMileagePolicies record, allowing for geographically dependent rules. |
| EnabledMaximumPassFlag | Bool | A flag specifying whether a maximum pass limit is enabled in the ExpenseMileagePolicies record, controlling the number of passes allowed. |
| EnabledPassengerFlag | Bool | A flag indicating whether passenger-related criteria are enabled in the ExpenseMileagePolicies record, affecting rates or rules based on passengers. |
| EnabledRoleFlag | Bool | A flag that determines whether role-based criteria are enabled in the ExpenseMileagePolicies record, enabling differentiated policies for various user roles. |
| EnabledStandardDeductionFlag | Bool | A flag indicating whether standard deductions are enabled in the ExpenseMileagePolicies record, simplifying mileage calculations by applying predefined deductions. |
| EnabledVehCategoryFlag | Bool | A flag that determines whether vehicle category-based policies are enabled in the ExpenseMileagePolicies record, allowing for different rates based on vehicle types. |
| EnabledVehTypeFlag | Bool | A flag indicating whether vehicle type-specific criteria are enabled in the ExpenseMileagePolicies record, enabling differentiation based on vehicle characteristics. |
| FuelTypeListCode | String | A code representing the list of fuel types associated with the ExpenseMileagePolicies record, used to define which types of fuel are eligible for reimbursement. |
| LastUpdateDate | Datetime | The date and time the ExpenseMileagePolicies record was last updated, providing an audit trail of modifications. |
| LastUpdateLogin | String | The username or ID of the individual who last updated the ExpenseMileagePolicies record, helping to track changes to the policy. |
| LastUpdatedBy | String | The username or ID of the person who made the most recent update to the ExpenseMileagePolicies record, ensuring accountability in changes. |
| LocationTypeCode | String | A code that defines the type of location for the ExpenseMileagePolicies record, helping to categorize the location context within the policy. |
| LocationType | String | A description of the type of location associated with the ExpenseMileagePolicies record, such as 'urban' or 'rural', providing more specific context for the policy. |
| MaximumPassengers | Int | The maximum number of passengers allowed under the expense mileage policies, which dictates the upper limit for passengers that can be considered when calculating mileage reimbursements. |
| MileageDeduction | Decimal | The specific monetary amount deducted for mileage under the expense mileage policies, typically used to calculate the expense reimbursement based on the distance traveled. |
| MileagePolicyId [KEY] | Long | A unique identifier assigned to each mileage policy in the ExpenseMileagePolicies table, used to reference specific policies when applying rules or calculations. |
| PassengerRuleCode | String | A code that specifies the set of rules for determining passenger-related factors in the expense mileage policies, often used to categorize types of passenger groups. |
| PassengerRule | String | The detailed description of the rules applied to passengers under the expense mileage policies, outlining conditions like eligibility and calculation methodologies. |
| PolicyName | String | The name of the mileage policy, which identifies the policy's purpose, such as 'Standard Mileage Reimbursement' or 'Custom Vehicle Category Mileage'. |
| PolicyRoleCode | String | A code that represents the role of an individual or entity in the context of the mileage policy, used to distinguish between different roles such as employee, manager, or external vendor. |
| PolicyRole | String | A textual description of the role in the context of the mileage policy, clarifying the responsibilities or actions allowed under the policy, such as 'Employee' or 'Approver'. |
| StatusCode | String | A code representing the current status of the mileage policy, indicating whether the policy is active, suspended, or archived. |
| Status | String | The status description of the mileage policy, such as 'Active', 'Inactive', or 'Pending', providing an overview of the policy's current state in the system. |
| StandardDeductionCode | String | A code identifying the standard deduction type applied within the mileage policy, typically used to standardize deduction rates for various vehicle or trip types. |
| UnitOfMeasureCode | String | A code representing the unit of measure used in the policy, such as 'Miles' or 'Kilometers', specifying the unit used for distance calculations. |
| UnitOfMeasure | String | The textual description of the unit of measure, indicating how mileage is quantified under the policy, such as 'Miles' or 'Kilometers'. |
| VehicleCategoryListCode | String | A code representing the list of vehicle categories that are eligible for mileage reimbursement, helping to categorize vehicle types such as 'Sedan' or 'SUV'. |
| VehicleTypeListCode | String | A code representing a list of vehicle types covered by the mileage policy, used to specify allowable vehicle types for reimbursement purposes, like 'Compact' or 'Luxury'. |
| ZoneTypeCode | String | A code representing the type of geographical zone considered in the mileage policy, used to distinguish between different types of reimbursement zones like 'Urban' or 'Rural'. |
| ZoneType | String | The name or description of the geographical zone type, helping to define the area for which the mileage policy applies, such as 'Urban Area' or 'Long-Distance Zone'. |
| Finder | String | The identifier or search keyword used to locate and retrieve specific mileage policies in the system, often used for filtering policies in the database. |
Contains line-level specifics for mileage policy, supporting different mileage rates or exceptions based on region or vehicle.
| Name | Type | Description |
| ExpenseMileagePoliciesMileagePolicyId [KEY] | Long | The unique identifier for the mileage policy in the ExpenseMileagePolicies table, used to link to specific policy lines within the expense management system. |
| AdditionalRateCode | String | The code representing any additional rate applied to the mileage policy, allowing for extra charges or discounts to be associated with the expense lines. |
| AdditionalRate | String | The value of the additional rate, specifying the monetary amount that is added or adjusted to the base rate in the mileage policy. |
| CalculationMethodCode | String | The code defining the method used to calculate mileage reimbursement, such as distance-based, time-based, or flat-rate. |
| CalculationMethod | String | A detailed description of the method used for calculating mileage expenses, such as 'per mile,' 'per kilometer,' or 'flat rate per day.' |
| CreatedBy | String | The username or identifier of the person who created the mileage policy line, useful for tracking data origins and auditing. |
| CreationDate | Datetime | The timestamp representing when the mileage policy line was created in the system, providing a historical record for when policies are added. |
| CurrencyCode | String | The code for the currency in which the mileage reimbursement is calculated, such as USD, EUR, etc. |
| Currency | String | The full name of the currency used for the reimbursement amount, such as USD or EUR, providing clarity in multi-currency environments. |
| DistanceThreshold | Decimal | The threshold distance in miles or kilometers, above which specific rules or additional rates are applied to the mileage policy. |
| EndDate | Date | The date when the mileage policy line ends, marking the expiration or cutoff date for the policy to be valid or in effect. |
| FuelTypeCode | String | The code used to categorize the type of fuel associated with the vehicle in the mileage policy, such as 'Gas,' 'Diesel,' or 'Electric.' |
| FuelType | String | A description of the type of fuel used by the vehicle under the mileage policy, which can influence reimbursement rates or policies. |
| GeographyId | Long | A unique identifier for the geography or region related to the mileage policy, used to define where the policy applies (for example, specific cities, regions, or countries). |
| GeolocName | String | The name of the geographic location where the mileage policy applies, such as a specific city or region that has special rules or rates. |
| InvalidCode | String | A code representing the invalid status or error associated with the mileage policy line, useful for identifying issues that prevent processing. |
| InvalidDescription | String | A description of why the mileage policy line is considered invalid, providing context for troubleshooting or data correction. |
| LastUpdateDate | Datetime | The timestamp of the most recent update to the mileage policy line, allowing users to track changes and updates over time. |
| LastUpdateLogin | String | The login or username of the person who last updated the mileage policy line, facilitating accountability and traceability of changes. |
| LastUpdatedBy | String | The name or identifier of the person who made the most recent update to the mileage policy line, assisting with user tracking for audit purposes. |
| MileagePolicyId | Long | The unique identifier of the mileage policy, linking it to the specific rules and conditions applied to the expense reports and mileage calculations. |
| PassengerThreshold | Int | The threshold number of passengers in the vehicle that influences the mileage policy, potentially adjusting reimbursement rates based on vehicle occupancy. |
| PolicyLineId [KEY] | Long | The unique identifier of the specific policy line within the mileage policy, enabling precise reference to individual rules or conditions in the policy. |
| Rate | Decimal | The base rate for mileage reimbursement, typically calculated per mile or kilometer, used in conjunction with other factors to determine the total reimbursement. |
| RawCity | String | The raw city name as entered in the system, which may need further validation or standardization for processing in the mileage policy. |
| RawCountry | String | The raw country name entered in the system for the location where the mileage policy is applicable, useful for geographic filtering or data standardization. |
| RawCounty | String | The raw county name entered in the system, which may be used for location-based policy rules or geographical classification within the mileage policy. |
| RawState | String | The raw state or province name entered in the system, which could be relevant for policies that apply only to specific regions within a country. |
| RoleId | Long | The unique identifier for the role associated with the user or system function related to the mileage policy line, used for security and access management. |
| RoleName | String | The name of the role associated with the user or function managing the mileage policy, such as 'Manager' or 'Administrator,' indicating levels of access or responsibility. |
| StartDate | Date | The date when the mileage policy line becomes effective, marking the beginning of its applicability to mileage reimbursement. |
| StatusCode | String | A code representing the current status of the mileage policy line, such as 'Active,' 'Inactive,' or 'Pending,' indicating its processing state. |
| Status | String | A detailed description of the current status of the mileage policy line, providing further context on whether the policy is active, suspended, or in review. |
| VehicleCategoryCode | String | The code representing the category of vehicle (for example, 'Sedan,' 'SUV,' 'Truck') under the mileage policy, influencing rate calculations or eligibility. |
| VehicleCategory | String | A description of the vehicle category associated with the mileage policy, such as 'Sedan' or 'Electric Vehicle,' which may impact reimbursement rates. |
| VehicleTypeCode | String | The code representing the specific type of vehicle used in the mileage policy, such as 'Compact,' 'Luxury,' or 'Heavy Duty.' |
| VehicleType | String | The description of the vehicle type under the policy, such as 'Economy Car,' 'Luxury Sedan,' or 'Electric Vehicle,' affecting reimbursement rates and eligibility. |
| ZoneCode | String | The code for the geographic zone associated with the mileage policy, used to determine which zones are eligible for specific reimbursement rates. |
| Zone | String | The name of the geographic zone to which the mileage policy applies, which can vary by region, district, or other geographical classification. |
| Finder | String | A field used to search for and identify specific expense mileage policy lines, providing a user-friendly mechanism for filtering and locating policies. |
Covers miscellaneous expense categories that don’t fall under standard policies, detailing eligibility and maximum thresholds.
| Name | Type | Description |
| CreatedBy | String | The username or ID of the individual who initially created the record for the ExpenseMiscPolicies table. |
| CreationDate | Datetime | The date and time when the record for the ExpenseMiscPolicies table was first created. |
| CurrencyCode | String | The three-letter ISO code representing the currency used in the policy for the ExpenseMiscPolicies table. |
| CurrencyOptionCode | String | The code identifying the selected currency option for the policy in the ExpenseMiscPolicies table. |
| DailyLimitFlag | Bool | A flag indicating whether a daily spending limit is applied to the policy in the ExpenseMiscPolicies table. |
| DaysBasedItemParentFlag | Bool | A flag that specifies whether the policy is based on a parent item with a days-based calculation in the ExpenseMiscPolicies table. |
| Description | String | A textual description of the ExpenseMiscPolicies record, providing more details on the specific policy. |
| DispWarningToUserFlag | Bool | A flag that determines if a warning message is displayed to the user regarding this policy in the ExpenseMiscPolicies table. |
| EligibilityDays | Int | The number of days the policy is applicable or the eligibility duration in the ExpenseMiscPolicies table. |
| EnabledEligibilityFlag | Bool | A flag indicating whether eligibility for the policy is enabled in the ExpenseMiscPolicies table. |
| EnabledGenderFlag | Bool | A flag that specifies whether gender-based eligibility is enabled for the policy in the ExpenseMiscPolicies table. |
| EnabledLocationFlag | Bool | A flag that indicates whether location-based eligibility is enabled for the policy in the ExpenseMiscPolicies table. |
| EnabledRoleFlag | Bool | A flag that signifies if role-based eligibility is enabled for the policy in the ExpenseMiscPolicies table. |
| ErrorTolerance | Decimal | The tolerance limit for errors in policy calculations, expressed as a decimal value, in the ExpenseMiscPolicies table. |
| LastUpdateDate | Datetime | The date and time when the record for the ExpenseMiscPolicies table was last updated. |
| LastUpdatedBy | String | The username or ID of the individual who last modified the record in the ExpenseMiscPolicies table. |
| LastUpdateLogin | String | The login ID associated with the last update to the ExpenseMiscPolicies record. |
| LocationTypeCode | String | The code that defines the type of location applicable for the policy in the ExpenseMiscPolicies table. |
| MiscPolicyId [KEY] | Long | A unique identifier for each miscellaneous policy in the ExpenseMiscPolicies table. |
| PeriodDay | Int | The specific day within a period (for example, day of the month) that this policy applies to in the ExpenseMiscPolicies table. |
| PeriodMonth | String | The month during which the policy is valid or enforced, represented as a string (for example, 'January') in the ExpenseMiscPolicies table. |
| PolicyEnforcementCode | String | A code that indicates how the policy is enforced (for example, strict, lenient) in the ExpenseMiscPolicies table. |
| PolicyName | String | The name or title of the policy in the ExpenseMiscPolicies table, providing a clear reference to the policy's purpose. |
| PolicyRoleCode | String | The code that specifies the role associated with this policy, indicating who the policy applies to in the ExpenseMiscPolicies table. |
| PolicyViolationFlag | Bool | A flag indicating whether a policy violation has occurred under this policy in the ExpenseMiscPolicies table. |
| PreventSubmissionFlag | Bool | A flag that determines if submission of transactions is prevented under this policy in the ExpenseMiscPolicies table. |
| RateTypeCode | String | A code that specifies the type of rate (for example, hourly, fixed) used in the policy for the ExpenseMiscPolicies table. |
| SingleInstanceLimitFlag | Bool | A flag indicating whether the policy applies a limit to a single instance (for example, per transaction) in the ExpenseMiscPolicies table. |
| StatusCode | String | The code representing the current status of the policy (for example, active, inactive) in the ExpenseMiscPolicies table. |
| WarningTolerance | Decimal | The tolerance level for issuing a warning before policy enforcement, expressed as a decimal value in the ExpenseMiscPolicies table. |
| YearlyLimitFlag | Bool | A flag indicating whether a yearly spending limit is applied to the policy in the ExpenseMiscPolicies table. |
| ZoneTypeCode | String | The code that defines the type of zone (for example, geographical zone, time zone) applicable to the policy in the ExpenseMiscPolicies table. |
| Status | String | The current status of the ExpenseMiscPolicies record, such as 'active' or 'inactive'. |
| RateType | String | The type of rate applied to the policy, such as 'fixed', 'variable', or 'hourly'. |
| CurrencyOption | String | The specific currency option selected for the policy, such as 'local currency' or 'foreign currency'. |
| PolicyRole | String | The role associated with the policy, specifying the category or group of users the policy applies to. |
| LocationType | String | The type of location associated with the policy, which could refer to geographical areas or specific locations like 'office' or 'remote'. |
| ZoneType | String | The type of zone associated with the policy, such as a geographical zone or a specific time zone that the policy governs. |
| Currency | String | The currency used in the policy, represented by its ISO currency code (for example, USD). |
| PolicyEnforcement | String | The method of enforcement applied to the policy, such as automated or manual review for compliance. |
| Finder | String | A reference identifier or code used to search for and retrieve the policy record in the ExpenseMiscPolicies table. |
Describes specific line items under miscellaneous policies, such as office supplies or other uncommon expense types.
| Name | Type | Description |
| ExpenseMiscPoliciesMiscPolicyId [KEY] | Long | The unique identifier for the miscellaneous policy within the Expense Miscellaneous Policies table, linking it to its related policy lines. |
| CreatedBy | String | The username or system identifier of the person or system who created the record in the Expense Miscellaneous Policies table. |
| CreationDate | Datetime | The timestamp when the record in the Expense Miscellaneous Policies table was created, indicating the date and time of entry. |
| CurrencyCode | String | The ISO currency code associated with the expense policy, determining the currency used for calculations and transactions. |
| DailyLimit | Decimal | The maximum allowable expense amount per day for the given policy, expressed as a decimal value. |
| EndDate | Date | The date on which the expense policy ends, marking the expiration of its validity. |
| GenderCode | String | The gender specification for the policy, if applicable, representing the gender-related restrictions or applicability. |
| GeographyId | Long | A unique identifier for the geographical region linked to the expense policy, representing location-based rules or limits. |
| GeolocName | String | The name of the geographical location associated with the policy, such as a city or region name. |
| InvalidCode | String | A code that flags invalid entries or discrepancies in the data of the expense policy line, used for validation purposes. |
| LastUpdateDate | Datetime | The date and time when the record was last modified, indicating the most recent update to the expense policy line. |
| LastUpdatedBy | String | The user or system identifier of the person or system who made the most recent update to the record. |
| LastUpdateLogin | String | The login identifier used during the last update of the record, tracking which session modified the data. |
| MiscPolicyId | Long | A unique identifier for the miscellaneous policy, representing the overarching policy to which the policy line belongs. |
| PolicyLineId [KEY] | Long | The unique identifier for an individual line within the miscellaneous policy, indicating a specific policy detail. |
| RawCity | String | The unprocessed city name as provided in the expense policy line, often used for geolocation or validation purposes. |
| RawCountry | String | The unprocessed country name provided in the policy, reflecting the geographical location of the expense entry. |
| RawCounty | String | The unprocessed county name associated with the expense, typically used for location-based limits or restrictions. |
| RawState | String | The unprocessed state name provided within the expense policy line, used to determine state-specific rules. |
| ReimbursementPercentage | Decimal | The percentage of the total expense that is eligible for reimbursement under the policy, expressed as a decimal. |
| RoleId | Long | The unique identifier for the role associated with the policy line, which determines the role-specific rules or limits. |
| RoleName | String | The name of the role that the expense policy applies to, identifying the user role or category (for example, manager, employee). |
| SingleInstanceLimit | Decimal | The maximum allowable amount for a single instance of an expense under the policy, expressed as a decimal. |
| StartDate | Date | The date on which the expense policy becomes effective, marking the beginning of its validity. |
| StatusCode | String | A code indicating the current status of the expense policy line, such as active, pending, or expired. |
| TypeOfRateCode | String | The code specifying the type of rate used for the policy (for example, per diem, hourly rate), which influences the reimbursement structure. |
| YearlyLimit | Decimal | The total maximum allowable expense for the entire year under the policy, represented as a decimal value. |
| ZoneCode | String | The code representing the zone or region for the policy, used to apply region-specific limits or rules. |
| Status | String | The current status of the policy line, indicating whether it is active, pending, or inactive. |
| Currency | String | The currency in which the expenses are reimbursed, typically reflecting the currency code used for calculations. |
| Finder | String | The identifier or name of the system or user that is responsible for searching and retrieving the policy line information. |
Holds setup options at the business unit level, configuring how expenses are processed, approved, or reimbursed.
| Name | Type | Description |
| OrgId [KEY] | Long | The unique identifier for the organization associated with the expense settings. This is used to link the settings to a specific organizational unit within the Oracle Financials Cloud system. |
| SettingCode [KEY] | String | The code representing a specific configuration setting within the ExpenseOrganizationSettings table. It identifies the particular setting being defined for the organization. |
| SettingValue | String | The value associated with a particular setting code in the ExpenseOrganizationSettings table. This field holds the actual configuration value for the setting. |
| CreationDate | Datetime | The date and time when the expense organization settings record was created. This timestamp helps track when the settings were first established. |
| CreatedBy | String | The username or identifier of the user who created the expense organization settings record. This is useful for audit purposes and tracking responsibility. |
| LastUpdateLogin | String | The session identifier associated with the most recent update to the expense organization settings record. It helps trace which login session made the last modification. |
| LastUpdateDate | Datetime | The date and time of the most recent update to the expense organization settings record, allowing you to track when the record was last modified. |
| LastUpdatedBy | String | The username or identifier of the user who last updated the expense organization settings record. This information is vital for understanding who made the last changes. |
| Finder | String | A searchable field in the ExpenseOrganizationSettings table that may be used to assist users in finding specific settings based on keywords or values associated with the record. |
Calculates trip-specific per diem amounts for employee expenses, factoring in policy rules and travel duration.
| Name | Type | Description |
| Username [KEY] | String | The name of the user associated with the trip, typically representing the employee or individual submitting the expense. |
| BusinessUnit [KEY] | String | The business unit or department that is linked to the expense template, providing context for the financial tracking and approval process. |
| ExpenseTemplate [KEY] | String | The expense template assigned to the trip, which defines the structure and rules for expense reporting under the applicable policy. |
| ExpenseType [KEY] | String | The type of expense incurred during the trip, such as per diem, travel, meals, etc., aligning with the organization's cost categorization. |
| Location [KEY] | String | The geographic location or zone code of the trip, referring to a specific area from the exm_locations_mv table used to track expenses by region. |
| StartDatetime [KEY] | String | The date and time when the trip commenced, formatted as YYYY-MM-DD HH:MM:SS, marking the beginning of the expense period. |
| EndDatetime [KEY] | String | The date and time when the trip ended, formatted as YYYY-MM-DD HH:MM:SS, marking the conclusion of the expense period. |
| ReimbursementCurrencyCode [KEY] | String | An optional value indicating the currency for reimbursement, in cases where it differs from the organization's functional currency. |
| Deductions [KEY] | String | Optional deductions for daily expenses, formatted as a series of day entries where each entry uses five letters (Y or N) to indicate holiday status, meals, and accommodations. |
| PersonId [KEY] | Long | The unique identifier for the individual associated with the trip, linking to the person record in the system. |
| BusinessUnitId | Long | The unique identifier for the business unit associated with the expense template, helping to track expenses against specific organizational units. |
| ExpenseTypeId [KEY] | Long | A unique identifier for the type of expense, enabling the system to categorize and track different categories of expenses accurately. |
| LocationId [KEY] | Long | A unique identifier for the geographical location linked to the trip, which helps in organizing and analyzing location-based expenses. |
| ExchangeRate | Decimal | The exchange rate between the organization's functional currency and the reimbursement currency, if applicable, allowing for accurate conversion of amounts. |
| ReimbursableAmount | Decimal | The amount that is eligible for reimbursement in the specified reimbursement currency, based on the trip's eligible expenses. |
| ReceiptAmount | Decimal | The total per diem amount in the functional currency, reflecting the daily allowance for the trip. |
| ReceiptCurrencyCode | String | The functional currency code used for per diem calculations, indicating the currency in which the per diem is calculated. |
| DailyDetails | String | A detailed breakdown of per diem calculations, including eligibility, deductions, and adjustments for each day of the trip. |
| Messages | String | A list of validation and error messages related to the trip's expense submission, useful for troubleshooting and correcting data entry. |
| Finder | String | A reference to the finder used to search and retrieve expense per diem calculations, enabling easy lookup and filtering of records. |
Stores the overarching per diem guidelines, including allowable rates and daily caps for travel reimbursements.
| Name | Type | Description |
| AccomDeductCalcMethCode | String | The method used to calculate accommodation deductions in the ExpensePerDiemPolicies table. |
| AccomDeductCalcMeth | String | Specifies the accommodation deduction calculation method in the ExpensePerDiemPolicies table. |
| AccomDeductionFlag | Bool | Flag indicating whether accommodation deductions are applicable for the given policy in the ExpensePerDiemPolicies table. |
| AccomEligibEndHour | Int | The hour at which accommodation eligibility ends, as defined in the ExpensePerDiemPolicies table. |
| AccomEligibEndMinute | Int | The minute at which accommodation eligibility ends, as defined in the ExpensePerDiemPolicies table. |
| AccomEligibStartHour | Int | The hour at which accommodation eligibility starts, as defined in the ExpensePerDiemPolicies table. |
| AccomEligibStartMinute | Int | The minute at which accommodation eligibility starts, as defined in the ExpensePerDiemPolicies table. |
| AccomFreeOnlyFlag | Bool | Flag indicating whether only free accommodation is eligible under the policy in the ExpensePerDiemPolicies table. |
| AccomMinDurationHours | Int | The minimum number of hours required for accommodation eligibility in the ExpensePerDiemPolicies table. |
| AccomMinDurationMinutes | Int | The minimum number of minutes required for accommodation eligibility in the ExpensePerDiemPolicies table. |
| AccomMinNightHoursStay | Int | The minimum number of hours a person must stay overnight to qualify for accommodation in the ExpensePerDiemPolicies table. |
| AccomMinTripDuratFlag | Bool | Flag indicating whether a minimum trip duration is required for accommodation eligibility in the ExpensePerDiemPolicies table. |
| AccomRateCalcMethodCode | String | Code representing the accommodation rate calculation method in the ExpensePerDiemPolicies table. |
| AccomRateCalcMethod | String | Specifies the accommodation rate calculation method in the ExpensePerDiemPolicies table. |
| AccomReqMealsEligibFlag | Bool | Flag indicating whether meal eligibility is required for accommodation eligibility in the ExpensePerDiemPolicies table. |
| AllowActualExpenseFlag | Bool | Flag indicating whether actual expenses are allowed under the policy in the ExpensePerDiemPolicies table. |
| AllowRateConversionFlag | Bool | Flag indicating whether rate conversion is permitted under the policy in the ExpensePerDiemPolicies table. |
| BreakfastEligEndHour | Int | The hour at which breakfast eligibility ends, as defined in the ExpensePerDiemPolicies table. |
| BreakfastEligEndMinute | Int | The minute at which breakfast eligibility ends, as defined in the ExpensePerDiemPolicies table. |
| BreakfastEligStartHour | Int | The hour at which breakfast eligibility starts, as defined in the ExpensePerDiemPolicies table. |
| BreakfastEligStartMinute | Int | The minute at which breakfast eligibility starts, as defined in the ExpensePerDiemPolicies table. |
| CreatedBy | String | The user who created the record for the accommodation policy in the ExpensePerDiemPolicies table. |
| CreationDate | Datetime | The date and time when the record was created in the ExpensePerDiemPolicies table. |
| CurrencyCode | String | The currency code (for example, USD, EUR) used in the policy for accommodation expenses in the ExpensePerDiemPolicies table. |
| Currency | String | The name of the currency used in the policy for accommodation expenses in the ExpensePerDiemPolicies table. |
| CurrencyOptionCode | String | The code representing the currency option for the accommodation policy in the ExpensePerDiemPolicies table. |
| CurrencyOption | String | The specific currency option for the accommodation policy in the ExpensePerDiemPolicies table. |
| DayTravelEligibHours | Int | The number of hours for day travel eligibility in the ExpensePerDiemPolicies table. |
| Description | String | A brief description of the accommodation policy outlined in the ExpensePerDiemPolicies table. |
| DinnerEligEndHour | Int | The hour at which dinner eligibility ends, as defined in the ExpensePerDiemPolicies table. |
| DinnerEligEndMinute | Int | The minute at which dinner eligibility ends, as defined in the ExpensePerDiemPolicies table. |
| DinnerEligStartHour | Int | The hour at which dinner eligibility starts, as defined in the ExpensePerDiemPolicies table. |
| DinnerEligStartMinute | Int | The minute at which dinner eligibility starts, as defined in the ExpensePerDiemPolicies table. |
| EnabledAccomTypeFlag | Bool | Flag indicating whether a particular accommodation type is enabled under the policy in the ExpensePerDiemPolicies table. |
| EnabledLocationFlag | Bool | Flag indicating whether location-based rules are enabled for accommodation eligibility in the ExpensePerDiemPolicies table. |
| EnabledLongTermFlag | Bool | Flag indicating whether long-term accommodations are allowed in the policy in the ExpensePerDiemPolicies table. |
| EnabledRoleFlag | Bool | Flag indicating whether accommodation rules are based on employee roles in the ExpensePerDiemPolicies table. |
| EnabledSeasonRateFlag | Bool | Flag indicating whether seasonal rate rules are applied to accommodation policies in the ExpensePerDiemPolicies table. |
| EnabledWeekendHolidFlag | Bool | Flag indicating whether weekend and holiday rates are enabled for accommodation policies in the ExpensePerDiemPolicies table. |
| FreeMealDeductionCode | String | Code representing the deduction method for free meals in the policy in the ExpensePerDiemPolicies table. |
| FreeMealDeduction | String | The method used to apply deductions for free meals in the policy in the ExpensePerDiemPolicies table. |
| HolidayCalcMethodCode | String | The code specifying how holiday calculations are performed under the accommodation policy in the ExpensePerDiemPolicies table. |
| HolidayCalcMethod | String | The specific method used to calculate holiday allowances for accommodation expenses in the ExpensePerDiemPolicies table. |
| LastUpdateDate | Datetime | The date and time when the accommodation policy was last updated in the ExpensePerDiemPolicies table. |
| LastUpdateLogin | String | The login ID of the user who last updated the accommodation policy record in the ExpensePerDiemPolicies table. |
| LastUpdatedBy | String | The name of the user who last updated the accommodation policy record in the ExpensePerDiemPolicies table. |
| LocationTypeCode | String | Code specifying the type of location for the accommodation policy in the ExpensePerDiemPolicies table. |
| LocationType | String | Describes the type of location (for example, city, region) for the accommodation policy in the ExpensePerDiemPolicies table. |
| LongTermCalcMethod | String | The method used to calculate long-term accommodation allowances in the ExpensePerDiemPolicies table. |
| LongTermCalcMeth | String | The method used to calculate long-term accommodation expenses in the ExpensePerDiemPolicies table. |
| LunchEligEndHour | Int | The hour at which lunch eligibility ends, as defined in the ExpensePerDiemPolicies table. |
| LunchEligEndMinute | Int | The minute at which lunch eligibility ends, as defined in the ExpensePerDiemPolicies table. |
| LunchEligStartHour | Int | The hour at which lunch eligibility starts, as defined in the ExpensePerDiemPolicies table. |
| LunchEligStartMinute | Int | The minute at which lunch eligibility starts, as defined in the ExpensePerDiemPolicies table. |
| MealDeductionFlag | Bool | Flag indicating whether meal deductions apply in the accommodation policy in the ExpensePerDiemPolicies table. |
| MealInclIncidentalFlag | Bool | Flag indicating whether meals are considered part of incidental expenses in the policy in the ExpensePerDiemPolicies table. |
| MealRateTypeCode | String | Code specifying the type of rate applied to meals in the ExpensePerDiemPolicies table. |
| MealRateType | String | Describes the type of rate used for meals in the accommodation policy in the ExpensePerDiemPolicies table. |
| MealsAmountLimit | Decimal | The maximum allowable amount for meal expenses in the accommodation policy in the ExpensePerDiemPolicies table. |
| MealsCalcMethodCode | String | Code specifying the method used to calculate meal expenses in the accommodation policy in the ExpensePerDiemPolicies table. |
| MealsCalcMethod | String | Describes the method used to calculate meal expenses in the accommodation policy in the ExpensePerDiemPolicies table. |
| MealsDeductCalcMethCode | String | Code specifying the method used for calculating meal deductions in the ExpensePerDiemPolicies table. |
| MealsDeductCalcMeth | String | Describes the method used for calculating meal deductions in the accommodation policy in the ExpensePerDiemPolicies table. |
| MealsDeductionCode | String | Code representing the type of meal deduction in the accommodation policy in the ExpensePerDiemPolicies table. |
| MealsDeduction | String | Describes the type of meal deduction applied in the accommodation policy in the ExpensePerDiemPolicies table. |
| MealsRateSourceCode | String | Code representing the source of the meal rate in the accommodation policy in the ExpensePerDiemPolicies table. |
| MealsRateSource | String | Describes the source of the meal rate for accommodation policy expenses in the ExpensePerDiemPolicies table. |
| MinDistanceFromHome | Decimal | The minimum distance from an employee's home required for accommodation eligibility in the ExpensePerDiemPolicies table. |
| MinDistanceFromOffice | Decimal | The minimum distance from the office required for accommodation eligibility in the ExpensePerDiemPolicies table. |
| MinDurationHours | Int | The minimum number of hours required for the accommodation to be valid in the ExpensePerDiemPolicies table. |
| MinDurationMinutes | Int | The minimum number of minutes required for the accommodation to be valid in the ExpensePerDiemPolicies table. |
| MinTripDuratFlag | Bool | Flag indicating whether a minimum trip duration is required for accommodation eligibility in the ExpensePerDiemPolicies table. |
| MinimumReimbursement | Decimal | The minimum reimbursement amount for accommodation expenses in the policy in the ExpensePerDiemPolicies table. |
| ObjectVersionNumber | Int | The version number of the accommodation policy record in the ExpensePerDiemPolicies table. |
| OthersCalcMethodCode | String | Code representing the method used to calculate other expenses in the accommodation policy in the ExpensePerDiemPolicies table. |
| OthersCalcMethod | String | Describes the method used to calculate other types of expenses in the accommodation policy in the ExpensePerDiemPolicies table. |
| OthersEligibCriteriaCode | String | Code representing the criteria for eligibility for other expenses in the accommodation policy in the ExpensePerDiemPolicies table. |
| OthersEligibCriteria | String | Describes the eligibility criteria for other expenses in the accommodation policy in the ExpensePerDiemPolicies table. |
| PerDiemPolicyId [KEY] | Long | The unique identifier for the per diem policy record in the ExpensePerDiemPolicies table. |
| PerdiemPolicyType | String | The type of per diem policy (for example, international, domestic) defined in the ExpensePerDiemPolicies table. |
| PolicyName | String | The name of the per diem policy defined in the ExpensePerDiemPolicies table. |
| PolicyRoleCode | String | The code specifying the role for which the policy applies in the ExpensePerDiemPolicies table. |
| PolicyRole | String | The specific role or category for which the accommodation policy applies in the ExpensePerDiemPolicies table. |
| RateFormulaMethodCode | String | Code representing the formula method used to calculate rates for accommodation expenses in the ExpensePerDiemPolicies table. |
| RateFormulaMethod | String | Describes the formula used to calculate accommodation rates in the accommodation policy in the ExpensePerDiemPolicies table. |
| RateIncludeAccomFlag | Bool | Flag indicating whether accommodation is included in the rate calculation for the policy in the ExpensePerDiemPolicies table. |
| RateIncludeMealsFlag | Bool | Flag indicating whether meals are included in the rate calculation for the policy in the ExpensePerDiemPolicies table. |
| RateIncludeOtherFlag | Bool | Flag indicating whether other expenses are included in the rate calculation for the policy in the ExpensePerDiemPolicies table. |
| RateMultiplierCode | String | Code representing the rate multiplier applied in the accommodation policy in the ExpensePerDiemPolicies table. |
| RateMultiplier | String | Describes the rate multiplier used in the accommodation policy for calculating expenses in the ExpensePerDiemPolicies table. |
| RatesSourceCode | String | Code specifying the source of the rate in the accommodation policy in the ExpensePerDiemPolicies table. |
| RatesSource | String | Describes the source from which rates are derived in the accommodation policy in the ExpensePerDiemPolicies table. |
| RoleCalcMethod | String | The method used to calculate rates based on the employee's role in the accommodation policy in the ExpensePerDiemPolicies table. |
| SpecificFirstLastDayFlag | Bool | Flag indicating whether special first and last day rules apply to the accommodation policy in the ExpensePerDiemPolicies table. |
| Status | String | The current status of the accommodation policy, such as 'Active' or 'Inactive', in the ExpensePerDiemPolicies table. |
| StatusMeaning | String | The description of the status of the accommodation policy, such as 'Active' or 'Inactive', in the ExpensePerDiemPolicies table. |
| TimeAllowSameDayFlag | Bool | Flag indicating whether same-day accommodation is allowed under the policy in the ExpensePerDiemPolicies table. |
| TimeBasedRateModelFlag | Bool | Flag indicating whether the accommodation policy uses a time-based rate model in the ExpensePerDiemPolicies table. |
| TimeCalcMethodCode | String | Code representing the method used to calculate time-based accommodation expenses in the policy in the ExpensePerDiemPolicies table. |
| TimeCalcMethod | String | Describes the method used to calculate time-based accommodation expenses in the policy in the ExpensePerDiemPolicies table. |
| TimePeriodCode | String | Code representing the time period during which accommodation expenses are applicable in the ExpensePerDiemPolicies table. |
| TimePeriod | String | Describes the time period applicable for accommodation expenses in the ExpensePerDiemPolicies table. |
| TimeSameDayCalcMethod | String | The method used to calculate accommodation expenses for the same day in the ExpensePerDiemPolicies table. |
| TimeSameDayCalcMeth | String | An alternative description for the calculation method for same-day accommodation expenses in the ExpensePerDiemPolicies table. |
| TimeSameDayRuleCode | String | Code representing the rule for calculating same-day accommodation expenses in the ExpensePerDiemPolicies table. |
| TimeSameDayRule | String | Describes the rule used to calculate same-day accommodation expenses in the policy in the ExpensePerDiemPolicies table. |
| WeekendDay1Code | String | Code representing the first weekend day rate in the accommodation policy in the ExpensePerDiemPolicies table. |
| WeekendDay2Code | String | Code representing the second weekend day rate in the accommodation policy in the ExpensePerDiemPolicies table. |
| WithinEmployeeCityFlag | Bool | Flag indicating whether the accommodation policy applies to employees within the same city in the ExpensePerDiemPolicies table. |
| ZoneTypeCode | String | Code specifying the zone type for accommodation expenses in the policy in the ExpensePerDiemPolicies table. |
| ZoneType | String | Describes the type of zone (for example, city, regional) in the accommodation policy in the ExpensePerDiemPolicies table. |
| Finder | String | The name of the person who located or identified the accommodation policy in the ExpensePerDiemPolicies table. |
Provides a breakdown of per diem policy lines, specifying coverage, meal breakdowns, or location-based rates.
| Name | Type | Description |
| ExpensePerDiemPoliciesPerDiemPolicyId [KEY] | Long | The unique identifier for the per diem policy in the ExpensePerDiemPolicies table, used to associate expenses with a specific policy. |
| AccomNightRate | Decimal | The rate per night for accommodation, as defined in the ExpensePerDiemPolicies table for each policy. |
| AccommodationDeduction | Decimal | The deduction applied to accommodation expenses, as per the policy in the ExpensePerDiemPolicies table. |
| AccommodationTypeCode | String | A code representing the type of accommodation, as defined in the ExpensePerDiemPolicies table. |
| AccommodationType | String | The descriptive name for the type of accommodation, such as 'Hotel' or 'Motel', as defined in the policy. |
| BaseRate | Decimal | The base rate for per diem, used as the standard calculation for accommodation or meal expenses before any adjustments. |
| CreatedBy | String | The user who initially created the record for the expense per diem policy line in the system. |
| CreationDate | Datetime | The date and time when the expense per diem policy line record was created in the system. |
| CurrencyCode | String | The code for the currency in which the expense is reported (for example, USD, EUR). |
| Currency | String | The name of the currency in which the expense is reported, such as USD or EUR. |
| EndDate | Date | The end date for the validity of the expense per diem policy line, indicating when it is no longer applicable. |
| FirstDayRate | Decimal | The rate applied to the first day of travel or stay, as per the expense policy. |
| GeographyId | Long | The identifier for the geographic region associated with the expense policy, used for location-based rules or calculations. |
| GeoLocName | String | The name of the geographic location associated with the expense policy, such as a city or region. |
| HolidayRate | Decimal | The rate for accommodation or meals on holidays, often higher than standard rates, as defined in the policy. |
| InvalidCode | String | A code indicating an invalid or non-compliant entry in the system related to the expense policy. |
| Invalid | String | A flag or status indicating whether an expense record is invalid, used for error checking or correction. |
| LastDayRate | Decimal | The rate applied to the last day of travel or stay, used to adjust the final day’s expenses. |
| LastUpdateDate | Datetime | The date and time when the expense policy record was last updated or modified in the system. |
| LastUpdateLogin | String | The login identifier of the user who last updated the expense policy record. |
| LastUpdatedBy | String | The name of the user who last modified the expense policy record. |
| LineHours | Int | The number of hours associated with the line item, typically used for calculating partial day expenses. |
| LineMinutes | Int | The number of minutes associated with the line item, used to calculate time-based expenses more precisely. |
| LowerLineHours | Int | The number of hours associated with the lower threshold for an expense line, often for partial day adjustments. |
| LowerLineMinutes | Int | The number of minutes associated with the lower threshold for an expense line, providing a finer breakdown for partial days. |
| LowerRoleThreshold | Int | The threshold value below which a lower rate or different rule applies, often used for different roles or job levels. |
| LowerTripExceedDays | Decimal | The number of days exceeding a specified threshold for trip length, which might trigger additional per diem adjustments. |
| MealsBreakfastDeduction | Decimal | The amount deducted for breakfast expenses in the policy, often if the meal is not covered or provided. |
| MealsBreakfastRate | Decimal | The rate assigned for breakfast expenses in the per diem policy, used to reimburse employees accordingly. |
| MealsDailyDeduction | Decimal | The daily deduction applied for meals, often based on specific policy rules or limits. |
| MealsDinnerDeduction | Decimal | The amount deducted for dinner expenses in the policy, typically when the meal is not covered or is self-provided. |
| MealsDinnerRate | Decimal | The rate assigned for dinner expenses as part of the per diem policy. |
| MealsLunchDeduction | Decimal | The amount deducted for lunch expenses in the policy, typically when lunch is not covered or provided. |
| MealsLunchRate | Decimal | The rate assigned for lunch expenses in the per diem policy, used to reimburse employees accordingly. |
| MealsOneMealDeduction | Decimal | The deduction applied for a single meal when less than three meals are covered in the policy. |
| MealsOneMealRate | Decimal | The rate for a single meal expense, used when only one meal is provided or reimbursed under the policy. |
| MealsThreeMealsDeduction | Decimal | The deduction applied when all three meals (breakfast, lunch, and dinner) are covered under the policy. |
| MealsThreeMealsRate | Decimal | The rate assigned for all three meals in the per diem policy, covering breakfast, lunch, and dinner. |
| MealsTwoMealsDeduction | Decimal | The deduction applied when only two meals are covered, usually breakfast and dinner or lunch and dinner. |
| MealsTwoMealsRate | Decimal | The rate for two meals, used when only two meals are reimbursed under the per diem policy. |
| ObjectVersionNumber | Int | The version number of the object or record, used for tracking changes and updates to the policy lines. |
| OthersFirstDayRate | Decimal | The first day rate for expenses other than accommodation or meals, often applied for initial travel or setup costs. |
| OthersLastDayRate | Decimal | The last day rate for expenses other than accommodation or meals, often used for final travel or closing expenses. |
| OthersStandardRate | Decimal | The standard rate for miscellaneous expenses not categorized under accommodation or meals. |
| PerDiemPolicyId | Long | The unique identifier for the per diem policy associated with each line item, used for referencing the overarching policy. |
| PolicyLineId [KEY] | Long | The identifier for the specific policy line within the expense per diem policy, allowing for detailed expense breakdown. |
| RawCity | String | The raw data input for the city name where the expense occurred, as captured in the ExpensePerDiemPolicies table. |
| RawCountry | String | The raw data input for the country name where the expense occurred, as captured in the ExpensePerDiemPolicies table. |
| RawCounty | String | The raw data input for the county name where the expense occurred, as captured in the ExpensePerDiemPolicies table. |
| RawState | String | The raw data input for the state name where the expense occurred, as captured in the ExpensePerDiemPolicies table. |
| RoleThreshold | Int | The threshold for role-based expense adjustments, dictating different rates or policies based on the employee's role. |
| RoleThresholdCode | String | The code used to represent different role thresholds for per diem policy adjustments, indicating varying allowances. |
| SeasonEndDay | Int | The day of the month that marks the end of a specific season for the expense policy, used for season-based adjustments. |
| SeasonEndMonth | Int | The month of the year that marks the end of a specific season for the expense policy, influencing policy duration. |
| SeasonStartDay | Int | The day of the month that marks the start of a specific season for the expense policy, used to trigger season-based allowances. |
| SeasonStartMonth | Int | The month of the year that marks the start of a specific season for the expense policy, determining the seasonality of rates. |
| StartDate | Date | The start date for the expense per diem policy line, indicating when the policy becomes effective. |
| Status | String | The status of the expense policy line, indicating whether the policy is active, inactive, or requires review. |
| StatusMeaning | String | A descriptive meaning of the status, explaining the reason for its current state (for example, 'Active', 'Expired', 'Pending'). |
| TripExceedDays | Decimal | The number of days exceeding the specified threshold for the trip length, often triggering higher rates for extended trips. |
| TypeOfLineCode | String | A code that classifies the type of expense line, used to distinguish between accommodation, meals, or other categories. |
| WeekendDay1Rate | Decimal | The rate for the first weekend day, often applied to weekend stays or activities. |
| WeekendDay2Rate | Decimal | The rate for the second weekend day, usually applied if the trip extends through two weekend days. |
| ZoneCode | String | The code representing the geographical zone, used to apply specific rates or policies based on the location. |
| Finder | String | The identifier or name of the user who located or identified the expense policy line, typically used for audit or tracking purposes. |
Tracks percentage-based per diem policy values, enabling scaled calculations for partial days or specific travel scenarios.
| Name | Type | Description |
| ExpensePerDiemPoliciesPerDiemPolicyId [KEY] | Long | Unique identifier for the per diem policy in the ExpensePerDiemPolicies table, used to reference individual policy records. |
| CreatedBy | String | Indicates the user or system that created the record in the ExpensePerDiemPolicies table. |
| CreationDate | Datetime | Timestamp indicating when the record was first created in the ExpensePerDiemPolicies table. |
| DeterminantCode | String | Code representing the determinant used in per diem policy calculation, such as 'destination' or 'employee category'. |
| DeterminantValue | Int | Numerical value associated with the determinant code, used to determine specific per diem amounts. |
| LastUpdateDate | Datetime | Timestamp indicating the most recent modification made to the record in the ExpensePerDiemPolicies table. |
| LastUpdateLogin | String | Login information for the user or system that made the most recent update to the record. |
| LastUpdatedBy | String | Name or identifier of the person or system responsible for the last update to the record. |
| LineHours | Int | The number of hours associated with a specific line item in the expense policy, typically used for time-based calculations. |
| LineMinutes | Int | The number of minutes associated with a specific line item in the expense policy, for precise time-based expense calculation. |
| LineValue | Decimal | The monetary value of the line item, calculated based on the policy, time, and other determinants. |
| LowerDeterminantValue | Int | Lower bound value for the determinant, representing a threshold or range for policy application. |
| LowerLineHours | Int | The minimum number of hours that can be applied to a per diem line item in the expense policy. |
| LowerLineMinutes | Int | The minimum number of minutes that can be applied to a per diem line item in the expense policy. |
| ObjectVersionNumber | Int | Version number of the record, used for concurrency control and tracking changes over time in the ExpensePerDiemPolicies table. |
| PerDiemPolicyId | Long | Identifier for the per diem policy, linking this record to the overall policy structure in the database. |
| PolicyValueId [KEY] | Long | Unique identifier for the specific value or set of values assigned to a per diem policy, used for referencing expense data. |
| TypeOfLineCode | String | Code representing the type of line item (for example, 'lodging', 'meals'), used to categorize expenses under the per diem policy. |
| Finder | String | An identifier used to locate or reference the per diem policy within the system, often used in search or filter operations. |
Contains person-centric details (business unit, currency preferences) tied to expense transactions and approvals.
| Name | Type | Description |
| PersonId [KEY] | Long | The unique identifier for an individual in the ExpensePersons table, representing the person associated with an expense record. |
| UserLocation | String | The geographical location associated with the ExpensePersons record, typically representing the person's office or primary work location. |
| DefaultExpenseAccountId | Long | The ID of the default expense account assigned to the individual for processing and categorizing expenses. |
| BusinessUnitId | Long | The ID representing the business unit to which the individual belongs, helping to categorize and assign responsibilities within the company structure. |
| BUName | String | The name of the business unit associated with the ExpensePersons record, providing context for the organizational unit they are part of. |
| OrganizationId | Long | The ID of the organization to which the individual belongs, identifying the larger entity within which the business unit operates. |
| JobId | Long | The unique identifier for the person's job position within the organization, helping to link to job-specific information and roles. |
| GradeId | Long | The identifier for the employee's grade or level within the organization, which could relate to seniority or compensation. |
| PositionId | Long | The unique identifier of the position or role the person holds within the company, providing context for their responsibilities. |
| CurrencyCode | String | The three-letter code representing the currency in which expenses are recorded for the individual, following the ISO standard. |
| CurrencyName | String | The name of the currency used for the person's expense records, such as USD or EUR. |
| ExpenseEntryFlag | Bool | A Boolean flag indicating whether the individual is authorized or eligible to enter expense data in the system. |
| ExpenseAccess | String | The level of access the person has to expense-related data, such as 'View' or 'Edit', defining their permissions for managing expense records. |
| ProjectAccess | String | The level of access the individual has to project-related information, specifying whether they can view, edit, or manage project details. |
| AccountAccess | String | The level of access the person has to financial accounts within the system, determining their permissions for interacting with financial data. |
| Finder | String | A tool or identifier that helps locate or search for specific ExpensePersons records, typically used for filtering or querying relevant data. |
Stores an individual’s default expense settings, such as preferred currency or default cost center, streamlining expense entry.
| Name | Type | Description |
| PreferenceId | Long | A unique identifier assigned to each expense preferences record, ensuring distinct identification within the system. |
| PersonId [KEY] | Long | A unique identifier for the person associated with the expense preferences record, used to link personal data to their expense preferences. |
| CreationDate | Datetime | The timestamp indicating when the expense preferences record was created in the system. |
| CreatedBy | String | The identifier of the user or system process that initially created the expense preferences record. |
| LastUpdateDate | Datetime | The timestamp when the expense preferences record was last modified or updated. |
| LastUpdatedBy | String | The identifier of the user or system process responsible for the most recent update to the expense preferences record. |
| LastUpdateLogin | String | The login session or system context in which the last update to the expense preferences record was made. |
| AutoSubmitFlag | Bool | A flag that determines whether expenses created by the automated BOT process are automatically submitted without manual intervention. |
| PersonName | String | The full name of the person associated with the expense preferences record, typically used for identification and reference. |
| CommuteDistance | Decimal | The calculated or reported distance, typically in miles or kilometers, between the person’s home and work location. |
| CorpCardCount | Int | The total number of corporate credit cards assigned to the individual, reflecting their eligibility or use within the company. |
| OnboardingStatusCode | String | The current status of the person's onboarding process, which could include stages like 'Completed,' 'Pending,' or 'In Progress.' |
| Finder | String | The source or tool used to find and associate the expense preferences record, potentially indicating the method by which the data was entered or retrieved. |
Lists commonly used expense types for chatbot or quick expense entry, improving user efficiency and consistency.
| Name | Type | Description |
| ResultType | String | Specifies the type of result returned for the expense preference categories in the ExpensePreferredTypes table. |
| OrgId | Long | Represents the unique identifier for the organization associated with the expense type preferences in the ExpensePreferredTypes table. |
| RecordId [KEY] | Long | Unique identifier for each record in the ExpensePreferredTypes table, used to distinguish between different expense entries. |
| MerchantName | String | Name of the merchant or vendor related to the expense entry, stored in the ExpensePreferredTypes table. |
| ExpenseTypeId | Long | The unique identifier for the specific type of expense, which corresponds to the various categories or types of expenses in the ExpensePreferredTypes table. |
| PersonId | Decimal | Identifies the person (typically an employee or contractor) associated with the expense preference, stored as a decimal for precise identification. |
| ExpenseTypeCount | Long | The total count of distinct expense types recorded for a particular organization or person, as stored in the ExpensePreferredTypes table. |
| CategoryCode | String | A code representing the expense category, used to classify expenses into various predefined types in the ExpensePreferredTypes table. |
| ExpenseTypeName | String | The name or description of the expense type, providing clarity on what the expense category represents in the ExpensePreferredTypes table. |
| ExpenseStartDate | Date | The start date of the expense, indicating when the expense was initiated or began within the ExpensePreferredTypes table. |
| ExpenseTemplateId | Long | Unique identifier for the expense template used to categorize and track various types of expenses in the ExpensePreferredTypes table. |
| ExpenseTemplateName | String | The name or description of the template used for grouping related expenses in the ExpensePreferredTypes table. |
| MatchScore | String | A score indicating the match or relevance of the expense type preference, which may be used for recommendations or analysis in the ExpensePreferredTypes table. |
| Finder | String | The source or entity that initiated the expense discovery or preference matching process, potentially identifying the user or system involved in categorizing the expense. |
Stores extended user-specific expense profile data (for example, employee roles, entitlements), enhancing customization for expense submissions.
| Name | Type | Description |
| PersonId | Long | Unique identifier for the person associated with the expense profile, used for linking individual users to their respective expense data. |
| Userlocation | String | Represents the location of the user within the context of the expense profile, typically used for location-based expense reporting. |
| DefaultExpenseAccountId | Long | Identifies the default expense account associated with the expense profile, which is automatically selected when creating expense entries. |
| CompanySegment | String | Categorizes the company division or department that the expense profile belongs to, helping to track company-specific expenses. |
| CostCenterSegment | String | Indicates the cost center associated with the expense profile, used for tracking expenses within specific cost centers in the organization. |
| OrganizationId | Long | Represents the unique identifier for the organization that the expense profile is linked to, crucial for organization-wide expense tracking. |
| BusinessUnitId | Long | The unique identifier of the business unit associated with the expense profile, used for organizing expenses by business units within the company. |
| BUName | String | Name of the business unit associated with the expense profile, providing a readable label for users and reports. |
| ExpenseTemplateId | String | ID for the expense template linked to the expense profile, used to pre-define categories and rules for expense entries. |
| ExpenseEntryFlag | Bool | Flag indicating whether expense entries are allowed for this profile. If false, the profile cannot be used to create new expense reports. |
| ExpenseAccess | String | Defines the type of access the user has regarding expenses, specifying what types of expense actions they are authorized to perform. |
| ProjectAccess | String | Indicates the level of access the user has to project-related expenses, including permissions for viewing and modifying project expenses. |
| AccountAccess | String | Describes the level of access the user has to account-related information, such as viewing or editing account details associated with expenses. |
| CurrencyCode | String | The currency code (for example, USD, EUR) for the expense profile, indicating the currency used for transactions and reporting. |
| CurrencyName | String | The full name of the currency (for example, USD, EUR) used in the expense profile, providing more clarity than the code alone. |
| Version | String | Specifies the version of the expense profile, used to track changes and updates over time to ensure consistency across profiles. |
| EnableReimbCurrencyFlag | Bool | Flag indicating whether the profile supports reimbursement in a different currency from the default expense currency. |
| TermsAgreementURL | String | A URL linking to the terms and conditions agreement relevant to the expense profile, which users must agree to before submitting expenses. |
| EnableProjectFieldsFlag | Bool | Flag indicating whether fields related to project information (such as project ID or task) are enabled for expense entries. |
| PurposeRequiredFlag | Bool | Flag indicating whether the purpose of the expense must be specified when submitting an expense entry, ensuring clarity of the expense's intent. |
| LineDescrRequiredFlag | Bool | Flag indicating whether a description for each individual line item in an expense report is required. |
| DisableCcMerchantNameFlag | Bool | Flag indicating whether the merchant name field is disabled for credit card expenses, typically for regulatory or privacy reasons. |
| EnableAttachments | String | Specifies whether attachments (such as receipts or invoices) are allowed for expense entries within the profile. |
| GoogleMapsAPIKey | String | API key for accessing Google Maps services, likely used for validating location-based expenses or providing map functionalities. |
| PartyId | Long | Identifies the party (for example, individual or organization) associated with the expense profile, helping to link various entities to expense reports. |
| DisableCompanySegment | String | Indicates whether the company segment field is disabled or restricted for the expense profile, limiting segmentation options. |
| EnableSavePasswordFlag | Bool | Flag that determines whether users can save their passwords within the system for quicker login to their expense profiles. |
| DisableScanFlag | Bool | Flag indicating whether the ability to scan receipts or documents is disabled within the expense profile, typically for security or policy reasons. |
| SubmitReportError | String | Contains error messages related to submitting expense reports, providing feedback to the user on issues with their report submission. |
| JobId | String | The unique identifier for the user's job position within the company, used for linking users to job-specific expense policies or budgets. |
| GradeId | String | Indicates the user's job grade or level within the company, used for enforcing specific expense policies based on job classification. |
| PositionId | String | Represents the unique identifier for the user's specific position or role within the company, often tied to specific expense privileges or restrictions. |
| Finder | String | A field used to store searchable terms or identifiers for quickly finding or referencing a specific expense profile. |
Manages attachments (for example, receipts, authorizations) linked at the expense report level, aiding record-keeping and compliance.
| Name | Type | Description |
| ExpenseReportsExpenseReportId [KEY] | Long | The unique identifier for the expense report. |
| AttachedDocumentId [KEY] | Long | The unique identifier of the attached document. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| DatatypeCode | String | A value indicating the data type of the attachment. |
| FileName | String | The name of the file attached. |
| DmFolderPath | String | The folder path from which the attachment is created. |
| DmDocumentId | String | The document ID from which the attachment is created. |
| DmVersionNumber | String | The version number of the document from which the attachment is created. |
| Url | String | The URL of a web page-type attachment. |
| CategoryName | String | The category of the attachment. |
| UserName | String | The login credentials of the user who created the attachment. |
| Uri | String | The URI of a Topology Manager-type attachment. |
| FileUrl | String | The URI of the file. |
| UploadedText | String | The text content for a new text attachment. |
| UploadedFileContentType | String | The content type of the attachment. |
| UploadedFileLength | Long | The size of the attachment file. |
| UploadedFileName | String | The name to assign to a new attachment file. |
| ContentRepositoryFileShared | Bool | Indicates whether the attachment is shared. |
| Title | String | The title of the attachment. |
| Description | String | The description of the attachment. |
| ErrorStatusCode | String | The error code, if any, for the attachment. |
| ErrorStatusMessage | String | The error message, if any, for the attachment. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| FileContents | String | The contents of the attachment. |
| ExpirationDate | Datetime | The expiration date of the contents in the attachment. |
| LastUpdatedByUserName | String | The user name who last updated the record. |
| CreatedByUserName | String | The user name who created the record. |
| AsyncTrackerId | String | An attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. |
| FileWebImage | String | The Base64 encoded image of the file displayed in .png format if the source is a convertible image. |
| DownloadInfo | String | A JSON object containing information to programmatically retrieve a file attachment. |
| PostProcessingAction | String | The name of the action that can be performed after an attachment is uploaded. |
| BusinessUnit | String | The business unit associated with the attachment. |
| ExpenseReportId | Long | The identifier for the expense report associated with the attachment. |
| Finder | String | A field used for searching or filtering records. |
| SysEffectiveDate | String | The system's effective date for the resource. |
| CUReferenceNumber | Int | Maps the child aggregates with parent tables. |
| EffectiveDate | Date | A parameter used to fetch resources effective as of the specified date. |
Maintains line-level expense items within a report, capturing essential details like expense type, amount, and project allocations.
| Name | Type | Description |
| ExpenseReportsExpenseReportId [KEY] | Long | Unique identifier for the expense report within the system. This helps track and manage individual expense reports across the platform. |
| AgencyName | String | Name of the agency or service provider offering transportation or accommodation services, such as car rental or airfare. |
| AssignmentId | Long | Unique identifier assigned to an individual or employee, used to associate expenses with the correct user or owner. |
| AuditAdjustmentReason | String | Explanation provided by the auditor for any changes made to the reimbursable amount, helping to ensure transparency and clarity in adjustments. |
| AuditAdjustmentReasonCode | String | Code that categorizes the reason behind an adjustment made by the auditor to an individual's reimbursable expenses. |
| AwtGroupId | Long | Identifier for an alternate tax withholding group, which can be used for managing tax-related deductions for groups of employees. |
| BilledAmount | Decimal | The amount billed to the corporate card account, representing the cost charged to the account by the service provider. |
| BilledCurrencyCode | String | Currency code indicating the currency used for the amount billed to the corporate card account. |
| CardId | Long | Unique identifier for a specific corporate card, used to track transactions and account details for a particular cardholder. |
| CheckoutDate | Date | Date when an individual departs or checks out from a location related to an accommodation expense, such as a hotel or rental property. |
| CreatedBy | String | The user who created the record, providing accountability and helping to track the origin of each entry in the system. |
| CreationDate | Datetime | Timestamp indicating the exact date and time when the record was created, ensuring the correct chronological order of data. |
| CreditCardTrxnId | Long | Unique identifier for a specific transaction made using a corporate credit card, used for reference and reconciliation. |
| DailyAmount | Decimal | The amount of the daily expense receipt, typically used to track daily costs such as meals or incidental expenses. |
| DailyDistance | Decimal | Distance traveled by an individual in one day for business-related activities, typically used for calculating mileage reimbursement. |
| DailyLimit | String | The daily expense limit set for a specific trip, which helps control the spending based on company policies. |
| DepartureLocationId | Long | Unique identifier for the departure location, helping to track and associate expenses with specific geographical locations. |
| Description | String | A brief description of the expense item, providing context for the expenditure, such as the purpose or nature of the expense. |
| DestinationFrom | String | Starting location of a trip, such as the city or airport from which an individual is departing for business purposes. |
| DestinationTo | String | Ending or arrival location of the trip, indicating the destination for the business-related travel. |
| DistanceUnitCode | String | Code that specifies the unit of measurement for travel distance. Common values are KILOMETER and MILE, indicating the unit used for travel reimbursement. |
| EndDate | String | The final day of an expense item that spans multiple days, marking the end of the applicable time period for the expense. |
| EndDateTimestamp | Datetime | Timestamp indicating the exact end date and time for an expense item that spans multiple days, helping with accurate time tracking. |
| EndOdometer | Decimal | The odometer reading at the conclusion of a trip, used to calculate mileage and verify travel-related reimbursements. |
| ExchangeRate | Decimal | Rate at which one currency can be exchanged for another at a specific point in time, often used to convert foreign expenses. |
| ExpenseCategoryCode | String | Code that identifies the classification of an expense item, such as BUSINESS for work-related expenses or PERSONAL for non-business expenditures. |
| ExpenseCreationMethodCode | String | Code indicating the method by which an expense item was created, such as via mobile iOS or Android apps for expense reporting. |
| ExpenseId [KEY] | Long | Unique identifier for a specific expense item, enabling easy tracking and reference within the expense management system. |
| ExpenseReference | Int | Reference number used to identify and track specific expenses, often used to link expenses to broader reports or categories. |
| ExpenseReportId | Long | Unique identifier for a specific expense report, helping to associate all individual expenses with the corresponding report. |
| ExpenseSource | String | Code identifying the source of the expense, such as CASH for out-of-pocket expenses or CORP_CARD for corporate card transactions. |
| ExpenseTemplateId | Long | Unique identifier for a specific expense template, helping to define the structure and rules for expense entries. |
| ExpenseTypeCategoryCode | String | Code that classifies an expense item by its type, such as AIRFARE for flight costs or CAR_RENTAL for transportation expenses. |
| ExpenseTypeId | Long | Unique identifier for a specific expense type, helping to categorize expenses into types like lodging, meals, or travel. |
| FlightClassLimit | String | Expense limit associated with a specific flight class, such as business or economy class, used to control travel-related spending. |
| FlightDuration | Decimal | The duration of an airline flight in hours, used to assess the time spent traveling for business purposes. |
| FlightNumber | String | Flight number associated with an airline trip, used to identify specific flights for business travel reporting. |
| FuelType | String | Types of fuel covered for reimbursement under mileage policies, typically associated with the type of vehicle used. |
| ImageReceiptRequiredFlag | Bool | Indicates whether a scanned or photographed image of the receipt is required for submitting an expense. |
| ItemizationParentExpenseId | Long | Unique identifier for the parent expense of an itemized expense, enabling the tracking of grouped or broken-down expense items. |
| ItemizationReceiptBusinessTotalAmount | Decimal | Total business-related amount on a receipt to be reimbursed to the employee, after any personal expenses are deducted. |
| ItemizationReceiptPersonalTotalAmount | Decimal | Personal amount on a receipt, representing expenses that are not eligible for reimbursement. |
| ItineraryReservationId | Long | Unique identifier for a travel reservation, used to associate expenses with the details of the booked itinerary. |
| Justification | String | Reason provided for incurring an expense, explaining why the expense was necessary for business purposes. |
| JustificationRequiredFlag | Bool | Indicates whether a justification is required for an expense item, often used to ensure policy compliance. |
| LastUpdateDate | Datetime | Timestamp indicating when the record was last updated, providing the most recent version of the expense data. |
| LastUpdateLogin | String | Login session associated with the user who last updated the record, helping to track who made changes to the entry. |
| LastUpdatedBy | String | User who last updated the row, offering accountability and traceability for changes made to the expense record. |
| LicensePlateNumber | String | License plate number of a vehicle used during business travel, typically used for mileage tracking or vehicle-related expenses. |
| Location | String | Location where an expense was incurred, providing context for expenses such as meals, lodging, or transportation. |
| LocationId | Long | Unique identifier for a specific expense location, helping to track where expenses are associated geographically. |
| LongTermTripFlag | Bool | Indicates whether the trip is categorized as long-term, helping to apply specific rules for extended travel durations. |
| LongTermTripStartDate | Date | The date when a long-term business trip started, used for tracking the duration and associated expenses. |
| MerchantDocumentNumber | String | Document number from the merchant or service provider, used for identifying and reconciling receipts or purchase invoices. |
| MerchantName | String | Name of the merchant or service provider where an expense was incurred, aiding in vendor management and reporting. |
| MerchantReference | String | Purchase or transaction identification number provided by the merchant, often used for tracking and reconciliation of transactions. |
| MerchantTaxRegNumber | String | Unique identifier assigned to a merchant by the tax authority, used for regulatory compliance and transaction reporting. |
| MerchantTaxpayerId | String | Tax Indentification Number (TIN) assigned to a merchant, used for taxation and compliance purposes. |
| MileagePolicyId | Long | Unique identifier for a mileage policy, which defines rules for reimbursing mileage expenses for employees or contractors. |
| NumberOfAttendees | Decimal | The number of people who attended an event for which expenses were incurred, typically used for business meals or entertainment. |
| NumberOfDays | Int | The number of days for which an expense is being reported, often used for accommodations, meals, or travel-related expenses. |
| NumberPeople | Int | The number of people or passengers in a vehicle during business-related travel, impacting mileage and reimbursement calculations. |
| OrgId | Long | Unique identifier for the business unit associated with the expense, ensuring accurate tracking of expenses by department or team. |
| PassengerAmount | Decimal | Total amount reimbursed for carrying passengers in a vehicle, typically used for mileage reimbursement in carpool scenarios. |
| PassengerName | String | Name of the individual who is a passenger in the vehicle during a business trip. |
| PassengerRateType | String | Rate type for passenger reimbursement during a trip, used to calculate the reimbursement amount for carpooling. |
| PaymentDueFromCode | String | Code identifying the party responsible for paying a specific transaction, such as an employee or department. |
| PersonId | Long | Unique identifier for the individual who owns the expense, typically used to associate expenses with employees or contractors. |
| PersonalReceiptAmount | Decimal | Amount of an expense receipt that is considered personal and not reimbursable by the company. |
| PolicyShortpayFlag | Bool | Indicates whether an expense was short-paid due to noncompliance with company policies or limits. |
| PolicyViolatedFlag | Bool | Indicates whether an expense violates any company policy, triggering additional review or corrective actions. |
| PolicyWarningFlag | Bool | Indicates whether an expense item has been flagged with a warning for policy issues, requiring further review. |
| PolicyWarningReasonCode | String | Code explaining the reason for a policy warning applied to an expense item, based on company-defined criteria. |
| PreparerId | Long | Unique identifier for the person who prepared and submitted the expense report. |
| RatePerPassenger | Decimal | Mileage reimbursement rate per passenger for a vehicle used during a business trip, impacting total reimbursements. |
| ReceiptAmount | Decimal | Total amount shown on a receipt, used to verify that the expense matches the claimed amount. |
| ReceiptCurrencyCode | String | Currency code indicating the currency of the receipt, used for conversions or reconciliation of foreign expenses. |
| ReceiptDate | Date | Date when a receipt is issued, typically used for matching the expense date with supporting documentation. |
| ReceiptMissingDecRequiredFlag | Bool | Indicates whether a declaration is required for missing receipts, used for verifying missing documentation. |
| ReceiptMissingFlag | Bool | Indicates whether a receipt is missing for an expense item, prompting further investigation or clarification. |
| ReceiptRequiredFlag | Bool | Indicates whether a receipt is mandatory for the expense item, ensuring compliance with company reimbursement policies. |
| ReceiptVerifiedFlag | Bool | Indicates whether the receipt for an expense item has been verified by an auditor or approver. |
| ReimbursableAmount | Decimal | Amount eligible for reimbursement for a specific expense, after deducting any personal portions or policy violations. |
| ReimbursementCurrencyCode | String | Currency code representing the reimbursement amount for an expense, ensuring proper conversion and payment. |
| SequenceNumber | Decimal | Sequence number used to organize and enter expense items within a report, maintaining a structured order of expenses. |
| StartDate | Date | The start date of an expense item, typically marking the first day of a trip or business-related activity. |
| StartDateTimestamp | Datetime | Timestamp indicating the exact start date and time of an expense item, offering precise time tracking. |
| StartOdometer | Decimal | Odometer reading at the beginning of a trip, used for mileage calculation and verification of business travel. |
| TaxClassificationCode | String | Code indicating the tax classification applied to an expense, used for tax reporting and compliance. |
| TicketClassCode | String | Code specifying the ticket class of travel, such as business or economy, impacting travel reimbursements. |
| TicketNumber | String | Unique identifier for an airline ticket, used for referencing and verifying travel expenses. |
| TravelMethodCode | String | Code that identifies the method of travel used for a business trip, such as flight, car rental, or train. |
| TravelType | String | Type of travel for the expense item, typically either DOMESTIC or INTERNATIONAL. |
| TripDistance | Decimal | Total distance traveled during a business trip, typically used to calculate mileage reimbursement for the trip. |
| UOMDays | Decimal | Calculation of the number of per diem expense days, based on the unit of measurement for travel expenses. |
| ValidationErrorFlag | Bool | Indicates whether there was a validation error for the expense, triggering corrective actions or manual review. |
| ValidationErrorMessages | String | Error messages generated during validation, providing details on issues that need resolution before approval. |
| ValidationWarningMessages | String | Warning messages generated during validation, providing alerts on potential issues that may require attention. |
| VehicleCategoryCode | String | Code identifying the vehicle category, such as COMPANY, PRIVATE, or RENTAL, for mileage reimbursement calculations. |
| VehicleType | String | Type of vehicle used for business travel, such as CAR, MOTORCYCLE, or VAN, impacting mileage and transportation reimbursements. |
| ZoneCode | String | Geographical zone code that indicates the area of travel, used for calculating mileage rates based on location. |
| ZoneTypeCode | String | Code indicating the type of zone for which mileage rates are applied, used in travel and transportation reimbursements. |
| BusinessUnit | String | Business unit to which the incurred expense is attributed, helping to allocate costs to the correct organizational unit. |
| PersonName | String | Name of the person incurring the expense, typically the employee or contractor submitting the expense report. |
| ExpenseTemplate | String | Expense template used for categorizing and organizing the types of expenses incurred for reporting purposes. |
| ExpenseType | String | Type of expense associated with a specific business activity, such as meals, travel, or entertainment. |
| ReceiptCurrency | String | Currency in which the expense receipt was issued, used for reconciliation and accurate expense reporting. |
| ReimbursementCurrency | String | Currency used for reimbursing an employee or contractor for their expenses, which may differ from the receipt currency. |
| DistanceUnit | String | Unit of measurement used for travel distances, with possible values of KILOMETER or MILE. |
| TicketClass | String | Class of ticket purchased for business travel, with possible values including BUSINESS and ECONOMY. |
| ExpenseSourceName | String | Source of the expense item, such as Cash or Corporate Card, providing context on how the expense was incurred. |
| ReferenceNumber | String | Unique reference number for an expense item or object version, used to identify and track the version of the transaction. |
| Request | Long | Unique identifier associated with a specific credit card upload process, used for tracking uploaded expense data. |
| AttachmentExists | String | Indicates whether there is an attachment associated with the expense, providing context for document verification. |
| ExpenseReportStatus | String | Current status of an expense report, helping users track its progress through the approval and reimbursement process. |
| AuthTrxnNumber | String | Authorization number for a credit card transaction, helping to verify and validate card charges associated with the expense. |
| TravelTypeName | String | Name of the type of flight or travel, either Domestic or International, based on the TravelType attribute. |
| VehicleCategory | String | Category of vehicle used for business travel, such as COMPANY, PRIVATE, or RENTAL. |
| VehicleTypeName | String | Name of the specific vehicle type used, such as sedan, van, or SUV, for business-related travel. |
| FuelTypeName | String | Name of the fuel type used during travel, such as gasoline or diesel, for mileage reimbursement calculations. |
| TaxClassification | String | Description of the tax classification applied to an expense, guiding proper tax treatment and reporting. |
| CountryCode | String | Country code where the expense was incurred, ensuring accurate location-based expense tracking and reporting. |
| AutoSubmitDate | Datetime | Date when the expense is automatically submitted, typically used for time-sensitive expense reporting processes. |
| ReceiptTime | Datetime | Time when the receipt transaction occurred, used to differentiate transactions that happen on the same date. |
| TipAmount | Decimal | Amount of tip given in the transaction, helping to manage receipts with additional charges beyond the standard amount. |
| VisitedFlag | Bool | Indicates whether the user has confirmed or visited a particular expense item, used for validation purposes. |
| ValidationStatus | String | Status of the validation for an expense, such as errors, warnings, or confirmed as valid. |
| PrepaidFlag | Bool | Indicates whether the expense was prepaid, ensuring accurate accounting for pre-paid versus post-paid expenses. |
| ExpenseDff | String | Column for storing additional fields used only during insert operations. For update and delete, refer to the appropriate child table. |
| ExpenseAttendee | String | Column for managing attendees during insert operations. For update and delete, refer to the child table's operations. |
| ExpenseDistribution | String | Used for managing expense distribution in insert operations. For updates or deletes, refer to the corresponding child table. |
| expenseErrors | String | Column used for capturing errors during insert operations. For update and delete, refer to the relevant child table. |
| duplicateExpenses | String | Column for handling duplicate expense checks during insert operations. For updates or deletes, refer to the child table. |
| ExpenseItemization | String | Column used for itemizing expenses during insert operations. For updates or deletes, use operations in the related child table. |
| matchedExpenses | String | Column for matching expenses during insert operations. For updates or deletes, refer to the child table's operations. |
| Finder | String | Unique identifier or search term used for finding records within the system. |
| SysEffectiveDate | String | System-defined effective date used to track when a record becomes valid in the system. |
| CUReferenceNumber | Int | Reference number used to link child aggregates with their parent tables, helping maintain relational integrity. |
| EffectiveDate | Date | Date used to fetch resources that are effective as of a specified start date, assisting with historical data retrieval. |
Enables users to upload documents for individual expense items, reinforcing traceability and validation.
| Name | Type | Description |
| ExpenseReportsExpenseReportId [KEY] | Long | Unique identifier for the expense report in the system. This is used to reference specific expense reports throughout the application. |
| ExpenseExpenseId [KEY] | Long | Unique identifier for the expense associated with the expense report, allowing for detailed tracking and reference. |
| AttachedDocumentId [KEY] | Long | Unique identifier for the document attached to the expense report, facilitating the retrieval and management of associated files. |
| LastUpdateDate | Datetime | Timestamp indicating when the record was last updated, providing a reference for data version control and audit tracking. |
| LastUpdatedBy | String | The username of the person who last updated the record, useful for auditing and tracking user actions in the system. |
| DatatypeCode | String | Code that indicates the type of data stored in the column, helping in data validation and interpretation. |
| FileName | String | Name of the file attached to the expense report, allowing users to identify and manage attached files more easily. |
| DmFolderPath | String | The file path from the document management system that points to the folder where the attachment is stored, aiding in the organization and retrieval of files. |
| DmDocumentId | String | The unique document ID associated with the attachment, used to track and link the file to its original document in the document management system. |
| DmVersionNumber | String | The version number of the document associated with the attachment, useful for tracking document revisions and managing different versions of files. |
| Url | String | URL pointing to a web-based resource or attachment, useful for referencing online content or external files related to the expense report. |
| CategoryName | String | Name of the category under which the attachment is classified, helping to organize and filter attachments by type or content. |
| UserName | String | Login credentials of the user who uploaded the attachment, used for access control and to track the source of attachments. |
| Uri | String | Uniform Resource Identifier (URI) for Topology Manager-based attachments, used for managing complex system configurations and linking to associated resources. |
| FileUrl | String | URL or link to the file, allowing users to access, download, or view the attached file directly from the web interface. |
| UploadedText | String | Text content included in a text-based attachment, such as comments or notes related to the expense report. |
| UploadedFileContentType | String | The content type of the uploaded file, used to specify the format of the file and ensure correct handling during upload. |
| UploadedFileLength | Long | The size of the uploaded file in bytes, providing information about the file's storage requirements and size restrictions. |
| UploadedFileName | String | Name assigned to the uploaded file during the upload process, allowing for proper identification and organization of the file. |
| ContentRepositoryFileShared | Bool | Boolean flag indicating whether the file attachment is shared with other users or systems, which helps control file access permissions. |
| Title | String | The title or label of the attachment, used to provide a clear and concise name for the file when displayed in the user interface. |
| Description | String | Detailed description of the attachment, providing more context or explanation of the file's contents and its relevance to the expense report. |
| ErrorStatusCode | String | Code representing any error that occurred during the attachment process, used for troubleshooting and tracking file upload issues. |
| ErrorStatusMessage | String | Detailed error message associated with any issues encountered while processing the attachment, aiding in troubleshooting. |
| CreatedBy | String | Username of the individual who initially created the record, providing information about the origin of the data for auditing purposes. |
| CreationDate | Datetime | Timestamp indicating when the record was created, useful for historical tracking and maintaining data integrity. |
| FileContents | String | Text or data content of the attachment, stored in a readable format when the file type allows for such content. |
| ExpirationDate | Datetime | The expiration date after which the contents of the attachment are no longer valid or accessible, often used for document retention policies. |
| LastUpdatedByUserName | String | The username of the person who last updated the record, used for tracking modifications and maintaining an audit trail. |
| CreatedByUserName | String | The username of the person who originally created the record, providing context for accountability and historical reporting. |
| AsyncTrackerId | String | Unique identifier used for tracking asynchronous file uploads, assisting with error handling and monitoring progress during the file upload process. |
| FileWebImage | String | Base64-encoded PNG image representing the attachment, displayed for preview if the file source is a convertible image. |
| DownloadInfo | String | JSON object containing metadata and instructions for programmatically retrieving the file, useful for integration with external systems and automated processes. |
| PostProcessingAction | String | Action that can be triggered after the file has been uploaded, such as 'convert', 'index', or 'notify user', allowing post-upload automation. |
| BusinessUnit | String | The business unit associated with the expense report, used for organizational classification and reporting purposes. |
| ExpenseReportId | Long | Unique identifier for the related expense report, linking attachments and other data elements to a specific expense record for easy reference. |
| Finder | String | Search term or filter used to locate specific records or attachments, typically used in search functionality within the system. |
| SysEffectiveDate | String | System-defined effective date used to determine the validity of data for specific time periods, ensuring the correct data is accessed or processed. |
| CUReferenceNumber | Int | Identifier used to relate child aggregates to parent tables, typically used for managing hierarchical or aggregated data structures. |
| EffectiveDate | Date | Date representing when a resource or record became effective, helping to filter data and retrieve only relevant information based on the specified start date. |
Highlights potential duplicate expenses within a report, flagging lines that share similar attributes for review.
| Name | Type | Description |
| ExpenseReportsExpenseReportId [KEY] | Long | Unique identifier for an expense report within the system, used to track and manage individual expense reports. |
| ExpenseExpenseId [KEY] | Long | Identifier for the expense record, linking it to the specific transaction or financial activity. |
| ExpenseId | Long | Unique identifier for the parent expense in cases where a duplicate expense is detected, ensuring proper tracking of related expenses. |
| DuplicateExpenseId | Long | Unique identifier for a specific duplicate expense entry, enabling the distinction between original and duplicate expenses. |
| DuplicateStatusCode | String | Flag indicating whether the expense is recognized as a duplicate; possible values include 'Duplicate' or 'Non-Duplicate'. |
| DuplicateGroupId | Long | Identifier for a set of duplicate expenses grouped together, helping to manage and identify patterns of duplicated spending. |
| DuplicateExpenseSource | String | Code representing the source of the duplicate expense; options include 'CASH' or 'CORP_CARD' for cash and corporate card transactions. |
| DuplicateReceiptAmount | Decimal | The amount stated on the duplicate expense receipt, expressed in the receipt's currency, used for financial reconciliation. |
| DuplicateReceiptCurrencyCode | String | Currency code for the duplicate expense receipt, indicating the currency in which the expense was recorded. |
| DuplicateLocation | String | Geographical location where the duplicate expense occurred, providing context for expense analysis and validation. |
| DuplicateDescription | String | Detailed description of the duplicate expense item, typically including details like the nature of the expense or reason for duplication. |
| DuplicateMerchantName | String | Name of the merchant or vendor where the duplicate expense occurred, used for vendor tracking and reconciliation. |
| DuplicateStartDate | Date | The date when the duplicate expense occurred or the start of a range of dates for an expense that spans multiple days. |
| DuplicateEndDate | String | The end date of the duplicate expense period, especially for multi-day expenses, to clearly define the duration of the duplication. |
| DuplicateCreationDate | Datetime | Timestamp of when the duplicate expense entry was created in the system, used for audit and tracking purposes. |
| DuplicateCreationMethodCode | String | Code representing the method used to create the duplicate expense entry, such as manual entry or automated import. |
| DuplicateExpenseType | String | Type of expense that has been flagged as a duplicate, helping to categorize and process duplicate expenses based on type. |
| DuplicateExpenseReportId | Long | Unique identifier for the specific expense report to which the duplicate expense belongs, ensuring proper linking within the system. |
| DuplicateExpenseStatusCode | String | Approval status of the duplicate expense within the expense report workflow, such as 'Approved', 'Pending Manager Approval', or 'Paid'. |
| DuplicateCreditCardTrxnId | Long | Identifier for the corporate credit card transaction linked to the duplicate expense, providing a direct connection to the transaction record. |
| DuplicateExpenseReportNumber | String | Unique number assigned to the duplicate expense report, following the company’s established numbering conventions for expense reports. |
| BusinessUnit | String | Identifier for the business unit associated with the expense, useful for categorizing expenses by organizational unit for reporting purposes. |
| ExpenseReportId | Long | Identifier for the expense report, linking the expense to a specific report for review and processing. |
| Finder | String | Search term or filter used in the system to locate or display specific expense records or reports, aiding in navigation and querying. |
| SysEffectiveDate | String | Date representing when the system’s data became effective, often used for data versioning and historical tracking. |
| CUReferenceNumber | Int | Reference number used to link child aggregate records with their corresponding parent records, maintaining data integrity and hierarchical relationships. |
| EffectiveDate | Date | Date parameter used to filter records by their effective date, ensuring only relevant resources as of that date are retrieved. |
Lists attendees or participants for specific expense items, ensuring accurate reimbursements for group-related expenses.
| Name | Type | Description |
| ExpenseReportsExpenseReportId [KEY] | Long | Unique identifier for the expense report, used to track and reference each specific expense report within the system. |
| ExpenseExpenseId [KEY] | Long | Unique identifier for the expense record, used to reference a specific expense entry within an expense report. |
| Amount | Decimal | The total amount spent on the event attendee, typically representing the cost associated with the attendee's participation in the event. |
| AttendeeType | String | Indicates the type of event attendee. Possible values are 'EMPLOYEE' for company staff or 'NONEMPLOYEE' for external participants. |
| CreatedBy | String | Username of the individual who created the row, used for tracking data origin and accountability. |
| CreationDate | Datetime | Timestamp indicating the date and time when the row was created, providing a record of when the data was first entered into the system. |
| EmployeeFlag | Bool | Boolean value indicating whether the event attendee is an employee of the company (true) or not (false). |
| EmployerAddress | String | The address of the employer associated with the event attendee, typically used to verify the employment relationship for nonemployees. |
| EmployerName | String | The name of the employer associated with the event attendee, relevant for external participants and used in reporting. |
| EmployerPartyId | Long | Unique identifier for the employer party, used to reference the specific employer in relational data models. |
| ExpenseAttendeeId [KEY] | Long | Unique identifier for the event attendee, used to link each expense entry to a specific person attending the event. |
| ExpenseId | Long | Unique identifier for the expense item, used to link specific expenses to the broader expense report. |
| LastUpdateDate | Datetime | Timestamp indicating the last time the row was updated, critical for maintaining data freshness and tracking modifications. |
| LastUpdateLogin | String | Login ID of the user who last updated the row, used for tracking who made the most recent changes. |
| LastUpdatedBy | String | Username of the individual who last updated the row, useful for auditing and ensuring accountability in system changes. |
| Name | String | Full name of the event attendee, either employee or nonemployee, used for identifying the individual within the expense report. |
| TaxIdentifier | String | Tax identification number of the event attendee, required for tax reporting and to differentiate individuals for tax purposes. |
| Title | String | Title (for example, Mr., Mrs., Dr.) of the event attendee, typically used for formal documentation and reporting. |
| AttendeeEmail | String | Email address of the event attendee, enabling communication regarding the event and associated expenses. |
| AttendeePhoneNumber | String | Phone number of the event attendee, used for contacting the individual in relation to event details or expense questions. |
| BusinessUnit | String | The business unit within the organization to which the event attendee is associated, used for internal categorization and reporting. |
| ExpenseReportId | Long | Unique identifier for the expense report to which the expense record belongs, used to group expenses for processing. |
| Finder | String | A search term or identifier used to locate specific records or groupings of data within the system. |
| SysEffectiveDate | String | The system-defined effective date, used to track the point in time from which data or changes are valid. |
| CUReferenceNumber | Int | Reference number used to map child aggregates to parent tables, supporting hierarchical relationships in data. |
| EffectiveDate | Date | The date from which the data is considered effective, typically used in queries to filter records by their relevance to a specific start date. |
Provides descriptive flexfields for additional, organization-specific data on individual expense items.
| Name | Type | Description |
| ExpenseReportsExpenseReportId [KEY] | Long | Unique identifier for the expense report within the Oracle Financial Cloud system, used for tracking and referencing specific reports. |
| ExpenseExpenseId [KEY] | Long | Unique identifier for the expense record, helping to distinguish individual expenses within the report. |
| ExpenseId [KEY] | Long | Identifier for the expense within the related ExpenseReportsExpenseExpenseDff table, used to link the expense data. |
| _FLEX_Context | String | Context for the flexfield, used to manage and identify the environment or system-specific data for the 'ExpenseReportsExpenseExpenseDff'. |
| BusinessUnit | String | The business unit associated with the expense, used for categorizing financial data and reporting purposes within Oracle Financial Cloud. |
| ExpenseReportId | Long | Unique identifier for the expense report, used to link attachments and related data to a specific report in the system. |
| Finder | String | A search or filter term used to locate and retrieve specific records within the financial system or reports. |
| SysEffectiveDate | String | The system-defined effective date, used to manage the validity and relevance of data at specific time points. |
| CUReferenceNumber | Int | A reference number used to link child aggregates to parent tables, helping in the hierarchical data organization within the financial system. |
| EffectiveDate | Date | Date that specifies when the resource is effective, often used in queries to fetch data relevant to a specific time period. |
Shows how costs from a single expense line are allocated across multiple accounts, departments, or cost centers.
| Name | Type | Description |
| ExpenseReportsExpenseReportId [KEY] | Long | Unique identifier for the expense report in the system, used to track and reference individual expense reports. |
| ExpenseExpenseId [KEY] | Long | Unique identifier for each expense item, enabling the identification and tracking of individual expenses. |
| CodeCombinationId | Long | Unique identifier for the accounting code combination used to categorize and allocate the expense. |
| CostCenter | String | The business unit or department to which an expense is charged, helping to track expenditures by organizational segment. |
| CreatedBy | String | Username of the individual who created the record, used for auditing and tracking the origin of the entry. |
| CreationDate | Datetime | Timestamp indicating when the expense record was created, important for tracking the timeline of financial data entry. |
| ExpenseDistId [KEY] | Long | Unique identifier for the expense distribution, linking a specific expense item to its distribution. |
| ExpenseId | Long | Unique identifier for the expense item within an expense distribution, used to associate distributions with the corresponding expense. |
| ExpenseReportId | Long | Unique identifier linking an expense distribution to a specific expense report for consolidation and review. |
| LastUpdateDate | Datetime | Timestamp indicating when the record was last modified, useful for tracking changes and maintaining version history. |
| LastUpdateLogin | String | Session login ID of the user who last updated the record, used for security and auditing purposes. |
| LastUpdatedBy | String | Username of the user who last updated the record, providing accountability for data changes. |
| OrgId | Long | Unique identifier for the organization associated with the expense, enabling segmentation of expenses by organizational unit. |
| ReimbursableAmount | Decimal | The amount to be reimbursed to the individual for an expense distribution, used for processing reimbursements. |
| Company | String | The company to which an expense is allocated, essential for tracking expenses at the organizational level. |
| BusinessUnit | String | The specific business unit associated with the expense record, helping to categorize expenses within different units. |
| Finder | String | A search key or filter used to locate specific records or transactions within the system. |
| SysEffectiveDate | String | System-defined effective date used to determine when an expense record or distribution is considered valid. |
| CUReferenceNumber | Int | Identifier used to map child aggregates with parent tables, facilitating the relationship between child and parent data. |
| EffectiveDate | Date | Date used to fetch resources based on their effective start date, ensuring that data retrieved is valid for the given date. |
Offers project-centric descriptive flexfields for expense item distributions, integrating project cost details.
| Name | Type | Description |
| ExpenseReportsExpenseReportId [KEY] | Long | Unique identifier for the expense report in the system. It is used to track and reference specific reports within the expense management process. |
| ExpenseExpenseId [KEY] | Long | Unique identifier for an individual expense record within the expense report. It helps in linking individual expenses to their respective reports. |
| ExpensedistributionExpenseDistId [KEY] | Long | Unique identifier for the expense distribution record. It tracks how the total expense is distributed across different accounts or categories. |
| ExpenseDistId [KEY] | Long | Identifier used for linking the expense distribution records in the ExpenseReportsExpenseExpenseDistributionPJCDFF table, assisting in the organization of expense data. |
| _FLEX_Context | String | Context identifier related to the flexible data structure used for capturing additional information specific to the expense distribution in the ExpenseReportsExpenseExpenseDistributionPJCDFF. |
| _FLEX_Context_DisplayValue | String | Display value of the FLEX context field, providing a human-readable reference for the specific context of the expense distribution within the system. |
| BusinessUnit | String | The business unit associated with the expense report or distribution. It helps categorize expenses by the specific department or unit within the organization. |
| ExpenseReportId | Long | The unique identifier linking this record to a specific expense report, allowing for easy association between records and their corresponding report. |
| Finder | String | A search parameter used for filtering and locating specific expense records based on certain criteria. It assists in querying and retrieving relevant records. |
| SysEffectiveDate | String | System-defined effective date used for tracking when changes to a record become applicable. It ensures that the data is current and valid based on the specified date. |
| CUReferenceNumber | Int | Reference number used to map child aggregate records to parent tables, enabling relational data organization and ensuring consistency across hierarchical structures. |
| EffectiveDate | Date | The date used to fetch records that are effective as of the specified date, commonly used in queries to retrieve resources valid from that date onward. |
Captures validation errors related to an expense item, allowing users to address issues before final submission.
| Name | Type | Description |
| ExpenseReportsExpenseReportId [KEY] | Long | Unique identifier for an expense report, used to reference and track specific expense reports within the Oracle Financial Cloud system. |
| ExpenseExpenseId [KEY] | Long | Unique identifier for an individual expense entry, helping to differentiate and track each expense record. |
| Name | String | The name associated with a specific attribute in an expense validation error, used to identify the type of validation failure. |
| ErrorCode | String | A code that represents the specific error encountered during expense validation, used for categorizing and identifying issues in the data. |
| ErrorSequence [KEY] | Int | A unique identifier for each expense validation error, helping to track multiple errors related to the same report or record. |
| ErrorDescription | String | A detailed explanation of the specific error encountered during the validation of an expense, providing more context for troubleshooting. |
| Type | String | Indicates whether the validation issue is classified as an error or a warning, assisting in understanding the severity of the issue. |
| BusinessUnit | String | The organizational unit associated with the expense report, typically used to categorize and report on financial data by business segment or division. |
| ExpenseReportId | Long | Identifier for the associated expense report, used to link and reference expenses within a specific report for tracking and analysis. |
| Finder | String | A search term or filter used to locate specific records or attachments within the system, often used in search queries or filters. |
| SysEffectiveDate | String | The system-defined date that indicates when the record is effective within the system, often used to track changes or updates. |
| CUReferenceNumber | Int | Reference number used to link child aggregates (sub-records) to their parent records, typically used for hierarchical or related data. |
| EffectiveDate | Date | The date used to filter resources that are valid as of a specific start date, helping to fetch data relevant to a specific time frame. |
Breaks down a single expense into multiple sub-items (for example, hotel bill itemization), improving transparency and accuracy.
| Name | Type | Description |
| ExpenseReportsExpenseReportId [KEY] | Long | Unique identifier for an expense report within the system, used for referencing and tracking specific reports. |
| ExpenseExpenseId [KEY] | Long | Unique identifier for an expense entry within the report, used to distinguish individual expenses. |
| AssignmentId | Long | Identifies the individual associated with a specific expense entry, helping to track ownership and responsibility. |
| AuditAdjustmentReason | String | Reason provided by the auditor for adjusting a reimbursable amount, necessary for tracking audit decisions. |
| AuditAdjustmentReasonCode | String | Code representing the auditor's reason for adjusting the reimbursable amount, offering a standardized way of documenting audit actions. |
| AwtGroupId | Long | Unique identifier for an alternate tax withholding group, allowing the system to manage different withholding groups. |
| BilledAmount | Decimal | Amount billed to a corporate card account, used to track spending and corporate card transactions. |
| BilledCurrencyCode | String | Currency code representing the billed amount, ensuring the correct currency is used for billing and accounting. |
| CardId | Long | Unique identifier for a specific corporate card used in transactions, important for linking expenses to the correct card. |
| CheckoutDate | Date | Date when an individual departs from a location associated with accommodations expenses, used for tracking the duration of business trips. |
| CreatedBy | String | Username of the individual who created the record, aiding in accountability and tracking who initiated the transaction. |
| CreationDate | Datetime | Date and time the record was created, providing a timestamp for when the expense or transaction was entered into the system. |
| CreditCardTrxnId | Long | Transaction ID associated with a specific corporate card transaction, allowing the system to match receipts and payments. |
| DailyAmount | Decimal | The amount of the daily expense receipt in the receipt's currency, providing insight into daily spending. |
| DailyDistance | Decimal | Distance traveled in a day for business, used for calculating mileage and transportation expenses. |
| DailyLimit | String | Daily spending limit for a trip, helping to enforce company policies on allowable daily expenses. |
| DepartureLocationId | Long | Unique identifier for the departure location in an expense, used to track travel routes and origins. |
| Description | String | A textual description of an expense item, providing context or explanation for the associated costs. |
| DestinationFrom | String | The starting or departure location for the trip, important for route planning and tracking travel expenses. |
| DestinationTo | String | The ending or arrival location for the trip, used in conjunction with 'DestinationFrom' to track the full travel route. |
| DistanceUnitCode | String | Code that specifies the unit of measurement for travel distance, typically KILOMETER or MILE, ensuring consistency in reporting. |
| EndDate | String | The last day of an expense that spans multiple days, used to track the full duration of multi-day travel or business activities. |
| EndOdometer | Decimal | Odometer reading at the end of a trip, used for mileage reimbursements and travel data accuracy. |
| ExchangeRate | Decimal | Rate at which one currency can be exchanged for another at a specific point in time, ensuring proper conversion for international expenses. |
| ExpenseCategoryCode | String | Code used to classify an expense item, with possible values such as BUSINESS or PERSONAL, helping to categorize spending. |
| ExpenseCreationMethodCode | String | Code indicating the method used to create an expense, with possible values like MOBILE iOS DEVICE or MOBILE ANDROID DEVICE, to track creation sources. |
| ExpenseId [KEY] | Long | Unique identifier for a specific expense item, allowing for precise tracking and reporting of each expense. |
| ExpenseReportId | Long | Unique identifier for a specific expense report, linking multiple expenses together for approval and reimbursement processes. |
| ExpenseSource | String | Code representing the source of an expense, such as CASH or CORP_CARD, to identify how the expense was paid. |
| ExpenseTemplateId | Long | Unique identifier for a specific expense template, used to standardize and automate the creation of common expense reports. |
| ExpenseTypeId | Long | Unique identifier for an expense type, used to categorize expenses for reporting and policy enforcement. |
| FlightClassLimit | String | Expense limit for a specific flight class, used to control spending on different flight categories. |
| FlightDuration | Decimal | Duration of a flight in hours, relevant for calculating per diem or other time-based travel expenses. |
| FlightNumber | String | Unique identifier for a specific airline flight, used to track travel itineraries and flight-related expenses. |
| FuelType | String | Types of fuel eligible for reimbursement, defining what fuel charges are acceptable for reimbursement. |
| ImgReceiptRequiredFlag | Bool | Flag indicating whether an expense requires an image of the receipt, used for ensuring compliance with documentation standards. |
| ItemizationParentExpenseId | Long | Identifier for the parent expense of an itemized expense. Values include NULL (not itemized), -1 (parent line with itemization), and greater than 0 (itemized child line). |
| ItemizationReceiptBusinessTotalAmount | Decimal | Total amount to be reimbursed for business expenses on an itemized receipt. |
| ItemizationReceiptPersonalTotalAmount | Decimal | Amount on the receipt allocated to personal expenses, not reimbursable by the employer. |
| ItineraryReservationId | Long | Unique identifier for a travel reservation, used to link expenses to specific bookings or itineraries. |
| Justification | String | Text providing the reason for incurring an expense, necessary for compliance and approval processes. |
| JustificationRequiredFlag | Bool | Flag indicating whether an expense requires justification, ensuring that all expenses have a valid reason for being incurred. |
| LastUpdateDate | Datetime | Date and time when the record was last updated, providing a timestamp for modifications or corrections. |
| LastUpdatedBy | String | Username of the individual who last updated the record, helping to track changes and maintain accountability. |
| LicensePlateNumber | String | Number of the vehicle's license plate, used for tracking mileage or vehicle-related expenses. |
| Location | String | The location where the expense was incurred, helping to categorize expenses based on geographic location. |
| LocationId | Long | Unique identifier for a specific expense location, used to link the expense to a designated site or area. |
| LongTermTripFlag | Bool | Flag indicating whether a trip is considered long-term, relevant for per diem and other long-term travel policies. |
| LongTermTripStartDate | Date | Date when a long-term trip started, used to track the duration and apply specific policies for extended travel. |
| MerchantDocumentNumber | String | Document number provided by the merchant on the receipt, used for verifying and matching receipts. |
| MerchantName | String | Name of the merchant where the expense was incurred, important for verifying transactions and reconciling purchases. |
| MerchantReference | String | Purchase identification provided by the merchant, used for transaction tracking and verification. |
| MerchantTaxRegNumber | String | Tax registration number assigned to a merchant by a tax authority, important for compliance and tax reporting. |
| MerchantTaxpayerId | String | Unique identifier for a merchant's taxpayer registration, ensuring proper tax tracking and reporting. |
| MileagePolicyId | Long | Unique identifier for the mileage policy applied to an expense, used for ensuring compliance with company policies. |
| NumberOfAttendees | Decimal | Number of people who attended an event for which expenses were incurred, useful for business entertainment expense tracking. |
| NumberOfDays | Int | Number of days for which the expense was incurred, helping to track and approve multi-day expenses. |
| NumberPeople | Int | Number of passengers in a vehicle, relevant for calculating vehicle-related expenses or reimbursements. |
| OrgId | Long | Unique identifier for the business unit associated with the expense, used to categorize and allocate expenses by department. |
| PassengerAmount | Decimal | Total reimbursement amount for carrying passengers in a vehicle, used to calculate travel and transportation expenses. |
| PassengerName | String | Name of a passenger in a vehicle or on a flight, used for tracking and verifying travel-related expenses. |
| PassengerRateType | String | Type of rate used for passenger-related mileage reimbursement, relevant for calculating transport costs. |
| PaymentDueFromCode | String | Code that indicates the liability owner for a transaction, ensuring proper payment responsibility. |
| PersonId | Long | Unique identifier for the person associated with an expense, helping to track individual expenses and payments. |
| PersonalReceiptAmount | Decimal | Amount of a receipt marked as personal, not eligible for reimbursement by the company. |
| PolicyShortpayFlag | Bool | Flag indicating whether an expense has been short-paid due to policy violations, ensuring compliance with company reimbursement policies. |
| PolicyViolatedFlag | Bool | Flag indicating whether an expense violates company policies, used for enforcement and auditing purposes. |
| PolicyWarningFlag | Bool | Flag indicating whether a policy warning has been applied to an expense, helping to monitor compliance. |
| PolicyWarningReasonCode | String | Code representing the reason for a warning issued by an auditor, ensuring transparency in the audit process. |
| PreparerId | Long | Unique identifier for the person who created the expense report, important for accountability and tracking. |
| RatePerPassenger | Decimal | Rate per passenger for mileage reimbursement, helping to calculate transport expenses fairly. |
| ReceiptAmount | Decimal | Total amount of the receipt in the currency of the receipt, used for tracking and verifying expense amounts. |
| ReceiptCurrencyCode | String | Currency code for the receipt's currency, ensuring the correct exchange rate and amount are used. |
| ReceiptDate | Date | Date when a receipt was generated, helping to verify the timing of an expense. |
| ReceiptMissingDecRequiredFlag | Bool | Flag indicating whether a declaration is required for missing receipts, used for maintaining proper documentation. |
| ReceiptMissingFlag | Bool | Flag indicating whether receipts are missing for an expense, ensuring compliance with receipt submission requirements. |
| ReceiptRequiredFlag | Bool | Flag indicating whether a receipt is required for the expense, ensuring proper documentation for reimbursement. |
| ReceiptVerifiedFlag | Bool | Flag indicating whether an auditor has verified the receipt for an expense, ensuring proper validation. |
| ReimbursableAmount | Decimal | Amount eligible for reimbursement in the specified currency, ensuring accurate calculations of what can be reimbursed. |
| ReimbursementCurrencyCode | String | Currency code for the amount to be reimbursed, ensuring consistency in currency conversion and reporting. |
| SequenceNumber | Decimal | Number indicating the sequence of expenses within a report, helping to maintain the correct order for review. |
| StartDate | Date | Date when the expense occurred or the first day of a multi-day expense, used for tracking the time frame of the expense. |
| TaxClassificationCode | String | Code representing the tax classification applied to an expense, ensuring accurate tax reporting and compliance. |
| TicketClassCode | String | Code representing the class of a flight or ticket, used to track expenses by class for reporting or policy enforcement. |
| TicketNumber | String | Unique identifier for a specific airline ticket, important for verifying travel and related expenses. |
| TravelMethodCode | String | Code indicating the method of travel used during a trip, helping to categorize transportation-related expenses. |
| TravelType | String | Code representing the type of flight, with possible values DOMESTIC or INTERNATIONAL, used to track travel expenses. |
| TripDistance | Decimal | Total distance traveled during a trip, important for calculating mileage and transport reimbursements. |
| UOMDays | Decimal | Number of days for per diem expenses, based on the unit of measure, used to calculate daily allowances. |
| ValidationErrorFlag | Bool | Flag indicating whether a validation error occurred, helping auditors and users track data integrity issues. |
| ValidationErrorMessages | String | Messages that describe errors encountered during validation, useful for debugging and improving data quality. |
| ValidationWarningMessages | String | Messages that describe warnings encountered during validation, important for user awareness of potential issues. |
| VehicleCategoryCode | String | Code that categorizes the type of vehicle used for the trip, with possible values COMPANY, PRIVATE, or RENTAL. |
| VehicleType | String | Type of vehicle used for transportation, with possible values CAR, MOTORCYCLE, or VAN, helping to categorize travel-related expenses. |
| ZoneCode | String | Code representing the geographical zone of the trip, used for calculating distance-based reimbursements. |
| ZoneTypeCode | String | Code that defines the lookup type for geographical zones, used to apply mileage rates for different regions. |
| ExpenseType | String | Type of expense, used to categorize and define which expenses are eligible for reimbursement. |
| BusinessUnit | String | Identifies the business unit associated with the expense record, used for internal reporting and allocation. |
| Finder | String | Search term or filter used to locate specific records in the system, making it easier to find and manage expense entries. |
| SysEffectiveDate | String | The effective date of the system configuration, used to apply the correct settings or rules for the current period. |
| CUReferenceNumber | Int | Reference number linking child aggregates to parent tables, used for ensuring correct data hierarchy and reporting. |
| EffectiveDate | Date | Date used to filter resources that are effective as of a specific point in time, essential for time-sensitive data operations. |
Identifies expense lines matched with existing records (such as credit card transactions), reducing redundant entries.
| Name | Type | Description |
| ExpenseReportsExpenseReportId [KEY] | Long | Unique identifier for an expense report within the Oracle Financial Cloud system. This ID is used to track and reference specific expense reports across the platform. |
| ExpenseExpenseId [KEY] | Long | Unique identifier for a specific expense record within the system. This ID helps differentiate between individual expenses and is essential for expense management. |
| MatchedExpenseId | Long | Expense identifier of a matched record, representing an expense that has been matched with another record, typically in a reconciliation or audit process. |
| ExpenseId | Long | Unique identifier of an expense in the system, used for tracking and referencing individual expense entries across the platform. |
| MergedFlag | String | Flag indicating whether two or more expenses have been merged after a match. This helps in managing duplicate records or consolidating expenses. |
| MatchPercentage | Decimal | Percentage value that represents the strength of the match between two expense records. A higher percentage indicates a stronger match. |
| MatchReference [KEY] | String | Unique identifier for a matched record, typically used in reconciliation or audit processes to track the relationship between matched expenses. |
| BusinessUnit | String | The business unit associated with the expense report. This is used for categorizing expenses by organizational divisions or departments for reporting and budgeting. |
| ExpenseReportId | Long | Unique identifier for the associated expense report. This ID links individual expenses to a specific expense report for consolidated reporting. |
| Finder | String | Search term or filter used to locate specific records, such as an expense or report, within the system, typically used in query or search functionalities. |
| SysEffectiveDate | String | System-defined effective date, which indicates when the data in the record becomes valid. Used for managing and querying records based on their validity period. |
| CUReferenceNumber | Int | Identifier that links child aggregates to parent tables in the database. This reference is crucial for maintaining relationships within hierarchical data structures. |
| EffectiveDate | Date | The date that marks the start of the effective period for the resource, allowing the system to retrieve resources or records that are valid as of the specified date. |
Stores remarks or instructions from approvers or auditors regarding the entire expense report, aiding clarity and resolution.
| Name | Type | Description |
| ExpenseReportsExpenseReportId [KEY] | Long | Unique identifier for the expense report, used to track and reference specific expense reports within the system. |
| CreatedBy | String | Username of the individual who created the expense note, providing accountability and ownership of the note. |
| CreationDate | Datetime | Timestamp indicating when the expense note was created, useful for tracking and organizing notes chronologically. |
| ExpenseReportId | Long | Unique identifier for the expense report related to the expense note, establishing a relationship between the note and the report. |
| ExpenseReportProcessingId [KEY] | Long | Identifier representing the specific processing details of an expense report, often tied to workflow or approval status. |
| Event | String | Description of the event that triggered a change in the status of the expense report, such as approval or audit. |
| FullName | String | Name of the person associated with the expense note, typically the individual who either created or is referenced in the note. |
| LastUpdatedBy | String | Username of the individual who last updated the expense note, important for tracking changes and modifications. |
| LastUpdateDate | Datetime | Timestamp indicating the last time the expense note was updated, helping to maintain an accurate audit trail. |
| LastUpdateLogin | String | Session login associated with the user who last updated the expense note, used for tracking system access during updates. |
| NoteId | Long | Unique identifier for the expense note, used to track the specific note that was created after a status change of the report. |
| NoteText | String | Text content of the expense note, typically describing the context of the approval or audit action taken on the expense report. |
| NoteTextTrunc | String | The first 1,024 characters of the note, providing a preview of the full content typically displayed in the user interface. |
| NoteTypeCode | String | Code representing the category of the expense note, helping to classify and filter notes based on their type (for example, approval, audit). |
| PersonId | Long | Unique identifier for the person associated with the expense note, used for linking notes to specific individuals in the system. |
| SourceObjectCode | String | Code associated with the source object (for example, activities, opportunities) as defined in the OBJECTS Metadata, providing context for the origin of the note. |
| SourceObjectUid | String | Unique identifier for the source object, such as activities or opportunities, allowing the expense note to be linked to specific entities. |
| UserLastUpdateDate | Datetime | Date and time when the user last updated the record on a disconnected mobile device, ensuring data synchronization is tracked. |
| BusinessUnit | String | The business unit associated with the expense report, used for categorizing and organizing data based on the department or organizational unit. |
| Finder | String | Search term or filter used to locate and display specific records or entries in the system, enhancing search functionality. |
| SysEffectiveDate | String | System-defined date indicating when the record or data is considered effective within the system, ensuring accurate data reporting. |
| CUReferenceNumber | Int | Reference number used to link child aggregates with parent tables, facilitating hierarchical data relationships. |
| EffectiveDate | Date | Date used as a parameter to fetch resources that are effective as of a specified start date, important for handling time-sensitive data. |
Details payment-related information (dates, amounts) for reimbursed expense reports, ensuring visibility into disbursement status.
| Name | Type | Description |
| ExpenseReportsExpenseReportId [KEY] | Long | Unique identifier for the expense report within the system, used to track and reference specific reports for reimbursement. |
| PaymentDate | Date | The date when the payment for the expense report is processed and completed. |
| PaymentAmount | Decimal | The total amount paid in relation to the expense report, representing the reimbursement amount. |
| PaymentCurrencyCode | String | The currency code in which the payment is made, helping to identify the type of currency used in the transaction. |
| CheckNumber | Long | The unique bank-issued check number associated with the payment for the expense report. |
| CheckId | Long | The unique identifier for the check used to process the payment, often linked to payment records in the system. |
| PaymentNumber | Long | A sequential number assigned to the payment, used to track and reference individual payment transactions. |
| InvoiceId | Long | A unique identifier for the invoice associated with the payment, used for linking payment to the corresponding invoice. |
| PaymentMethod | String | The method used for payment, such as check, cash, or credit, indicating how the reimbursement was processed. |
| PaymentMethodCode | String | A code that represents the method of payment, used for categorizing and identifying different types of payment methods. |
| ExpenseReportId [KEY] | Long | The unique identifier for the specific expense report, linking payments to the correct report in the system. |
| MailingAddress | String | The employee’s mailing address where the reimbursement is sent, typically used for checks or physical payment processing. |
| BankAccountNumber | String | The employee’s bank account number into which the expense payment is deposited, enabling electronic transfers. |
| BankName | String | The name of the bank where the employee’s bank account is held, helping to identify the financial institution used for payments. |
| ProcessingType | String | The processing method for the payment, such as 'PRINTED' for checks or 'ELECTRONIC' for direct deposits. |
| BusinessUnit | String | The business unit within the company associated with the expense report, used for organizational reporting and budget allocation. |
| Finder | String | A search term or keyword used to filter records or identify specific entries within the system. |
| SysEffectiveDate | String | A system-defined date that represents when a particular record or data entry becomes effective in the system. |
| CUReferenceNumber | Int | A reference number used to link child aggregates to their parent tables, often used for data relationships in hierarchical structures. |
| EffectiveDate | Date | The date from which a resource or record is considered effective, used in filtering queries to return relevant data as of that date. |
Includes custom flexfield data at the expense report header level, aligning the report with unique organizational processes.
| Name | Type | Description |
| ExpenseReportsExpenseReportId [KEY] | Long | Unique identifier for each expense report within the system, used to track and reference specific expense reports in various operations and reports. |
| ExpenseReportId [KEY] | Long | Identifier of the related expense report in the ExpenseReportsExpenseReportDff table, linking the report to additional financial data and details. |
| _FLEX_Context | String | Contextual information for the flexfield structure of the ExpenseReportsExpenseReportDff table, used to define the specific configuration for the expense report. |
| _FLEX_Context_DisplayValue | String | Display value for the flexfield context of the ExpenseReportsExpenseReportDff table, which provides a human-readable description of the context for user interfaces. |
| BusinessUnit | String | The business unit to which the expense report is assigned, helping to categorize financial data by organizational division for reporting and management. |
| Finder | String | Search term or key used to locate specific records or attachments related to the expense report, typically used for searching or filtering reports. |
| SysEffectiveDate | String | System-defined effective date, specifying when the data becomes valid within the system, often used for managing historical and future state data. |
| CUReferenceNumber | Int | Reference number used to link child aggregates (for example, transaction details) to their corresponding parent records, enabling hierarchical data relationships. |
| EffectiveDate | Date | The effective date from which the expense report or related resource is valid, commonly used to filter records that are applicable based on their start date. |
Logs status changes and processing steps (for example, approvals, rejections) for an expense report, providing an audit trail.
| Name | Type | Description |
| ExpenseReportsExpenseReportId [KEY] | Long | Unique identifier for the expense report, used to track and reference specific expense reports within the system. |
| ExpenseReportProcessingId [KEY] | Long | Unique identifier for the processing details associated with a specific expense report, enabling tracking of processing events. |
| ExpenseReportId | Long | Identifier for the expense report, used to track its status and changes throughout the approval and audit process. |
| Event | String | The specific event that triggered a status change in the expense report, such as 'Approval', 'Audit', or 'Rejection'. |
| EventPerformerId | String | Unique identifier for the user who initiated the status change event in the expense report, useful for tracking and auditing purposes. |
| EventPerformerName | String | Full name of the person who initiated the expense report status change event, helping to identify responsible parties. |
| ExpenseStatusCode | String | Code representing the current status of the expense report, such as 'Approved', 'Pending Manager Approval', or 'Paid'. |
| AuditCode | String | Code indicating the type of audit performed on the expense report, such as 'Original Receipt Audit' or 'Imaged Receipt Audit'. |
| AuditReturnReasonCode | String | Code indicating the reason for returning the expense report to the submitter during the audit process, such as 'Missing Documentation'. |
| EventDate | Date | Date when the expense report status was last updated, helping to track the timeline of the approval and audit process. |
| CreationDate | Datetime | Timestamp indicating when the processing detail record for the expense report was created, useful for data tracking and historical analysis. |
| NoteId | Long | Unique identifier for the note created by the user who performed the status change event, often used to record reasons or additional details. |
| BusinessUnit | String | Name or identifier of the business unit associated with the expense report, used for classification and financial reporting. |
| Finder | String | Search term or filter used to locate specific records or attachments related to the expense report, typically used for query functionality. |
| SysEffectiveDate | String | System-defined effective date, used to manage the validity of records and track changes in system data over time. |
| CUReferenceNumber | Int | Identifier used to link child aggregate data to parent tables in the financial data model, enabling hierarchical reporting. |
| EffectiveDate | Date | Date parameter used in queries to fetch records or data that are effective as of the specified start date, ensuring accurate historical data retrieval. |
Handles attachments directly tied to individual expenses, enhancing record completeness and verification.
| Name | Type | Description |
| ExpensesExpenseId [KEY] | Long | Unique identifier for the expense record. This ID is used to reference and track specific expenses in the system. |
| AttachedDocumentId [KEY] | Long | Unique identifier for the document attached to the expense record, facilitating file management and retrieval. |
| LastUpdateDate | Datetime | Timestamp indicating the last time the expense record was updated, useful for tracking changes and version control. |
| LastUpdatedBy | String | Username of the individual who last updated the expense record, providing audit trail and accountability. |
| DatatypeCode | String | Code that indicates the data type of the element, aiding in data validation and type-specific operations. |
| FileName | String | The name of the file associated with the attachment, which helps in identifying and accessing the file. |
| DmFolderPath | String | The folder path in the document management system where the attached file is stored, allowing for structured file organization. |
| DmDocumentId | String | Document ID representing the original document from which the attachment was created, used for document tracking. |
| DmVersionNumber | String | Version number of the document from which the attachment originates, helping to track document revisions. |
| Url | String | URL pointing to a web-based attachment, used to reference an external or online file related to the expense record. |
| CategoryName | String | The category under which the attachment is classified, aiding in organizing and filtering attachments. |
| UserName | String | Username of the individual who created the attachment, important for tracking user actions and file ownership. |
| Uri | String | URI pointing to the attachment in the Topology Manager system, used for managing and referencing attached files. |
| FileUrl | String | URL or link to access the file attached to the expense record, allowing users to download or view the file. |
| UploadedText | String | Text content included with a text attachment, typically used for adding comments, notes, or additional information to the record. |
| UploadedFileContentType | String | The content type of the uploaded attachment, specifying the format. |
| UploadedFileLength | Long | Size of the uploaded file in bytes, providing information for file size management and transfer considerations. |
| UploadedFileName | String | The name assigned to the new file being uploaded as an attachment, helping to identify and manage the file. |
| ContentRepositoryFileShared | Bool | Boolean flag indicating whether the file is shared with other users or systems, controlling file access permissions. |
| Title | String | The title given to the attachment, providing a brief and descriptive label for the file. |
| Description | String | Detailed description of the attachment, explaining its content, context, or relevance to the associated expense record. |
| ErrorStatusCode | String | Error code, if any, generated during the attachment process, useful for identifying and resolving issues. |
| ErrorStatusMessage | String | Detailed error message, if any, explaining the nature of any problems encountered during the attachment process. |
| CreatedBy | String | Username of the individual who initially created the expense record, useful for identifying the origin of the record. |
| CreationDate | Datetime | Timestamp of when the expense record was created, providing a reference for historical tracking and data integrity. |
| FileContents | String | The actual content of the attachment, which may include text, images, or other data stored as part of the file. |
| ExpirationDate | Datetime | The expiration date of the attachment, indicating when the content becomes outdated or no longer valid. |
| LastUpdatedByUserName | String | Username of the individual who last updated the record, helping to track modifications and maintain an audit trail. |
| CreatedByUserName | String | Username of the person who created the record, identifying the original creator for accountability purposes. |
| AsyncTrackerId | String | Unique identifier used by the attachment UI components for tracking and managing asynchronous file upload processes. |
| FileWebImage | String | Base64-encoded image representation of the file, typically used to display image previews in PNG format. |
| DownloadInfo | String | JSON object containing metadata and instructions for programmatically retrieving the attached file, useful for automation. |
| PostProcessingAction | String | The name of the action to be executed after the attachment is successfully uploaded, such as 'index', 'convert', or 'notify'. |
| ExpenseId | Long | Unique identifier for the expense entry, used to associate attachments with the correct expense record. |
| Finder | String | Search term or filter used to locate specific records or attachments, typically used in the system’s search functionality. |
| PersonId | String | Identifier for the person associated with the expense record, used for linking expenses to individuals in the system. |
| Request | String | The request associated with the expense record, typically referring to the request or approval process related to the expense. |
| SysEffectiveDate | String | System-defined effective date, used to manage the validity of data and its impact on financial reporting or processes. |
| CUReferenceNumber | Int | Reference number used to link child aggregates to parent tables, facilitating the management of hierarchical data. |
| EffectiveDate | Date | Date representing when the resource or expense record becomes effective, used for filtering records based on their validity date. |
Alerts users to expenses that may have been entered multiple times, aiding in cost control and policy enforcement.
| Name | Type | Description |
| ExpensesExpenseId [KEY] | Long | Unique identifier for each expense record, used to track and reference individual expenses within the system. |
| ExpenseId | Long | Value that uniquely identifies the parent expense associated with a duplicate expense, allowing for linking duplicates to their original expense. |
| DuplicateExpenseId | Long | Unique identifier for a specific duplicate expense item, helping to distinguish it from other expense records. |
| DuplicateStatusCode | String | Indicates whether an expense is a duplicate of another. Common values include 'Duplicate' or 'Original'. |
| DuplicateGroupId | Long | Unique identifier for a group of duplicate expenses, used for organizing and managing related duplicate entries. |
| DuplicateExpenseSource | String | Code that indicates the source of the duplicate expense, typically 'CASH' for cash expenses or 'CORP_CARD' for corporate card expenses. |
| DuplicateReceiptAmount | Decimal | Amount of the duplicate expense receipt in the currency in which the receipt was issued, important for accurate reimbursement or reporting. |
| DuplicateReceiptCurrencyCode | String | Currency code that represents the currency in which the duplicate expense receipt was issued, such as USD or EUR. |
| DuplicateLocation | String | The physical or virtual location where the duplicate expense was incurred, such as 'New York Office' or 'Online'. |
| DuplicateDescription | String | Detailed description of the duplicate expense item, providing context and details about the nature of the expense. |
| DuplicateMerchantName | String | Name of the merchant or vendor where the duplicate expense was incurred, typically a business or service provider. |
| DuplicateStartDate | Date | Date when the duplicate expense was first incurred, or the start date of a series of duplicate expenses that span multiple days. |
| DuplicateEndDate | String | Last date of the duplicate expense that spans multiple days, helping to define the time frame of the duplicate expense occurrence. |
| DuplicateCreationDate | Datetime | Timestamp of when the duplicate expense record was created in the system, aiding in tracking and auditing. |
| DuplicateCreationMethodCode | String | Code that indicates the method by which the duplicate expense was created, such as manual entry or automated system import. |
| DuplicateExpenseType | String | The type of expense for which the duplicate was recorded, such as 'Travel', 'Meals', or 'Office Supplies'. |
| DuplicateExpenseReportId | Long | Unique identifier for the expense report associated with the duplicate expense, allowing for easy reference and linking to reports. |
| DuplicateExpenseStatusCode | String | Approval status of the duplicate expense within its expense report, such as 'Approved', 'Pending Manager Approval', or 'Paid'. |
| DuplicateCreditCardTrxnId | Long | Unique identifier for the corporate card transaction related to the duplicate expense, enabling tracking and reconciliation of corporate card expenses. |
| DuplicateExpenseReportNumber | String | Unique number that references the expense report containing the duplicate expense, following company-specific numbering conventions for expense reports. |
| Finder | String | Search or filter term used in queries to locate specific expense records or related information in the database. |
| PersonId | String | Unique identifier for a person in the system, typically representing an employee, contractor, or individual associated with the expense. |
| Request | String | Request identifier used to link the expense to a particular request or approval process, often used in workflow management. |
| SysEffectiveDate | String | Date when the data record became effective in the system, helping to track and manage versioning and validity of records. |
| CUReferenceNumber | Int | Reference number that maps child aggregates (for example, individual transactions) to parent tables (for example, expense reports), supporting hierarchical data relationships. |
| EffectiveDate | Date | Date parameter used in queries to filter resources or records that are valid or effective as of the specified date, ensuring data relevance. |
Consolidates company-wide expense configurations and preferences, defining processes like workflow routing and policy thresholds.
| Name | Type | Description |
| OptionId [KEY] | Long | Unique identifier assigned to each row in the table, used to reference specific setup options. |
| OrgId | Long | Identifier of the business unit to which the setup option belongs, typically representing an organization or department. |
| OptionCode | String | A lookup code that uniquely identifies a specific setup option in the system, allowing for easy referencing. |
| OptionMeaning | String | The meaning or description associated with the setup option code, providing context to the option. |
| ValueCode | String | A lookup code that identifies a specific value for the setup option, typically representing predefined options or configurations. |
| ValueMeaning | String | The description or meaning of the value code, providing clarity on the option's function or purpose. |
| CreationDate | Datetime | The timestamp indicating when the row was initially created in the system, used for tracking data history. |
| CreatedBy | String | The username of the individual who created the row, helpful for auditing and accountability purposes. |
| LastUpdateLogin | String | The session login associated with the user who last updated the row, useful for tracking the origin of the last modification. |
| LastUpdateDate | Datetime | The timestamp indicating when the row was last updated, essential for maintaining version control and data integrity. |
| LastUpdatedBy | String | The username of the individual who last modified the row, used for tracking updates and changes. |
| Finder | String | A search term or filter used to find specific rows or records based on predefined criteria, enhancing query efficiency. |
Tracks the individuals associated with an expense, capturing data such as names and roles for cost-sharing analysis.
| Name | Type | Description |
| ExpensesExpenseId [KEY] | Long | Unique identifier for the expense record, used to track and reference individual expenses in the system. |
| Amount | Decimal | Total amount spent on the event attendee, representing the cost allocated to the individual for event-related expenses. |
| AttendeeType | String | Defines the type of attendee for the event. Possible values are EMPLOYEE for internal staff and NONEMPLOYEE for external individuals. |
| CreatedBy | String | Username of the user who initially created the expense record, providing accountability for record creation. |
| CreationDate | Datetime | Timestamp indicating when the expense record was created, allowing for accurate tracking of the entry's creation time. |
| EmployeeFlag | Bool | Flag indicating whether the event attendee is an employee, differentiating between internal and external participants. |
| EmployerAddress | String | Address of the employer for the event attendee, typically used for tax purposes and documentation of external attendees. |
| EmployerName | String | Name of the employer for the event attendee, used to identify the organization employing the attendee. |
| EmployerPartyId | Long | Unique identifier for the employer associated with the event attendee, linking the individual to their organization. |
| ExpenseAttendeeId [KEY] | Long | Unique identifier for the event attendee, used to track and reference each individual in the expense records. |
| ExpenseId | Long | Unique identifier for the specific expense item, used to link the attendee's expense to the overall expense report. |
| LastUpdateDate | Datetime | Timestamp of the most recent update to the expense record, used for tracking modifications and ensuring data accuracy. |
| LastUpdateLogin | String | Login session associated with the user who last updated the expense record, allowing for accountability in updates. |
| LastUpdatedBy | String | Username of the user who last modified the expense record, providing traceability for changes made to the data. |
| Name | String | Full name of the employee or nonemployee event attendee, used for identifying and referencing the individual in the system. |
| TaxIdentifier | String | Tax Indentification Number (TIN) for the event attendee, either for employees or nonemployees, required for tax and legal purposes. |
| Title | String | Honorific or title of the event attendee, such as Mr., Mrs., Dr., etc., used for formal identification. |
| AttendeeEmail | String | Email address of the event attendee, used for communication and notifications regarding the event or expenses. |
| AttendeePhoneNumber | String | Phone number of the event attendee, used for contacting the attendee as needed. |
| Finder | String | Search term or identifier used for locating and displaying specific records in the database or reporting system. |
| PersonId | String | Unique identifier assigned to the person associated with the expense, linking the expense to the individual. |
| Request | String | Request identifier associated with the expense, often used to track the process or approval of the expense submission. |
| SysEffectiveDate | String | System-defined effective date, indicating when the record becomes valid and applicable within the system for processing. |
| CUReferenceNumber | Int | Reference number used to map child aggregates to parent tables, maintaining relational integrity in the data structure. |
| EffectiveDate | Date | Date parameter used to fetch resources that are effective as of a specified date, ensuring data is accurate as of a given time. |
Holds descriptive flexfield references for an individual expense, enabling custom data collection and categorization.
| Name | Type | Description |
| ExpensesExpenseId [KEY] | Long | Unique identifier for the expense record, used to track and manage individual expense records within the system. |
| ExpenseId [KEY] | Long | Identifier for the expense in the ExpensesExpenseDff table, used to link additional data related to the expense in the flexible data fields. |
| _FLEX_Context | String | Contextual information associated with the ExpensesExpenseDff table, used to specify the flexible data structure for this particular record. |
| Finder | String | Search term or identifier used to locate and display specific records or entries within the system, enhancing data retrieval. |
| PersonId | String | Unique identifier for the person associated with the expense, often used to link the expense record to the individual submitting or owning the expense. |
| Request | String | Request identifier associated with the expense, used for tracking the approval or review process of the expense submission. |
| SysEffectiveDate | String | System-defined effective date used to determine when the record becomes valid in the system, controlling the timing of its applicability. |
| CUReferenceNumber | Int | Reference number used to map child aggregates to their parent tables, ensuring relational integrity and data linkage. |
| EffectiveDate | Date | Date parameter used to fetch resources that are effective as of a specified start date, ensuring that historical data is retrieved correctly. |
Allocates the cost of an expense across multiple accounts, ensuring precise financial reporting.
| Name | Type | Description |
| ExpensesExpenseId [KEY] | Long | Unique identifier for the expense record, used to track and reference individual expenses within the system. |
| CodeCombinationId | Long | Unique identifier for the accounting code combination to which an expense is charged, used for financial reporting and categorization. |
| CostCenter | String | Business organization or department to which the expense is charged, used for budget allocation and financial tracking. |
| CreatedBy | String | Username of the individual who created the record, providing accountability for record creation and data entry. |
| CreationDate | Datetime | Timestamp indicating the exact date and time when the record was created, helping to track the creation process and chronological order. |
| ExpenseDistId [KEY] | Long | Unique identifier for the distribution of a specific expense item, used to associate expenses with specific accounts or categories. |
| ExpenseId | Long | Unique identifier for the expense, used to link the expense to its distribution and track it through the reimbursement process. |
| ExpenseReportId | Long | Unique identifier for the expense report that includes the expense item, helping to link individual expenses to larger reports. |
| LastUpdateDate | Datetime | Timestamp indicating the most recent update to the record, allowing for the tracking of changes and ensuring data accuracy. |
| LastUpdateLogin | String | Login session associated with the user who last updated the record, ensuring traceability and accountability for modifications. |
| LastUpdatedBy | String | Username of the individual who last modified the record, providing transparency regarding updates and changes to the data. |
| OrgId | Long | Unique identifier for the organization to which the expense is associated, helping to track expenses by organizational unit. |
| ReimbursableAmount | Decimal | Amount to be reimbursed to the individual for the expense, used to track how much of the expense is eligible for reimbursement. |
| Company | String | Name of the company to which the expense is charged, helping to classify expenses by the organization to which they belong. |
| BusinessUnit | String | Business unit associated with the expense, used to track and allocate expenses within specific areas or departments of the organization. |
| PJCDFF | String | Column used only for insert operations. For update or delete, refer to the child table's operations, maintaining data integrity. |
| Finder | String | Search term or identifier used to locate specific records or entries within the system, assisting in data retrieval and filtering. |
| PersonId | String | Unique identifier for the person associated with the expense, often used to link the expense to the employee or contractor submitting it. |
| Request | String | Request identifier associated with the expense, used to track the process or approval flow of the expense submission. |
| SysEffectiveDate | String | System-defined effective date that determines when the record becomes valid in the system, controlling the timing of its applicability. |
| CUReferenceNumber | Int | Reference number used to link child aggregates with their parent tables, ensuring relational integrity and maintaining data structure. |
| EffectiveDate | Date | Date parameter used to fetch resources that are effective as of a specified date, ensuring that accurate, time-sensitive data is retrieved. |
Captures project-related flexfields for expense distributions, detailing project codes or tasks linked to the expenditure.
| Name | Type | Description |
| ExpensesExpenseId [KEY] | Long | Unique identifier for the expense record, used to track and manage individual expenses in the system. |
| ExpensedistributionExpenseDistId [KEY] | Long | Unique identifier for the expense distribution record, used to associate specific expenses with distribution accounts or categories. |
| ExpenseDistId [KEY] | Long | Unique identifier for the expense distribution in the ExpensesExpenseDistributionPJCDFF table, helping to track how an expense is allocated across different accounts. |
| _FLEX_Context | String | Contextual information related to the ExpensesExpenseDistributionPJCDFF table, used to specify the flexible data structure and rules for this particular record. |
| _FLEX_Context_DisplayValue | String | Display value associated with the FLEX context of the ExpensesExpenseDistributionPJCDFF record, used to provide a human-readable description of the context. |
| ExpenseId | Long | Unique identifier for the expense, used to link the expense distribution to the associated expense record in the system. |
| Finder | String | Search term or identifier used to locate and display specific records within the database, making data retrieval easier. |
| PersonId | String | Unique identifier for the person associated with the expense, used to link the expense to the individual who incurred or is responsible for it. |
| Request | String | Request identifier associated with the expense, used to track the approval or review process of the expense submission. |
| SysEffectiveDate | String | System-defined effective date that determines when the record becomes valid in the system, ensuring correct timing and applicability of the data. |
| CUReferenceNumber | Int | Reference number used to link child aggregates to their parent tables, ensuring relational integrity and the maintenance of data structure. |
| EffectiveDate | Date | Date parameter used to fetch resources that are effective as of a specified date, ensuring accurate and timely data retrieval based on the given start date. |
Logs validation or policy errors detected in an expense record, prompting corrective actions prior to submission.
| Name | Type | Description |
| ExpensesExpenseId [KEY] | Long | Unique identifier for the expense record, used to track and manage individual expenses throughout the system. |
| Name | String | Name of the attribute that triggers an expense validation error, helping to pinpoint the exact issue within the expense data. |
| ErrorCode | String | Code that represents the specific error encountered during expense validation, used for categorizing and handling errors efficiently. |
| ErrorSequence [KEY] | Int | Unique identifier for each expense validation error, allowing for tracking, sorting, and addressing multiple errors within a given validation process. |
| ErrorDescription | String | Description providing detailed information about the expense validation error, clarifying the cause of the validation issue. |
| Type | String | Indicates the type of issue for the record, specifying whether it is an error or a warning, helping to prioritize actions. |
| ExpenseId | Long | Unique identifier for the expense associated with the validation error, used to link the error back to the specific expense record. |
| Finder | String | Search term or identifier used to locate and display specific records or entries within the database, aiding in data retrieval. |
| PersonId | String | Unique identifier for the person associated with the expense, often linking the error or warning to a specific employee or contractor. |
| Request | String | Request identifier associated with the expense, used to track the approval or review process and ensure proper validation is applied. |
| SysEffectiveDate | String | System-defined effective date that governs when the record becomes valid, ensuring that data is retrieved in accordance with its timeline. |
| CUReferenceNumber | Int | Reference number used to associate child aggregates with their parent tables, ensuring relational integrity in data storage. |
| EffectiveDate | Date | Date parameter used to fetch resources that are effective as of a specified start date, helping to retrieve accurate, time-sensitive data. |
Allows for subdividing a single expense item into multiple cost components (for example, a multi-day hotel stay), improving clarity.
| Name | Type | Description |
| ExpensesExpenseId [KEY] | Long | Unique identifier for the expense record, used to track and manage individual expenses within the system. |
| AssignmentId | Long | Unique identifier for the individual who owns the expense, linking the expense to a specific employee or contractor. |
| AuditAdjustmentReason | String | Explanation provided by the auditor for adjusting the reimbursable amount, ensuring transparency in the adjustment process. |
| AuditAdjustmentReasonCode | String | Code that specifies the auditor's reason for adjusting the reimbursable amount, used for categorization and reporting. |
| AwtGroupId | Long | Identifier for an alternate tax withholding group, used to categorize and apply different tax withholding rules to expenses. |
| BilledAmount | Decimal | Amount billed to the corporate card account, representing the cost charged by the service provider for the expense. |
| BilledCurrencyCode | String | Currency code indicating the currency used for the billed amount, ensuring proper conversion and reconciliation. |
| CardId | Long | Unique identifier for a specific corporate card, used to track expenses associated with that card. |
| CheckoutDate | Date | Date when the individual departs or checks out from a location related to an accommodation, used to track lodging expenses. |
| CreatedBy | String | Username of the individual who created the expense record, helping to trace the origin of the data. |
| CreationDate | Datetime | Timestamp indicating when the expense record was created, important for tracking the creation process. |
| CreditCardTrxnId | Long | Unique identifier for the specific credit card transaction, used to link an expense to its corresponding card payment. |
| DailyAmount | Decimal | Amount listed on the daily receipt for the expense, expressed in the receipt's currency. |
| DailyDistance | Decimal | Distance traveled during a day for business purposes, typically used for mileage reimbursement. |
| DailyLimit | String | Daily expense limit for a trip, often used to control and monitor business-related spending. |
| DepartureLocationId | Long | Unique identifier for the departure location of a trip, used to track the origin of the travel expenses. |
| Description | String | Description of the expense item, providing additional context to explain the nature of the expenditure. |
| DestinationFrom | String | Starting location of the trip, such as the city or airport from which the individual is traveling. |
| DestinationTo | String | Ending location of the trip, marking the arrival point for business travel. |
| DistanceUnitCode | String | Code indicating the unit of measurement for travel distance, with possible values being KILOMETER or MILE. |
| EndDate | String | Final day of the expense period for expenses spanning multiple days, providing a clear endpoint for tracking. |
| EndOdometer | Decimal | Odometer reading at the conclusion of a trip, used for calculating mileage reimbursement. |
| ExchangeRate | Decimal | Currency exchange rate applied when converting one currency to another, used for expenses incurred in foreign currencies. |
| ExpenseCategoryCode | String | Code that categorizes the expense item, helping to classify the expense for accounting and reporting purposes. |
| ExpenseCreationMethodCode | String | Code indicating how the expense was created, such as through a mobile iOS or Android device. |
| ExpenseId [KEY] | Long | Unique identifier for the specific expense item, enabling detailed tracking and reporting for each expense. |
| ExpenseReportId | Long | Unique identifier for the expense report that the expense item belongs to, linking the item to a broader financial report. |
| ExpenseSource | String | Code indicating the source of the expense, such as CASH or CORPORATE_CARD, used to identify the method of payment. |
| ExpenseTemplateId | Long | Unique identifier for the expense template, helping to standardize the creation of expense items across various categories. |
| ExpenseTypeId | Long | Unique identifier for the expense type, used to classify the nature of the expense for better reporting and analysis. |
| FlightClassLimit | String | The expense limit set for a specific flight class, such as business or economy class, to control the cost of travel. |
| FlightDuration | Decimal | Duration of the airline flight in hours, providing a measure of the travel time for the business trip. |
| FlightNumber | String | Flight number associated with an airline trip, used for tracking and managing travel details. |
| FuelType | String | Type of fuel for which a fuel charge is reimbursed, typically used for vehicle-related travel expenses. |
| ImgReceiptRequiredFlag | Bool | Flag indicating whether a receipt image is required for expense submission, ensuring compliance with submission policies. |
| ItemizationParentExpenseId | Long | Unique identifier for the parent expense in itemized expense entries, used to track hierarchical relationships between expenses. |
| ItemizationReceiptBusinessTotalAmount | Decimal | The total business amount on an itemized receipt, representing the portion eligible for reimbursement. |
| ItemizationReceiptPersonalTotalAmount | Decimal | Amount of the receipt that pertains to personal expenses and is not reimbursed. |
| ItineraryReservationId | Long | Unique identifier for a travel reservation, used to link the expense to the travel booking. |
| Justification | String | Reason for incurring the expense, providing clarity and context to ensure the expense meets company policies. |
| JustificationRequiredFlag | Bool | Flag indicating whether a justification is required for the expense item, ensuring compliance with policy. |
| LastUpdateDate | Datetime | Timestamp of the most recent update made to the expense record, helping to track changes over time. |
| LastUpdatedBy | String | Username of the individual who last modified the record, providing accountability for updates. |
| LicensePlateNumber | String | License plate number of the vehicle used for business travel, used for mileage and transportation-related expense tracking. |
| Location | String | Location where the expense was incurred, helping to classify and validate the expense for reimbursement. |
| LocationId | Long | Unique identifier for the location associated with the expense, used for tracking expenses by location. |
| LongTermTripFlag | Bool | Flag indicating whether the trip is considered long-term, which may require different handling for expense reporting. |
| LongTermTripStartDate | Date | Date when the long-term business trip began, used for tracking extended travel durations. |
| MerchantDocumentNumber | String | Receipt number or document issued by the merchant, used for identifying and verifying the purchase transaction. |
| MerchantName | String | Name of the merchant or service provider where the expense was incurred, helping to track the vendor associated with the purchase. |
| MerchantReference | String | Transaction reference provided by the merchant, used to identify the specific purchase for reconciliation. |
| MerchantTaxRegNumber | String | Unique identification number assigned to the merchant by tax authorities, used for regulatory compliance and tax reporting. |
| MerchantTaxpayerId | String | Tax Indentification Number (TIN) assigned to the merchant, ensuring proper tax reporting and legal compliance. |
| MileagePolicyId | Long | Unique identifier for the mileage policy applied to the expense, used to ensure proper reimbursement rates and rules are followed. |
| NumberOfAttendees | Decimal | The number of individuals who attended an event for which expenses were incurred, useful for business meals or entertainment expenses. |
| NumberOfDays | Int | The number of days the expense was incurred, used to track daily expenses like lodging, meals, or transportation. |
| NumberPeople | Int | Number of passengers in a vehicle during business travel, typically used for mileage and travel reimbursement. |
| OrgId | Long | Unique identifier for the organization or business unit associated with the expense, used for organizational reporting. |
| PassengerAmount | Decimal | Total amount reimbursed for carrying passengers in the vehicle during business travel, used to calculate mileage reimbursement. |
| PassengerName | String | Name of the individual who is a passenger during the business trip. |
| PassengerRateType | String | Rate type used for reimbursing the passenger during a business trip, typically based on company reimbursement policies. |
| PaymentDueFromCode | String | Code identifying the party responsible for paying the expense, helping to clarify liability for the transaction. |
| PersonId | Long | Unique identifier for the individual who owns the expense, used to link the expense to the employee or contractor. |
| PersonalReceiptAmount | Decimal | Amount of the receipt that is marked as a personal expense and is not eligible for reimbursement. |
| PolicyShortpayFlag | Bool | Flag indicating whether the expense was short-paid due to policy noncompliance, signaling the need for corrective action. |
| PolicyViolatedFlag | Bool | Flag indicating whether the expense violates company policies, helping to trigger further review or action. |
| PolicyWarningFlag | Bool | Flag indicating whether the expense has been flagged with a warning for potential policy violations. |
| PolicyWarningReasonCode | String | Code that specifies the reason for the warning, helping to categorize and handle policy-related issues. |
| PreparerId | Long | Unique identifier for the person who prepared the expense report, used to track who is responsible for submitting the report. |
| RatePerPassenger | Decimal | Mileage reimbursement rate per passenger, used to calculate the total reimbursement for carpooling or group travel. |
| ReceiptAmount | Decimal | Total amount on the receipt in the currency of the expense, used to ensure accuracy during reimbursement processing. |
| ReceiptCurrencyCode | String | Currency code indicating the currency in which the expense receipt was issued, ensuring accurate exchange and reporting. |
| ReceiptDate | Date | Date when the receipt was issued, used to match the expense with the corresponding receipt date for validation. |
| ReceiptMissingDecRequiredFlag | Bool | Flag indicating whether a missing receipt requires a declaration to explain the absence, ensuring accountability. |
| ReceiptMissingFlag | Bool | Flag indicating whether receipts are missing for an expense, prompting follow-up to ensure complete documentation. |
| ReceiptRequiredFlag | Bool | Flag indicating whether a receipt is required for the expense, used for ensuring compliance with company policy. |
| ReceiptVerifiedFlag | Bool | Flag indicating whether the receipt has been verified by an auditor or reviewer as part of the approval process. |
| ReimbursableAmount | Decimal | Amount to be reimbursed to the individual for an expense, ensuring that only valid and eligible amounts are reimbursed. |
| ReimbursementCurrencyCode | String | Currency code for the reimbursement amount, used to track and manage the currency for reimbursement payments. |
| SequenceNumber | Decimal | Number that identifies the order in which the expense items are entered in the report, helping to maintain a structured sequence. |
| StartDate | Date | Start date of the expense period or the first day of a trip, used to track the beginning of a multi-day expense. |
| TaxClassificationCode | String | Code indicating the tax classification that applies to the expense, used for proper tax treatment and reporting. |
| TicketClassCode | String | Code indicating the class of ticket for a flight or ship, helping to categorize travel expenses based on ticket class. |
| TicketNumber | String | Unique number assigned to an airline ticket, used to verify the purchase and track travel details. |
| TravelMethodCode | String | Code indicating the method of travel used during the trip, such as flight, train, or car rental, affecting travel reimbursements. |
| TravelType | String | Type of travel, either DOMESTIC or INTERNATIONAL, helping to categorize expenses based on the geographical scope of the trip. |
| TripDistance | Decimal | Total distance traveled during a business trip, typically used to calculate mileage reimbursement for the trip. |
| UOMDays | Decimal | Calculation of the number of per diem expense days based on the unit of measure, used for meal or lodging expenses. |
| ValidationErrorFlag | Bool | Flag indicating whether a validation error exists, requiring further action to resolve before expense approval. |
| ValidationErrorMessages | String | Messages detailing the validation errors, used to inform users about issues with expense data that need correction. |
| ValidationWarningMessages | String | Messages detailing any validation warnings, alerting users to potential issues that need attention before approval. |
| VehicleCategoryCode | String | Code indicating the type of vehicle, such as COMPANY, PRIVATE, or RENTAL, used for mileage reimbursement and travel expenses. |
| VehicleType | String | Type of vehicle used for business travel, such as CAR, MOTORCYCLE, or VAN, affecting mileage reimbursement and travel policies. |
| ZoneCode | String | Code that indicates the geographical area where the trip occurred, used for calculating mileage and travel reimbursements. |
| ZoneTypeCode | String | Code that defines the zone type for which mileage rates are applied, ensuring accurate calculations based on location. |
| ExpenseType | String | Expense type defined for categorizing the nature of the expense, helping to organize and report different types of expenditures. |
| Finder | String | Search term or identifier used to locate and filter specific records in the system, streamlining data retrieval. |
| Request | String | Request identifier associated with the expense, used for tracking its approval or review process. |
| SysEffectiveDate | String | System-defined effective date, marking when the record becomes valid and applicable for processing. |
| CUReferenceNumber | Int | Reference number used to link child aggregates to parent tables, ensuring consistency and relational integrity. |
| EffectiveDate | Date | Date parameter used to retrieve resources effective as of a specified date, ensuring accurate and time-sensitive data retrieval. |
Syncs submitted expenses with matched records (for example, credit card data), preventing duplicates and maintaining consistency.
| Name | Type | Description |
| ExpensesExpenseId [KEY] | Long | Unique identifier for the expense record, used to track and manage individual expenses across the system. |
| MatchedExpenseId | Long | Identifier for a matched expense record, used to link the current expense to a corresponding matching entry in the system. |
| ExpenseId | Long | Unique identifier for an expense, helping to track and categorize each specific expense item in the system. |
| MergedFlag | String | Indicates whether two or more expenses have been merged after being matched, helping to track combined records. |
| MatchPercentage | Decimal | Percentage indicating the strength or confidence level of the match between the expenses, used to assess the accuracy of matched records. |
| MatchReference [KEY] | String | Unique identifier associated with the matched record, used to reference and verify the matching process for an expense. |
| Finder | String | Search term or identifier used to locate and filter specific records or entries within the database, enhancing data retrieval. |
| PersonId | String | Unique identifier for the person associated with the expense, linking the record to the individual responsible for the expense. |
| Request | String | Request identifier associated with the expense, used for tracking the approval, validation, or review process of the expense submission. |
| SysEffectiveDate | String | System-defined effective date, indicating when the record becomes valid in the system and applicable for processing. |
| CUReferenceNumber | Int | Reference number used to link child aggregates to their parent tables, maintaining relational integrity within the system. |
| EffectiveDate | Date | Date parameter used to fetch resources effective as of a specified start date, ensuring accurate and time-sensitive data retrieval. |
Stores a library of standardized expense templates by business unit (for example, travel, relocation), driving efficient expense entry.
| Name | Type | Description |
| ExpenseTemplateId [KEY] | Long | Unique identifier for the expense template, used to track and reference individual expense templates in the system. |
| OrgId | Long | Unique identifier for the organization associated with the expense template, used to link the template to a specific organization. |
| BusinessUnit | String | Name of the business unit associated with the expense template, helping categorize and manage expenses within different organizational segments. |
| Name | String | Name of the expense template, used to identify and differentiate various templates within the system. |
| Description | String | Detailed description of the expense template, providing context about its use and the type of expenses it governs. |
| StartDate | Date | Start date of the expense template's validity, marking the date from which the template becomes active and applicable. |
| InactiveDate | Date | Date when the expense template is no longer valid or inactive, helping to track the lifecycle of the template. |
| DfltCcExpTypeId | Long | Default credit card expense type ID associated with the expense template, used for categorizing credit card-related expenses. |
| EnableCcMappingFlag | Bool | Flag indicating whether credit card mapping is enabled for the expense template, controlling whether credit card expenses are linked to this template. |
| CreationDate | Datetime | Timestamp indicating when the expense template was created, helping to track the creation time of the template. |
| CreatedBy | String | Username of the individual who created the expense template, ensuring accountability for the creation process. |
| LastUpdateDate | Datetime | Timestamp of the most recent update made to the expense template, helping to track changes over time. |
| LastUpdatedBy | String | Username of the individual who last updated the expense template, providing accountability for updates. |
| LastUpdateLogin | String | Session login associated with the user who last updated the expense template, providing transparency for tracking changes. |
| CashReceiptRequiredFlag | Bool | Flag indicating whether a cash receipt is required for expenses under this template, ensuring compliance with documentation rules. |
| CashReceiptRequiredLimit | Decimal | Limit for the cash receipt requirement in the expense template, setting the threshold above which a cash receipt is mandatory. |
| CcReceiptRequiredFlag | Bool | Flag indicating whether a credit card receipt is required for expenses under this template, ensuring credit card expenses are properly documented. |
| CcReceiptRequiredLimit | Decimal | Limit for the credit card receipt requirement in the expense template, setting the threshold above which a credit card receipt is required. |
| NegativeRcptRequiredFlag | Bool | Flag indicating whether a negative receipt is required for expenses under this template, typically used for returns or refunds. |
| AllowRcptMissingFlag | Bool | Flag indicating whether missing receipts are allowed for expenses under this template, controlling whether exceptions can be made. |
| DispRcptViolationFlag | Bool | Flag indicating whether a receipt violation is displayed for expenses under this template, helping to highlight missing or incorrect receipts. |
| DescriptionBehaviourCode | String | Code that governs how the description field is handled within the expense template, defining its behavior and usage. |
| DescriptionBehaviour | String | Description of how the description field should be used in the expense template, providing guidelines for entering expense details. |
| LocationBehaviourCode | String | Code that defines the behavior of the location field within the expense template, such as whether location is mandatory or optional. |
| LocationBehaviour | String | Description of how the location field should be handled in the expense template, providing guidelines on its usage. |
| NumberOfDaysBehaviourCode | String | Code that defines how the number of days field behaves in the expense template, such as whether it's calculated or entered manually. |
| NumberOfDaysBehaviour | String | Description of how the number of days field should be handled in the expense template, guiding users on its proper usage. |
| MerchantBehaviourCode | String | Code that specifies the behavior of the merchant field in the expense template, such as whether it's a required field or optional. |
| MerchantBehaviour | String | Description of how the merchant field is handled within the expense template, including any rules for its use. |
| BindDate | Date | Date when the expense template is bound to a specific record or usage context, ensuring that the template is applicable from a certain date onward. |
| BindOrgId | Long | Unique identifier for the organization to which the expense template is bound, ensuring the template is linked to the correct organization. |
| Finder | String | Search term or identifier used to locate and filter specific expense templates within the system, making it easier to retrieve the right template. |
Defines the specific expense types and applicable policies within a given expense template, ensuring consistent categorization.
| Name | Type | Description |
| ExpenseTemplatesExpenseTemplateId [KEY] | Long | Unique identifier for the expense template in the `ExpenseTemplatesexpenseTypes` table, used to reference the specific template applied to expense items. |
| BusinessUnit | String | Business unit associated with the expense template, helping to categorize and allocate expenses within different organizational units. |
| Category | String | Category of the expense template, used to classify the type of expenses managed by the template. |
| CategoryCode | String | Code representing the category of the expense template, providing a standardized identifier for the category. |
| CcReceiptRequiredFlag | Bool | Flag indicating whether a credit card receipt is required for expenses under this template, ensuring proper documentation for credit card transactions. |
| CcReceiptThreshold | Decimal | Threshold amount for when a credit card receipt is required under this expense template, setting the limit above which receipts must be provided. |
| CreatedBy | String | Username of the individual who created the expense template, ensuring accountability for the creation of the template. |
| CreationDate | Datetime | Timestamp indicating when the expense template was created, providing a reference for tracking when the template was established. |
| DefaultProjExpendType | Long | Default project expenditure type associated with the expense template, used to define the primary project expenditure category for expenses. |
| Description | String | Detailed description of the expense template, providing additional context for its use and the types of expenses it governs. |
| DescriptionBehaviour | String | Defines how the description field behaves within the expense template, including any rules or guidelines for entering descriptions. |
| DescriptionBehaviourCode | String | Code that governs the behavior of the description field, specifying rules for its usage within the template. |
| DispRcptViolationFlag | Bool | Flag indicating whether a receipt violation is displayed for expenses under this template, alerting users when required receipts are missing or incorrect. |
| EnableProjectsFlag | Bool | Flag indicating whether project tracking is enabled for this expense template, allowing expenses to be tied to specific projects. |
| EndDate | Date | End date when the expense template becomes inactive, marking the conclusion of its applicability. |
| ExpenseTemplateId | Long | Unique identifier for the expense template, used to associate the expense item with the correct template for processing. |
| ExpenseTypeId [KEY] | Long | Unique identifier for the expense type, used to categorize expenses under the appropriate template. |
| ItemizationBehaviour | String | Defines the behavior of itemization within the expense template, specifying whether expenses should be itemized or grouped. |
| ItemizationBehaviourCode | String | Code representing the itemization behavior for the template, ensuring standardized handling of itemized expenses. |
| ItemizationOnlyFlag | Bool | Flag indicating whether the template is used solely for itemized expenses, restricting the template's usage to itemized entries only. |
| LastUpdateDate | Datetime | Timestamp of the most recent update made to the expense template, helping to track changes and updates to the template. |
| LastUpdateLogin | String | Login session associated with the user who last updated the expense template, ensuring transparency for updates. |
| LastUpdatedBy | String | Username of the individual who last modified the expense template, providing accountability for changes. |
| LocationBehaviour | String | Defines the behavior of the location field in the expense template, such as whether it is required or optional for expense entries. |
| LocationBehaviourCode | String | Code that defines the location behavior, ensuring consistent handling of location data in the template. |
| MerchantBehaviour | String | Defines how the merchant field is handled in the expense template, including rules for entering merchant information. |
| MerchantBehaviourCode | String | Code representing the behavior of the merchant field, providing standardized rules for handling merchant-related data. |
| Name | String | Name of the expense template, used to identify and differentiate it from other templates in the system. |
| NegativeRcptRequiredCode | String | Code that specifies whether a negative receipt is required for expenses under this template, typically for returns or refunds. |
| NumberOfDaysBehaviour | String | Defines how the number of days field behaves within the expense template, including whether it should be calculated or entered manually. |
| NumberOfDaysBehaviourCode | String | Code representing the behavior of the number of days field, specifying how it should be handled within the template. |
| OrgId | Long | Unique identifier for the organization associated with the expense template, used to ensure the template is tied to the correct organization. |
| RcptRequiredProjFlag | Bool | Flag indicating whether receipts are required for project-related expenses under this template, ensuring documentation for project expenditures. |
| ReceiptRequiredFlag | Bool | Flag indicating whether a receipt is required for all expenses under this template, enforcing documentation standards. |
| ReceiptThreshold | Decimal | Threshold value that determines when a receipt is required under the expense template, setting the limit for receipt requirements. |
| StartDate | Date | Start date of the expense template's validity, marking the date when the template becomes applicable for use. |
| TaxClassification | String | Tax classification associated with the expense template, used to ensure proper tax treatment and reporting for related expenses. |
| TaxClassificationCode | String | Code that defines the tax classification for the expense template, helping to categorize expenses for tax purposes. |
| DispRcptViolationCode | String | Code that specifies the violation for missing or incorrect receipts, used to categorize and address receipt-related violations. |
| BindDate | Date | Date when the expense template is bound to a specific record or usage context, making the template applicable from that point onward. |
| BindOrgId | Long | Unique identifier for the organization to which the expense template is bound, ensuring the template is associated with the correct organization. |
| Finder | String | Search term or identifier used to locate and filter specific expense templates within the system, facilitating efficient template management. |
Defines itemized expense categories within a template, allowing granular reporting and policy enforcement for expenses with multiple cost components.
| Name | Type | Description |
| ExpenseTemplatesExpenseTemplateId [KEY] | Long | Unique identifier for the expense template in the ExpenseTemplatesexpenseTypesitemizedExpenseTypes table, used to reference the specific template for itemized expenses. |
| ExpensetypesExpenseTypeId [KEY] | Long | Unique identifier for the expense type in the ExpenseTemplatesexpenseTypesitemizedExpenseTypes table, used to define the specific type of itemized expenses. |
| ExpenseTypeParentId [KEY] | Long | Identifier for the parent expense type of an itemized expense, linking itemized expenses to a broader category or type. |
| ExpenseTypeId [KEY] | Long | Unique identifier for the expense type associated with the itemized expense, helping to categorize and manage various expense types. |
| CreationDate | Datetime | Timestamp indicating when the itemized expense type record was created, allowing for tracking the creation process. |
| CreatedBy | String | Username of the individual who created the itemized expense type record, ensuring accountability for the creation of the data. |
| LastUpdateDate | Datetime | Timestamp of the most recent update to the itemized expense type record, used for tracking changes and ensuring data accuracy. |
| LastUpdatedBy | String | Username of the individual who last updated the itemized expense type record, providing traceability for modifications. |
| LastUpdateLogin | String | Session login associated with the user who last updated the itemized expense type record, ensuring transparency and auditability. |
| BindDate | Date | Date when the itemized expense type was bound to a specific record or context, marking its applicability for that date onward. |
| BindOrgId | Long | Unique identifier for the organization to which the itemized expense type is bound, ensuring it is linked to the correct organization. |
| ExpenseTemplateId | Long | Unique identifier for the expense template used with the itemized expense types, helping to associate itemized expenses with specific templates. |
| Finder | String | Search term or identifier used to locate and display specific itemized expense type records, facilitating data retrieval and management. |
Associates preferred travel or service agencies with specific expense types in an expense template, ensuring employees use approved vendors.
| Name | Type | Description |
| ExpenseTemplatesExpenseTemplateId [KEY] | Long | Unique identifier for the expense template in the ExpenseTemplatesexpenseTypespreferredAgencyLists table, used to reference the specific template associated with preferred agency lists. |
| ExpensetypesExpenseTypeId [KEY] | Long | Unique identifier for the expense type in the ExpenseTemplatesexpenseTypespreferredAgencyLists table, categorizing the preferred agency list by its specific expense type. |
| AgencyListName | String | Name of the agency list, used to identify and differentiate various agency lists within the expense template. |
| AgencyListType [KEY] | String | Type of the agency list, specifying whether it is a list for preferred agencies, recommended agencies, or another category. |
| CreatedBy | String | Username of the individual who created the preferred agency list, ensuring accountability for data entry. |
| CreationDate | Datetime | Timestamp of when the preferred agency list was created, providing a reference for when the record was established. |
| DispWarningToUserFlag | Bool | Flag indicating whether a warning should be displayed to the user when selecting an agency from the list, used for compliance and guidance. |
| EndDate | Date | End date of the validity period for the preferred agency list, marking when the list is no longer applicable. |
| ExpenseTypeId [KEY] | Long | Unique identifier for the expense type associated with the preferred agency list, linking the list to a specific category of expenses. |
| LastUpdatedBy | String | Username of the individual who last updated the preferred agency list, providing accountability for changes made to the record. |
| LastUpdateDate | Datetime | Timestamp of the most recent update made to the preferred agency list, helping to track modifications and maintain accurate records. |
| LastUpdateLogin | String | Session login associated with the user who last updated the record, ensuring traceability for updates. |
| PolicyEnforcement | String | Describes how policy enforcement is applied to the preferred agency list, such as whether only certain agencies are allowed based on company policy. |
| PolicyEnforcementCode | String | Code that defines the specific policy enforcement rule applied to the preferred agency list, used for consistent application of rules. |
| StartDate [KEY] | Date | Start date for the preferred agency list, marking the beginning of its validity period within the expense template. |
| BindDate | Date | Date when the preferred agency list is bound to a specific record or context, making it applicable from that point onward. |
| BindOrgId | Long | Unique identifier for the organization to which the preferred agency list is bound, ensuring that the list is linked to the correct organization. |
| ExpenseTemplateId | Long | Unique identifier for the expense template that the preferred agency list is associated with, linking the agency list to a specific template. |
| Finder | String | Search term or identifier used to locate and display specific preferred agency list records, making data retrieval more efficient. |
Specifies pre-approved merchants for given expense types in a template, streamlining compliance and spend oversight.
| Name | Type | Description |
| ExpenseTemplatesExpenseTemplateId [KEY] | Long | Unique identifier for the expense template in the ExpenseTemplatesexpenseTypespreferredMerchantLists table, used to link the merchant list to a specific expense template. |
| ExpensetypesExpenseTypeId [KEY] | Long | Unique identifier for the expense type associated with the preferred merchant list, categorizing the type of expenses that the merchant list applies to. |
| CreatedBy | String | Username of the individual who created the preferred merchant list, ensuring accountability for record creation. |
| CreationDate | Datetime | Timestamp indicating when the preferred merchant list was created, providing a reference for tracking its establishment. |
| DispWarningToUserFlag | Bool | Flag indicating whether a warning should be displayed to the user when selecting a merchant from the list, alerting them to potential issues or restrictions. |
| EndDate | Date | End date when the preferred merchant list becomes inactive, marking the conclusion of its applicability for the associated expense type. |
| ExpenseTypeId [KEY] | Long | Unique identifier for the expense type linked to the preferred merchant list, used to associate the list with specific types of expenses. |
| LastUpdateDate | Datetime | Timestamp of the most recent update to the preferred merchant list, tracking any changes or revisions to the list. |
| LastUpdateLogin | String | Session login associated with the user who last updated the record, ensuring traceability of updates. |
| LastUpdatedBy | String | Username of the individual who last modified the preferred merchant list, providing accountability for changes made. |
| MerchantListName | String | Name of the preferred merchant list, used to identify and differentiate between various merchant lists within the system. |
| MerchantListType [KEY] | String | Type of the merchant list, indicating whether it is a preferred merchant list, recommended list, or another category of merchants. |
| PolicyEnforcement | String | Describes the policy enforcement rules applied to the preferred merchant list, defining how merchants are selected or restricted. |
| PolicyEnforcementCode | String | Code that specifies the policy enforcement rule, used for consistent application of policies across the system. |
| StartDate [KEY] | Date | Start date of the preferred merchant list's validity, marking the beginning of its applicability within the expense template. |
| BindDate | Date | Date when the preferred merchant list is bound to a specific record or context, making the list applicable from that point onward. |
| BindOrgId | Long | Unique identifier for the organization associated with the preferred merchant list, ensuring it is linked to the correct organization. |
| ExpenseTemplateId | Long | Unique identifier for the expense template associated with the preferred merchant list, helping to link the list to specific expense templates. |
| Finder | String | Search term or identifier used to locate and filter preferred merchant list records within the system, making data retrieval easier. |
Manages expense types specifically enabled for mobile entry, supporting on-the-go expense capture and policy adherence.
| Name | Type | Description |
| ExpenseTemplatesExpenseTemplateId [KEY] | Long | Unique identifier for the expense template in the ExpenseTemplatesmobileExpenseTypes table, linking the mobile expense types to specific templates. |
| PersonId | Long | Unique identifier for the person associated with the mobile expense type, linking the expense type to a specific individual. |
| BUId | Long | Business unit identifier associated with the mobile expense type, used to categorize expenses within different organizational units. |
| ExpenseTemplateId | Long | Unique identifier for the expense template applied to the mobile expense type, helping to associate the expense type with its template. |
| ExpenseTypeId [KEY] | Long | Unique identifier for the expense type within the mobile expense type template, used to categorize and track specific types of expenses. |
| ExpenseTypeName | String | Name of the expense type within the mobile expense template, providing a label for the category of expenses. |
| StartDate | Date | Start date when the mobile expense type becomes valid, marking the beginning of its applicability within the expense template. |
| EndDate | Date | End date when the mobile expense type becomes inactive, signifying the end of its validity. |
| ExpenseCategoryCode | String | Code representing the category of the mobile expense type, used to classify and manage different expense categories. |
| ExpenseCategory | String | Description of the category to which the mobile expense type belongs, helping to categorize expenses for reporting and analysis. |
| ReceiptRequiredCode | String | Code indicating whether a receipt is required for the mobile expense type, used to enforce documentation rules. |
| ReceiptRequiredFlag | Bool | Flag indicating whether receipts are mandatory for expenses under this template, ensuring proper documentation. |
| ProjectReceiptRequiredFlag | Bool | Flag indicating whether receipts are required for project-related expenses under this template, ensuring compliance with project documentation policies. |
| JustificationAmount | Decimal | Amount that requires justification within the mobile expense type, typically used for expenses that exceed certain thresholds or need additional approval. |
| ReceiptThresholdAmount | Decimal | Amount above which a receipt is required for the mobile expense type, used to enforce limits for reimbursable expenses. |
| CurrencyCode | String | Currency code for the mobile expense type, specifying the currency used for the expense amounts. |
| Currency | String | Currency used for the mobile expense type, providing context for the expenses and ensuring proper exchange rates are applied if needed. |
| EnableProjectsFlag | Bool | Flag indicating whether project tracking is enabled for the mobile expense type, allowing expenses to be linked to specific projects. |
| CodeCombinationId | Long | Unique identifier for the accounting code combination associated with the mobile expense type, used for financial categorization. |
| ItemizationOnlyFlag | Bool | Flag indicating whether the expense type can only be used for itemized expenses, restricting the template to only allow itemized entries. |
| ItemizationBehaviourCode | String | Code specifying the behavior of itemization for the mobile expense type, such as whether itemization is mandatory or optional. |
| ItemizationBehaviour | String | Description of how itemization should be handled within the mobile expense type, providing guidelines for users to follow when itemizing expenses. |
| TopLevelExpenseTypeFlag | Bool | Flag indicating whether the expense type is a top-level category, typically used for categorizing major expense types. |
| TaxClassificationCode | String | Code representing the tax classification that applies to the mobile expense type, ensuring proper tax treatment for the expenses. |
| TaxClassification | String | Description of the tax classification associated with the mobile expense type, used for compliance with tax regulations. |
| BindDate | Date | Date when the mobile expense type is bound to a specific record or context, ensuring it is applied from that point onward. |
| BindOrgId | Long | Unique identifier for the organization associated with the mobile expense type, ensuring the expense type is tied to the correct organizational unit. |
| Finder | String | Search term or identifier used to locate and filter specific mobile expense type records within the system, aiding in efficient data retrieval. |
Defines and maintains various expense classifications (for example, travel, lodging), guiding users to select the correct cost category.
| Name | Type | Description |
| BusinessUnit | String | Business unit associated with the expense type, used to categorize and allocate expenses within different organizational segments. |
| Category | String | Category to which the expense type belongs, helping to classify the type of expenses within the organization. |
| CategoryCode | String | Code that represents the category of the expense type, providing a standardized identifier for classification. |
| CcReceiptRequiredFlag | Bool | Flag indicating whether a credit card receipt is required for the expense type, enforcing documentation for credit card expenses. |
| CcReceiptThreshold | Decimal | Threshold above which a credit card receipt is required for the expense type, ensuring proper receipt collection for higher value expenses. |
| CreatedBy | String | Username of the individual who created the expense type, ensuring accountability for data entry and creation. |
| CreationDate | Datetime | Timestamp indicating when the expense type was created, providing a reference for tracking its establishment. |
| DefaultProjExpendType | Long | Default project expenditure type associated with the expense type, used to categorize project-related expenses. |
| Description | String | Detailed description of the expense type, providing context for its use and the types of expenses it governs. |
| DescriptionBehaviour | String | Defines how the description field behaves within the expense type, such as whether it is mandatory or optional. |
| DescriptionBehaviourCode | String | Code that defines the behavior of the description field for the expense type, ensuring standardized handling of descriptions. |
| DispRcptViolationFlag | Bool | Flag indicating whether a receipt violation should be displayed when receipts are missing or incorrect for the expense type. |
| EnableProjectsFlag | Bool | Flag indicating whether project tracking is enabled for the expense type, allowing expenses to be associated with specific projects. |
| EndDate | Date | End date when the expense type becomes inactive, marking the expiration of its validity period. |
| ExpenseTemplateId | Long | Unique identifier for the expense template associated with the expense type, linking the type to a specific template. |
| ExpenseTypeId [KEY] | Long | Unique identifier for the expense type, used to track and categorize individual expense items. |
| ItemizationBehaviour | String | Defines how itemization is handled for the expense type, such as whether expenses should be itemized or grouped. |
| ItemizationBehaviourCode | String | Code representing the itemization behavior, ensuring standardized handling of itemized expenses. |
| ItemizationOnlyFlag | Bool | Flag indicating whether the expense type is restricted to itemized expenses only, disallowing non-itemized entries. |
| LastUpdateDate | Datetime | Timestamp indicating the most recent update made to the expense type, helping to track changes over time. |
| LastUpdateLogin | String | Session login associated with the user who last updated the expense type, ensuring transparency for updates. |
| LastUpdatedBy | String | Username of the individual who last modified the expense type, providing accountability for changes. |
| LocationBehaviour | String | Defines how the location field behaves within the expense type, such as whether it is required or optional for expense entries. |
| LocationBehaviourCode | String | Code that defines the behavior of the location field for the expense type, ensuring consistent usage across records. |
| MerchantBehaviour | String | Defines how the merchant field is handled for the expense type, including whether it is required or optional. |
| MerchantBehaviourCode | String | Code representing the behavior of the merchant field, providing standardized rules for merchant-related data. |
| Name | String | Name of the expense type, used to identify and categorize it within the system. |
| NegativeRcptRequiredCode | String | Code that specifies whether a negative receipt is required for expenses of this type, typically used for refunds or returns. |
| NumberOfDaysBehaviour | String | Defines how the number of days field is handled for the expense type, such as whether it is calculated or manually entered. |
| NumberOfDaysBehaviourCode | String | Code representing the behavior of the number of days field for the expense type, ensuring consistent handling. |
| OrgId | Long | Unique identifier for the organization associated with the expense type, helping to track the expense type by organizational unit. |
| RcptRequiredProjFlag | Bool | Flag indicating whether receipts are required for project-related expenses under this expense type, ensuring proper documentation. |
| ReceiptRequiredFlag | Bool | Flag indicating whether receipts are required for expenses under this expense type, enforcing proper documentation standards. |
| ReceiptThreshold | Decimal | Threshold amount above which a receipt is required for the expense type, helping to enforce documentation rules for larger expenses. |
| StartDate | Date | Start date when the expense type becomes valid, marking the beginning of its applicability within the expense template. |
| TaxClassification | String | Tax classification associated with the expense type, ensuring proper tax treatment and reporting for related expenses. |
| TaxClassificationCode | String | Code representing the tax classification for the expense type, helping to categorize expenses for tax purposes. |
| DispRcptViolationCode | String | Code that specifies the violation for missing or incorrect receipts, helping to categorize and address receipt-related violations. |
| BindDate | Date | Date when the expense type is bound to a specific record or context, marking its applicability from that point onward. |
| BindTemplateId | Long | Unique identifier for the template to which the expense type is bound, ensuring the type is linked to the correct template. |
| Finder | String | Search term or identifier used to locate and filter specific expense type records within the system, aiding in efficient data retrieval. |
Specifies subcategories for detailed expense entries under a parent expense type, enhancing accuracy and reporting granularity.
| Name | Type | Description |
| ExpenseTypesExpenseTypeId [KEY] | Long | Unique identifier for the expense type in the ExpenseTypesitemizedExpenseTypes table, linking the itemized expense type to its corresponding expense type. |
| ExpenseTypeParentId [KEY] | Long | Unique identifier for the parent expense type of an itemized expense, establishing a hierarchical relationship between itemized and parent expense types. |
| ExpenseTypeId [KEY] | Long | Unique identifier for the expense type within the itemized expense types, categorizing the expense for tracking and reporting. |
| CreationDate | Datetime | Timestamp indicating when the itemized expense type record was created, providing a reference for its establishment. |
| CreatedBy | String | Username of the individual who created the itemized expense type record, ensuring accountability for the creation process. |
| LastUpdateDate | Datetime | Timestamp indicating the most recent update to the itemized expense type record, allowing for tracking changes over time. |
| LastUpdatedBy | String | Username of the individual who last modified the itemized expense type record, providing accountability for updates. |
| LastUpdateLogin | String | Session login associated with the user who last updated the itemized expense type record, ensuring traceability for updates. |
| BindDate | Date | Date when the itemized expense type was bound to a specific record or context, making it applicable from that point onward. |
| BindTemplateId | Long | Unique identifier for the template to which the itemized expense type is bound, ensuring proper linkage to a specific expense template. |
| Finder | String | Search term or identifier used to locate and filter specific itemized expense type records within the system, aiding in efficient data retrieval. |
Links preferred agency details (for example, travel agencies) to particular expense types, helping users select valid partners.
| Name | Type | Description |
| ExpenseTypesExpenseTypeId [KEY] | Long | Unique identifier for the expense type in the ExpenseTypespreferredAgencyLists table, linking the preferred agency list to its corresponding expense type. |
| AgencyListName | String | Name of the agency list associated with the expense type, used to identify and manage different agency lists. |
| AgencyListType [KEY] | String | Type of the agency list, specifying whether it is a preferred, recommended, or other category of agency list within the expense type. |
| CreatedBy | String | Username of the individual who created the preferred agency list record, ensuring accountability for data entry. |
| CreationDate | Datetime | Timestamp indicating when the preferred agency list was created, providing a reference for when the record was established. |
| DispWarningToUserFlag | Bool | Flag indicating whether a warning should be displayed to the user when selecting an agency from the list, alerting them to potential issues or restrictions. |
| EndDate | Date | End date when the preferred agency list becomes inactive, marking the expiration of its validity for the associated expense type. |
| ExpenseTypeId [KEY] | Long | Unique identifier for the expense type linked to the preferred agency list, categorizing the list under specific types of expenses. |
| LastUpdatedBy | String | Username of the individual who last modified the preferred agency list, ensuring accountability for updates. |
| LastUpdateDate | Datetime | Timestamp of the most recent update to the preferred agency list, helping track changes and maintain accuracy. |
| LastUpdateLogin | String | Session login associated with the user who last updated the record, ensuring traceability for updates. |
| PolicyEnforcement | String | Describes how policy enforcement is applied to the preferred agency list, ensuring that only approved agencies are selected based on company rules. |
| PolicyEnforcementCode | String | Code that defines the specific policy enforcement rule applied to the preferred agency list, ensuring consistency in the application of policies. |
| StartDate [KEY] | Date | Start date when the preferred agency list becomes valid, marking the beginning of its applicability within the expense template. |
| BindDate | Date | Date when the preferred agency list is bound to a specific record or context, making it applicable from that point onward. |
| BindTemplateId | Long | Unique identifier for the template to which the preferred agency list is bound, linking the list to a specific expense template. |
| Finder | String | Search term or identifier used to locate and filter preferred agency list records within the system, making it easier to retrieve specific lists. |
Catalogs approved merchants for specific expense types, ensuring policy compliance and negotiated rates.
| Name | Type | Description |
| ExpenseTypesExpenseTypeId [KEY] | Long | Unique identifier for the expense type in the ExpenseTypespreferredMerchantLists table, linking the preferred merchant list to its corresponding expense type. |
| CreatedBy | String | Username of the individual who created the preferred merchant list, ensuring accountability for record creation. |
| CreationDate | Datetime | Timestamp indicating when the preferred merchant list was created, providing a reference for tracking its establishment. |
| DispWarningToUserFlag | Bool | Flag indicating whether a warning should be displayed to the user when selecting a merchant from the list, alerting them to potential restrictions or compliance issues. |
| EndDate | Date | End date when the preferred merchant list becomes inactive, marking the expiration of its validity for the associated expense type. |
| ExpenseTypeId [KEY] | Long | Unique identifier for the expense type linked to the preferred merchant list, categorizing the list under specific types of expenses. |
| LastUpdateDate | Datetime | Timestamp of the most recent update made to the preferred merchant list, helping track changes and maintain data accuracy. |
| LastUpdateLogin | String | Session login associated with the user who last updated the record, ensuring traceability for updates. |
| LastUpdatedBy | String | Username of the individual who last modified the preferred merchant list, providing accountability for updates. |
| MerchantListName | String | Name of the preferred merchant list, used to identify and differentiate between various merchant lists within the system. |
| MerchantListType [KEY] | String | Type of the merchant list, indicating whether it is a preferred, recommended, or other category of merchant list. |
| PolicyEnforcement | String | Describes how policy enforcement is applied to the preferred merchant list, ensuring that merchants comply with company policies and restrictions. |
| PolicyEnforcementCode | String | Code that defines the specific policy enforcement rule applied to the preferred merchant list, ensuring consistent policy application. |
| StartDate [KEY] | Date | Start date when the preferred merchant list becomes valid, marking the beginning of its applicability within the expense template. |
| BindDate | Date | Date when the preferred merchant list is bound to a specific record or context, ensuring its applicability from that point onward. |
| BindTemplateId | Long | Unique identifier for the template to which the preferred merchant list is bound, ensuring the list is associated with the correct template. |
| Finder | String | Search term or identifier used to locate and filter preferred merchant list records within the system, aiding in efficient data retrieval. |
Stores external bank account details for payments or reimbursements, supporting account creation, modifications, and usage tracking.
| Name | Type | Description |
| BankAccountNumber | String | Account number of the external bank account, used to identify the account within the banking system. |
| CountryCode | String | Country code of the external bank account, specifying the country in which the account is held. |
| BankBranchIdentifier | Long | Unique identifier of the bank branch where the external bank account is maintained. |
| BankIdentifier | Long | Unique identifier of the bank where the external bank account is held, used for routing and identification purposes. |
| BankAccountId [KEY] | Long | Unique identifier for the external bank account, used for tracking and managing the account details. |
| CurrencyCode | String | Currency code of the external bank account, indicating the currency in which the account is denominated. |
| IBAN | String | International Bank Account Number (IBAN), an alphanumeric sequence that conforms to the ISO standard for uniquely identifying a bank account internationally. |
| CheckDigits | String | Digits used to verify the accuracy or validity of the external bank account number, ensuring that the account number is correct. |
| AccountType | String | Type of external bank account. Possible values include 'Savings' and 'Checking', indicating the nature of the account. |
| AccountSuffix | String | Suffix added to the bank account number in some countries, used to differentiate between various accounts held by the same customer. |
| AgencyLocationCode | String | Agency location code associated with the external bank account, used for identifying the location of the bank branch. |
| AllowInternationalPaymentIndicator | String | Indicates whether the external bank account can be used for international payments or is restricted to domestic payments only. |
| SecondaryAccountReference | String | Reference number for a secondary external bank account, used in certain countries for categorizing bank accounts (for example, the Building Society Roll Number in the UK). |
| StartDate | Date | Date when the external bank account became active, marking the start of its use for transactions. |
| EndDate | Date | Date when the external bank account becomes inactive, marking the end of its use for transactions. |
| BankAccountName | String | Name associated with the external bank account, typically the account holder’s name or business name. |
| AlternateAccountName | String | Alternate name for the external bank account, often used for differentiating accounts or in cases where the account is shared. |
| BankBranchPartyIndicator | String | Indicates whether the external bank account is linked to a bank and branch created in Trading Community Architecture (TCA), used for managing bank-party relationships. |
| BankName | String | Name of the bank where the external bank account is held, identifying the financial institution. |
| BankNumber | String | Unique code or identifier assigned to the external bank by a banking regulatory authority, used for identifying the bank in transactions. |
| BankBranchName | String | Name of the bank branch where the external bank account is maintained, providing further identification of the account’s location. |
| BankBranchNumber | String | Number associated with a specific bank branch, known as a routing transit number in the United States or a sort code in the United Kingdom. |
| BIC | String | Bank Identifier Code (BIC), used by SWIFT to identify the external bank or branch, enabling the automated processing of telecommunication messages in banking. |
| VendorId | Long | Unique identifier for the vendor associated with the external bank account, used for supplier-related transactions. |
| PersonId | Long | Unique identifier for the person who owns the external bank account, typically used when the account owner is an employee. |
| Intent | String | Purpose of the external bank account, defining the intended use of the account for payment functions such as PAYABLES_DISB (Supplier), EMPLOYEE_EXP (Person/Employee), and CUSTOMER_PAYMENT (Customer). |
| PartyId | Long | Unique identifier for the party associated with the external bank account, typically representing the account holder or organization. |
| PayeeCreation | String | Indicates whether the external payee and associated instrument assignments should be created along with the bank account. Valid values are 'Y' for Yes and 'N' for No. |
| Finder | String | Search term or identifier used to locate and retrieve records related to external bank accounts in the system. |
Tracks the owners associated with an external bank account, defining authorization and responsibility for transactions.
| Name | Type | Description |
| ExternalBankAccountsBankAccountId [KEY] | Long | Unique identifier for the external bank account in the ExternalBankAccountsaccountOwners table, linking the account to its owner. |
| AccountOwnerPartyIdentifier | Long | Unique identifier for the party associated with the external bank account, representing the owner of the account. |
| AccountOwnerPartyNumber | String | Party number assigned to the external bank account owner, used to track and identify the party within the system. |
| AccountOwnerPartyName | String | Name of the party (individual or entity) that owns the external bank account, helping to identify the account holder. |
| PrimaryOwnerIndicator | String | Indicates whether the external bank account owner is the primary owner. Typically marked as 'Y' for yes and 'N' for no. |
| StartDate | Date | Date when the external bank account owner became active, marking the start of their association with the account. |
| EndDate | Date | Date when the external bank account owner becomes inactive, indicating the end of their association with the account. |
| AccountOwnerId [KEY] | Long | Application-generated identifier for the external bank account owner, used for internal tracking and management. |
| Intent | String | Purpose of the external bank account, indicating the payment function of the account. Values include PAYABLES_DISB (Supplier), EMPLOYEE_EXP (Person/Employee), CUSTOMER_PAYMENT (Customer), and others. |
| PersonId | Long | Unique identifier for the person associated with the account when the account owner is an employee, linking the bank account to a specific person. |
| AddJointAccountOwner | String | Indicates whether a joint account owner should be created if the bank account already exists. Valid values are 'Y' (Yes) and 'N' (No). |
| BankAccountId | Long | Unique identifier for the bank account linked to the account owner, referencing the external bank account associated with the party. |
| BankAccountNumber | String | Account number associated with the external bank account, used for transactions and identifying the account within the banking system. |
| BankBranchIdentifier | Long | Unique identifier for the bank branch where the external bank account is maintained, used to reference the specific branch location. |
| BankBranchName | String | Name of the bank branch where the external bank account is held, providing further identification of the account's location. |
| BankIdentifier | Long | Unique identifier for the bank where the external bank account is held, used for routing and bank identification purposes. |
| BankName | String | Name of the bank where the external bank account is maintained, identifying the financial institution. |
| CountryCode | String | Country code of the external bank account, indicating the country in which the bank account is located. |
| CurrencyCode | String | Currency code of the external bank account, specifying the currency in which the account operates. |
| Finder | String | Search term or identifier used to locate and filter specific external bank account owner records, aiding in efficient data retrieval. |
| IBAN | String | International Bank Account Number (IBAN) associated with the external bank account owner, providing a standardized way to identify the account internationally. |
Manages budget execution rules for federal accounting requirements, ensuring compliance with government financial guidelines.
| Name | Type | Description |
| ControlTypeId [KEY] | Long | Unique identifier for the control type associated with the budget execution control, used to categorize different types of budget controls. |
| BudgetControl | String | Identifier for the budget control within the budget execution system, used to track and manage budget constraints and permissions. |
| Description | String | Detailed description of the budget execution control, explaining its purpose and functionality within the budget system. |
| Ledger | String | Ledger associated with the budget execution control, used for managing and tracking budget entries within the accounting system. |
| BudgetLevel | String | Level of the budget execution control, indicating whether it applies at the organization, department, or other hierarchical level. |
| Status | String | Current status of the budget execution control, indicating whether it is active, inactive, or in another state. |
| ParentBudgetControl | String | Parent budget control, linking the current control to a higher-level control within the budget hierarchy. |
| BudgetCategory | String | Category of the budget execution control, used to classify and manage different types of budget items. |
| DefaultTransactionType | String | Default transaction type associated with the budget execution control, determining how budget transactions are recorded. |
| ClosingTransactionType | String | Closing transaction type used when finalizing budget records for a period or completing a budget process. |
| BudgetManager | String | Name of the budget manager responsible for overseeing the budget execution control and ensuring its compliance. |
| BudgetAccount | String | Account associated with the budget execution control, used for tracking and managing the specific budgetary funds. |
| BudgetDistributionAccount | String | Account for distributing funds within the budget, used for allocating budget amounts to various departments or units. |
| DistributeBudget | String | Indicates whether the budget should be distributed automatically across different units or categories based on predefined rules. |
| ConsumeBudget | String | Indicates whether the budget can be consumed or utilized by different departments or categories, defining how budget allocations are used. |
| ParentBudgetLevel | String | Higher-level budget category or department associated with the current budget execution control, helping to categorize it within a larger structure. |
| ControlLevel | String | Level at which the budget execution control operates, such as departmental, project-based, or company-wide controls. |
| TolerancePercent | Decimal | Tolerance percentage that defines the acceptable variation from the budgeted amount, allowing some flexibility in budget execution. |
| ToleranceAmount | Decimal | Tolerance amount that defines the specific dollar or currency amount of variation allowed in the budget execution. |
| IsParentControl | String | Indicates whether the current control is a parent control, which may govern subordinate budget controls within the system. |
| BudgetLevelSequenceNumber | Long | Sequence number for the budget level, used for organizing and prioritizing budget levels in the system. |
| AllowOverrides | String | Flag indicating whether budget overrides are allowed within the control, enabling flexibility for budget managers to adjust allocations. |
| BudgetChartOfAccounts | String | Chart of accounts used for tracking the budget execution control, categorizing accounts for accounting and reporting purposes. |
| CreationDate | Datetime | Timestamp indicating when the budget execution control record was created, helping to track when the control was established. |
| LastUpdateLogin | String | Login session associated with the user who last updated the budget execution control record, ensuring traceability for updates. |
| LastUpdatedBy | String | Username of the individual who last updated the budget execution control record, providing accountability for changes. |
| LastUpdateDate | Datetime | Timestamp of the most recent update made to the budget execution control, allowing for accurate tracking of modifications. |
| CreatedBy | String | Username of the individual who created the budget execution control record, providing accountability for record creation. |
| Finder | String | Search term or identifier used to locate and retrieve budget execution control records from the system. |
| SearchAllText | String | Text used for full-text searching across all fields of the budget execution control records, facilitating comprehensive searches. |
| SysEffectiveDate | String | System-defined effective date, indicating when the budget execution control record becomes valid and applicable in the system. |
| EffectiveDate | Date | Date parameter used to fetch resources that are effective as of a specified start date, ensuring time-sensitive data retrieval. |
Specifies the segment rules within federal budget controls, dictating how funds are tracked and restricted across various accounts.
| Name | Type | Description |
| FedBudgetExecutionControlsControlTypeId [KEY] | Long | Unique identifier for the control type associated with the budget-execution control segment, used to categorize and manage different control types. |
| KeySegmentId [KEY] | Long | Unique identifier for the key segment within the budget-execution control segment, providing a way to track and manage individual segments in the budget. |
| SegmentCode | String | Code representing the segment of the budget-execution control, used for identifying and categorizing budget components. |
| SummaryControl | String | Summary control associated with the budget-execution control segment, used to define how the control is summarized within the broader budget. |
| SequenceNumber | Int | Sequence number that determines the order of the budget-execution control segments, helping to maintain proper sequence and structure. |
| ControlBudgetTree | String | Control budget tree associated with the budget-execution control segment, helping to define how the budget is structured and allocated. |
| ControlBudgetTreeVersion | String | Version of the control budget tree, indicating changes or updates to the budget structure over time. |
| ControlBudgetTreeLabel | String | Label used to identify and describe the control budget tree for the execution control segment. |
| IsBalancingSegment | String | Indicates whether the segment is a balancing segment, used for ensuring that the budget segments are properly balanced. |
| IsAccountSegment | String | Indicates whether the segment represents an account segment, used for tracking budget allocation and spending by account. |
| ExistsOnParent | String | Attribute indicating whether the segment exists on the parent budget control, linking child and parent budget segments. |
| FilterTree | String | Filter tree associated with the budget-execution control segment, used to apply filtering logic to determine which elements are included in the budget control. |
| FilterTreeVersion | String | Version of the filter tree, indicating changes or updates to the filtering logic applied to the budget control segment. |
| FilterTreeValue | String | Specific value within the filter tree, used to define how the filtering logic applies to individual budget control segments. |
| SegmentName | String | Name of the segment in the budget-execution control, used for identification and reference. |
| CreatedBy | String | Username of the individual who created the budget-execution control record, ensuring accountability for the creation process. |
| CreationDate | Datetime | Timestamp of when the budget-execution control record was created, helping to track the record's establishment. |
| LastUpdateDate | Datetime | Timestamp of the most recent update made to the record, helping to track modifications and ensure data accuracy. |
| LastUpdateLogin | String | Login session associated with the user who last updated the record, ensuring traceability for updates. |
| LastUpdatedBy | String | Username of the individual who last modified the record, providing accountability for changes made. |
| BudgetAccount | String | Account associated with the budget-execution control segment, used for tracking and categorizing financial transactions. |
| BudgetCategory | String | Category of the budget-execution control, helping to classify and manage different types of budget items. |
| BudgetChartOfAccounts | String | Chart of accounts associated with the budget-execution control, defining the structure for financial reporting and classification. |
| BudgetControl | String | Control associated with the budget execution process, ensuring that budget constraints and guidelines are followed. |
| BudgetLevel | String | Level within the budget hierarchy, helping to categorize and manage budget controls based on their organizational or financial scope. |
| BudgetManager | String | Name of the budget manager responsible for overseeing the budget-execution control and ensuring compliance. |
| ControlLevel | String | Level at which the budget-execution control is applied, indicating whether it is departmental, project-based, or company-wide. |
| ControlTypeId | Long | Unique identifier for the control type, used to define the specific rules and behaviors associated with a given control. |
| Description | String | Detailed description of the budget-execution control segment, explaining its function and how it fits within the broader budget structure. |
| Finder | String | Search term or identifier used to locate and filter specific records of budget-execution controls, aiding in efficient data retrieval. |
| Ledger | String | Ledger associated with the budget-execution control, used to track and report on financial transactions within the budget. |
| ParentBudgetControl | String | Parent budget control, linking the current budget-execution control to a higher-level control in the budget hierarchy. |
| ParentBudgetLevel | String | Parent budget level, linking the current budget-execution control segment to a broader level within the budget. |
| SearchAllText | String | Text used for full-text searching across all fields of the budget-execution control records, facilitating comprehensive searches. |
| Status | String | Current status of the budget-execution control, indicating whether it is active, inactive, or in another state. |
| SysEffectiveDate | String | System-defined effective date, marking when the budget-execution control record becomes valid and applicable within the system. |
| EffectiveDate | Date | Date used to fetch resources that are effective as of a specified start date, ensuring accurate retrieval of time-sensitive data. |
Lists defined Financials business units, clarifying operational scope (for example, ledger, default currency) for each unit.
| Name | Type | Description |
| BusinessUnitId [KEY] | Long | Unique identifier for the business unit in the FinBusinessUnitsLOV table, used for referencing and managing individual business units within the system. |
| BusinessUnitName | String | Name of the business unit, used to identify and differentiate various business units within the organization. |
| ActiveFlag | Bool | Flag indicating whether the business unit is active or inactive, helping to manage and track the operational status of the business unit. |
| PrimaryLedgerId | String | Unique identifier for the primary ledger associated with the business unit, used for financial reporting and accounting. |
| LocationId | Long | Unique identifier for the location of the business unit, helping to associate the business unit with a specific geographical or operational location. |
| ManagerId | String | Unique identifier for the manager associated with the business unit, providing accountability and tracking of responsibilities. |
| LegalEntityId | String | Unique identifier for the legal entity associated with the business unit, helping to link the business unit to the appropriate legal structure. |
| ProfitCenterFlag | Bool | Flag indicating whether the business unit functions as a profit center, used for financial analysis and reporting. |
| DownstreamFunctionId | Long | Identifier for the downstream function associated with the business unit, linking it to other operational functions or processes in the system. |
| Finder | String | Search term or identifier used to locate and retrieve business unit records, enhancing the ability to search for and filter business units. |
| Intent | String | Purpose or intent of the business unit, typically defining its role or function within the larger organization (for example, revenue generation, support, etc.). |
| ModuleId | Long | Unique identifier for the module associated with the business unit, helping to track and categorize business units by their operational or system module. |
| SearchTerm | String | Term used for searching business unit records, typically related to any field in the business unit's record for efficient data retrieval. |
| UpstreamFunctionId | Long | Identifier for the upstream function linked to the business unit, connecting the unit to other related functions or processes in the system. |
| EffectiveDate | Date | Date parameter used to fetch resources that are effective as of a specified start date, ensuring the retrieval of time-sensitive data. |
Displays available finder functions and their queryable attributes for different views, aiding in data retrieval and analysis.
ViewName is required to get the mapping FinderName and finder parameter column.
The ViewName column supports = and IN operators
SELECT * FROM Finders where viewname = 'Invoices'
SELECT * FROM Finders where viewname IN ('Invoices','InvoicesinvoiceLines')
| Name | Type | Description |
| ViewName | String | Name of the view for which the finder is used, specifying the data context in which the finder operation is performed. |
| FinderName | String | Name of the finder, used to identify and reference a specific search function or query operation within the system. |
| AttributeFinderColumn | String | Name of the specific attribute within the finder, used to identify which column or data point the search function is applied to. |
| Type | String | Datatype of the finder attribute, specifying the data type (for example, string, integer, date) for the attribute being searched in the view. |
Assigns payment instruments (for example, checks, electronic transfers) to specific payees or transactions, ensuring controlled disbursement.
| Name | Type | Description |
| PaymentInstrumentAssignmentId [KEY] | Long | Unique identifier for the payment instrument assignment, used to track the assignment of a specific payment instrument to a payer or payee. |
| PaymentPartyId | Long | Unique identifier for the external payer or payee, representing the party involved in the payment instrument assignment. |
| PaymentInstrumentId | Long | Unique identifier for the payment instrument (bank account or credit card) that is part of the payment instrument assignment. |
| PaymentFlow | String | Payment flow associated with the payment instrument assignment, indicating whether the transaction involves funds capture or disbursement. Values are sourced from the IBY_PAYMENT_FLOW lookup. |
| PaymentInstrumentType | String | Type of payment instrument used in the assignment, such as BANKACCOUNT, CREDITCARD, or DEBITCARD. Values are from the IBY_INSTRUMENT_TYPES lookup. |
| PrimaryIndicator | String | Flag indicating whether the payment instrument is the primary payment method for the payer or payee. Primary instruments automatically populate transactions. |
| StartDate | Date | Date when the relationship between the payment instrument and the payer or payee becomes active, marking the beginning of its use. |
| EndDate | Date | Date when the relationship between the payment instrument and the payer or payee becomes inactive, signaling the end of its use. |
| MaskedBankAccountNumber | String | Masked version of the bank account number associated with the payment instrument assignment, providing security by obscuring sensitive data. |
| MaskedCreditCardNumber | String | Masked version of the credit card number associated with the payment instrument assignment, ensuring that sensitive data is not exposed. |
| VendorId | Long | Unique identifier for the vendor associated with the payment instrument assignment, linking it to the specific vendor in the system. |
| PersonId | Long | Unique identifier for the person associated with the payment instrument assignment, typically used when the payee is an employee. |
| Intent | String | Purpose of the payment instrument assignment, defining the payment function. Expected values include PAYABLES_DISB (Supplier), EMPLOYEE_EXP (Person/Employee), CUSTOMER_PAYMENT (Customer), and others. |
| Finder | String | Search term or identifier used to locate and retrieve specific payment instrument assignment records, aiding in efficient data retrieval. |
Provides a list of intercompany organizations, facilitating cross-entity transactions and consolidated financial reporting.
| Name | Type | Description |
| IntercoOrgId [KEY] | Long | Unique identifier for the intercompany organization in the IntercompanyOrganizationsLOV table, used to track and manage intercompany relationships. |
| IntercoOrgName | String | Name of the intercompany organization, used for identifying and categorizing the various intercompany entities. |
| EnabledFlag | Bool | Flag indicating whether the intercompany organization is enabled or active, helping to manage the operational status of the organization. |
| Name | String | Name of the intercompany organization, used for reference and identification in the system. |
| LegalEntityIdentifier | String | Unique identifier for the legal entity associated with the intercompany organization, used for legal and compliance tracking. |
| PayBuId | Long | Unique identifier for the paying business unit associated with the intercompany organization, used to track financial responsibilities. |
| RecBuId | Long | Unique identifier for the receiving business unit associated with the intercompany organization, used to track financial receipts and allocations. |
| Finder | String | Search term or identifier used to locate and retrieve specific intercompany organization records, enhancing the ability to search for and filter organizations. |
| Intent | String | Purpose or intent of the intercompany organization, specifying its role or function within the larger business structure. |
| ProviderLeId | Long | Unique identifier for the provider legal entity associated with the intercompany organization, linking the organization to the broader legal entity. |
| ProviderOrgId | Long | Unique identifier for the provider organization associated with the intercompany relationship, used to track the providing entity. |
| SearchTerm | String | Term used for searching intercompany organization records, facilitating efficient data retrieval based on relevant keywords. |
Displays recognized intercompany transaction types, specifying processing rules and ensuring consistent handling in multi-entity environments.
| Name | Type | Description |
| TrxTypeId [KEY] | Long | Unique identifier for the intercompany transaction type, used to track and categorize different types of intercompany transactions. |
| TrxTypeName | String | Name of the intercompany transaction type, used to identify and differentiate various transaction types within the intercompany structure. |
| EnabledFlag | Bool | Flag indicating whether the intercompany transaction type is enabled or active, used to manage whether the transaction type can be used in business processes. |
| MasterIntercompanyTrxFlag | Bool | Flag indicating whether the transaction type is a master intercompany transaction, which may control or influence other related transactions. |
| AllowInvoicingFlag | Bool | Flag indicating whether invoicing is allowed for the specific intercompany transaction type, helping to manage invoicing rules within the organization. |
| ManualApproveFlag | Bool | Flag indicating whether manual approval is required for transactions of this type, controlling whether transactions can be processed automatically or need oversight. |
| Finder | String | Search term or identifier used to locate and retrieve specific intercompany transaction type records, aiding in efficient data retrieval. |
| SearchTerm | String | Term used for searching intercompany transaction types, helping to find records based on relevant keywords or attributes. |
Holds temporary payables documents pending validation and payment, enabling partial or staged invoice creation.
| Name | Type | Description |
| InvoiceExternalSupplierSiteIdentifier | Long | Unique identifier of the external supplier associated with the invoice. |
| ObjectVersionNumber | Int | Version number of the interim document in the payables system, used for version tracking and management. |
| CallingApplicationDocumentUniqueReferenceFive | String | Document unique reference five from the calling application, used to track the document in external systems. |
| InvoiceExternalPayeePartyIdentifier | Long | Unique identifier of the external payee party associated with the invoice, used to track the recipient. |
| PayeePartyIdentifier | Long | Unique identifier for the payee party, representing the entity receiving the payment. |
| OrganizationIdentifier | Long | Unique identifier for the organization associated with the invoice, used for organization-level tracking. |
| InvoicingLegalEntityIdentifier | String | Unique identifier for the legal entity issuing the invoice, used for legal and compliance tracking. |
| RelationshipIdentifier | Long | Unique identifier for the relationship between the payee and supplier, linking the entities involved in the invoice. |
| RemittanceMessageThree | String | Remittance message three, providing additional details about the payment or invoice status. |
| BankAssignedReferenceCode | String | Reference code assigned by the bank to the payment, used for tracking and reconciliation purposes. |
| PaymentFunction | String | Code that indicates the purpose of the payment, such as 'SUPPLIER_PAYMENT' or 'CUSTOMER_REFUNDS'. |
| PaymentAmount | Decimal | Amount to be paid as part of the transaction, specified in the payment request. |
| PaymentProfileIdentifier | Long | Unique identifier for the payment profile, helping to link payment information to specific profiles. |
| DeliveryChannelCode | String | Code indicating the channel used for payment delivery, such as electronic transfer or check. |
| InvoiceExternalPayeeIdentifier | Long | Unique identifier of the external payee, helping to track the entity receiving the payment. |
| ExclusivePaymentFlag | Bool | Flag indicating whether the payment is exclusive, meaning that it is reserved for a specific payee. |
| ExternalBankAccountIdentifier | Long | Unique identifier for the external bank account used for the payment. |
| AnticipatedValueDate | Date | The anticipated date when the payment is processed or cleared. |
| DocumentDescription | String | A description of the document, providing context or further details about the invoice or payment. |
| DiscountDate | Date | The computed date by which a payment must be made to avail a discount. |
| PaymentFormatCode | String | Code that specifies the format used for the payment, such as electronic funds transfer or check. |
| InterestRate | Decimal | Interest rate applicable to the payment or invoice, typically for overdue payments. |
| InvoiceExternalPayeePartySiteIdentifier | Long | Unique identifier for the payee party site, linking the payee's address to the payment transaction. |
| InvoicingOrganizationType | String | Indicates the type of the organization that is issuing the invoice, such as a vendor or government entity. |
| PaymentDueDate | Date | Date by which the payment is due to the payee or supplier. |
| DocumentDate | Date | Date when the document (invoice or payment request) was created. |
| PaymentCurrencyCode | String | Currency code of the payment, indicating the type of currency used for the transaction. |
| PaymentProcessTransactionTypeCode | String | Code indicating the type of payment process transaction, such as 'PREPAYMENT' or 'FINALPAYMENT'. |
| PaymentReasonCode | String | Code that indicates the reason for the payment, such as 'INVOICE' or 'REFUND'. |
| LegalEntityIdentifier | Decimal | Unique identifier for the legal entity involved in the transaction, ensuring proper legal categorization. |
| AmountWithheld | Decimal | The amount withheld in a transaction, typically for tax purposes or to fulfill regulatory requirements. |
| PaymentCurrencyDiscountTaken | Decimal | The discount taken in the payment currency, applied when paying before the discount deadline. |
| DoumentSequenceIdentifer | Decimal | Unique identifier for the document sequence, used for document classification and tracking. |
| CallingApplicationDocumentReferenceNumberOne | String | Reference number one of the calling application document, helping to track the document externally. |
| RemitToLocationIdentifier | Long | Unique identifier for the location where the payment is to be remitted, such as a specific address or branch. |
| PayeePartySiteIdentifier | Long | Unique identifier for the payee's site, typically representing a physical location or address for payment purposes. |
| AllowRemovingDocumentFlag | Bool | Flag indicating whether the document can be removed from the system, allowing for flexibility in document management. |
| DocumentType | String | Type of document, which could include invoice, payment request, or credit memo, among others. |
| RemittanceMessageOne | String | Remittance message one, providing details about the payment and related information. |
| SupplierSiteIdentifier | Long | Unique identifier for the supplier's site, indicating the specific location or branch where the supplier conducts business. |
| InternalBankAccountIdentifier | Long | Unique identifier for the internal bank account used to process the payment internally. |
| DocumentAmount | Decimal | The total amount specified in the document, which could be an invoice, credit memo, or payment. |
| OrganizationType | String | Type of the organization, used for classification purposes (for example, vendor, government). |
| DocumentCurrencyCode | String | Currency code associated with the document, indicating the currency in which the invoice or payment is denominated. |
| PaymentGroupingNumber | Long | Payment grouping number used to group multiple payments together, simplifying processing and reconciliation. |
| BankChargeAmount | Decimal | The amount charged by the bank for processing the payment, typically associated with transaction fees. |
| DocumentCurrencyPaymentAmount | Decimal | The payment amount in the document currency, indicating the total amount to be paid. |
| PaymentDate | Date | Date when the payment was made, indicating the transaction completion date. |
| DocumentCurrencyTaxAmount | Decimal | The tax amount associated with the payment or document, specified in the document's currency. |
| DocumentSequenceValue | Decimal | Unique identifier for the document sequence, used to maintain the order of documents. |
| PaymentReasonComments | String | Comments providing additional context or justification for the payment reason. |
| CallingApplicationIdentifier | Long | Unique identifier for the calling application that initiated the payment or invoice transaction. |
| PaymentMethodCode | String | Code indicating the method of payment, such as electronic funds transfer, check, or cash. |
| PaymentCurrencyBankCharges | Long | Bank charges applied in the payment currency, accounting for any fees associated with the transaction. |
| CallingApplicationDocumentReferenceNumber | Long | Reference number of the calling application document, linking the payment to the external system. |
| DocumentCurrencyChargeAmount | Decimal | The charge amount in the document's currency, typically indicating additional fees or charges. |
| SettlementPriority | String | Indicates the priority for executing a payment, helping to prioritize payments based on urgency. |
| ProcessType | String | Indicates the type of process, such as 'PAYMENT' or 'REFUND', guiding how the payment is processed. |
| InvoicingOrganizationIdentifier | Long | Unique identifier for the invoicing organization, helping to link the invoice to the issuing entity. |
| BankChargeBearer | String | Indicates who bears the bank charges, such as the payer or payee. |
| RemittanceMessageTwo | String | Remittance message two, providing further details about the payment and transaction. |
| DocumentCategoryCode | String | Code that categorizes the document, such as 'Invoice' or 'Credit Memo'. |
| UniqueRemittanceIdentifierCheckDigit | String | Check digit used to validate the unique remittance identifier, ensuring the identifier's correctness. |
| UniqueRemittanceIdentifier | String | Unique identifier for the remittance, providing a distinct reference for tracking the payment. |
| CallingApplicationDocumentUniqueReferenceFour | String | Document unique reference four of the calling application. |
| CallingApplicationDocumentUniqueReferenceThree | String | Document unique reference three of the calling application. |
| CallingApplicationDocumentUniqueReferenceTwo | String | Document unique reference two of the calling application. |
| GlobalAttributeOne | String | Attribute one of the global descriptive flexfield, used for custom data capture. |
| GlobalAttributeTen | String | Attribute ten of the global descriptive flexfield, allowing for additional custom fields. |
| GlobalAttributeEleven | String | Attribute eleven of the global descriptive flexfield. |
| GlobalAttributeTwelve | String | Attribute twelve of the global descriptive flexfield. |
| GlobalAttributeThirteen | String | Attribute thirteen of the global descriptive flexfield. |
| GlobalAttributeFourteen | String | Attribute fourteen of the global descriptive flexfield. |
| GlobalAttributeFifteen | String | Attribute fifteen of the global descriptive flexfield. |
| GlobalAttributeSixteen | String | Attribute sixteen of the global descriptive flexfield. |
| GlobalAttributeSeventeen | String | Attribute seventeen of the global descriptive flexfield. |
| GlobalAttributeEighteen | String | Attribute eighteen of the global descriptive flexfield. |
| GlobalAttributeTwo | String | Attribute two of the global descriptive flexfield. |
| GlobalAttributeTwenty | String | Attribute twenty of the global descriptive flexfield. |
| GlobalAttributeThree | String | Attribute three of the global descriptive flexfield. |
| GlobalAttributeFour | String | Attribute four of the global descriptive flexfield. |
| GlobalAttributeFive | String | Attribute five of the global descriptive flexfield. |
| GlobalAttributeSix | String | Attribute six of the global descriptive flexfield. |
| GlobalAttributeSeven | String | Attribute seven of the global descriptive flexfield. |
| GlobalAttributeEight | String | Attribute eight of the global descriptive flexfield. |
| GlobalAttributeNine | String | Attribute nine of the global descriptive flexfield. |
| GlobalAttributeCategory | String | Category that the global attribute belongs to, helping organize attributes based on their use. |
| GlobalAttributeDateOne | Date | Date one of the global descriptive flexfield, capturing date-related custom data. |
| GlobalAttributeDateTwo | Date | Date two of the global descriptive flexfield. |
| GlobalAttributeDateThree | Date | Date three of the global descriptive flexfield. |
| GlobalAttributeDateFour | Date | Date four of the global descriptive flexfield. |
| GlobalAttributeDateFive | Date | Date five of the global descriptive flexfield. |
| GlobalAttributeNumberOne | Decimal | Numeric attribute one of the global descriptive flexfield, used for capturing numeric data. |
| GlobalAttributeNumberTwo | Decimal | Numeric attribute two of the global descriptive flexfield. |
| GlobalAttributeNumberThree | Decimal | Numeric attribute three of the global descriptive flexfield. |
| GlobalAttributeNumberFour | Decimal | Numeric attribute four of the global descriptive flexfield. |
| GlobalAttributeNumberFive | Decimal | Numeric attribute five of the global descriptive flexfield. |
| AttributeOne | String | Attribute one of the user descriptive flexfield, used for capturing user-defined data. |
| AttributeTen | String | Attribute ten of the user descriptive flexfield. |
| AttributeEleven | String | Attribute eleven of the user descriptive flexfield. |
| AttributeTwelve | String | Attribute twelve of the user descriptive flexfield. |
| AttributeThirteen | String | Attribute thirteen of the user descriptive flexfield. |
| AttributeFourteen | String | Attribute fourteen of the user descriptive flexfield. |
| AttributeFifteen | String | Attribute fifteen of the user descriptive flexfield. |
| AttributeTwo | String | Attribute two of the user descriptive flexfield. |
| AttributeThree | String | Attribute three of the user descriptive flexfield. |
| AttributeFour | String | Attribute four of the user descriptive flexfield. |
| AttributeFive | String | Attribute five of the user descriptive flexfield. |
| AttributeSix | String | Attribute six of the user descriptive flexfield. |
| AttributeSeven | String | Attribute seven of the user descriptive flexfield. |
| AttributeEight | String | Attribute eight of the user descriptive flexfield. |
| AttributeNine | String | Attribute nine of the user descriptive flexfield. |
| AttributeCategory | String | Category that the attribute belongs to, providing classification for user attributes. |
| ValidationErrorMessage | String | Message indicating any validation errors encountered during the processing of the interim document. |
| ValidationSuccessIndicator | String | Indicator showing whether the document passed validation (for example, 'Success' or 'Failure'). |
| PurchaseOrderNumber | String | Unique identifier for the purchase order associated with the document, linking the payment to the specific purchase. |
| CallingApplicationDocumentUniqueReferenceOne | String | First unique reference for the calling application document, aiding in document identification. |
| DocumentPayableId [KEY] | Long | Unique identifier of the document payable, used for tracking the payable transaction. |
| GlobalAttributeNinteen | String | Attribute nineteen of the global descriptive flexfield. |
| PayGroupCode | String | Code indicating the category that suppliers or invoices belong to, such as Employees, Merchandise, or Domestic. |
| Finder | String | Search term or identifier used to locate and retrieve specific interim document payable records. |
Shows prepayment amounts applied to a given invoice, helping track remaining balances and total obligations.
| Name | Type | Description |
| InvoicesInvoiceId [KEY] | Long | Unique identifier of the invoice associated with the applied prepayment, used for tracking and managing invoice data. |
| InvoiceNumber | String | Unique number of the invoice, used to identify the invoice in the applied prepayment context. |
| LineNumber [KEY] | Int | Line number associated with the invoice applied prepayment, used to differentiate between multiple lines on the same invoice. |
| Description | String | Description of the applied prepayment, providing details about the transaction or prepayment. |
| SupplierSite | String | Supplier site associated with the applied prepayment, indicating the physical location of the supplier linked to the prepayment. |
| PurchaseOrder | String | Purchase order associated with the applied prepayment, linking the prepayment to the specific purchase order. |
| Currency | String | Currency used for the applied prepayment, specifying the type of currency in which the prepayment was made. |
| AppliedAmount | Decimal | Amount of the prepayment that has been applied to the invoice, showing how much has been used from the prepayment. |
| IncludedTax | Decimal | Tax amount included in the applied prepayment, specifying the portion of tax associated with the prepayment. |
| IncludedonInvoiceFlag | Bool | Flag indicating whether the prepayment is included in the invoice, providing clarity on its inclusion in the invoice calculation. |
| ApplicationAccountingDate | Date | Accounting date when the prepayment application is recorded, determining when it is reflected in financial records. |
| Finder | String | Search term or identifier used to locate and retrieve specific applied prepayment records. |
| InvoiceId | Long | Unique identifier of the invoice related to the applied prepayment, helping to associate the prepayment with its corresponding invoice. |
| CUReferenceNumber | Int | Reference number mapping the child aggregates with the parent tables, linking data between related entities. |
| EffectiveDate | Date | Date parameter used to fetch resources that are effective as of a specified start date, ensuring accurate retrieval of time-sensitive data. |
Stores attachments linked to an invoice header (for example, supporting documents), ensuring transparent record-keeping.
| Name | Type | Description |
| InvoicesInvoiceId [KEY] | Long | Unique identifier of the invoice associated with the attachment, helping to link the attachment to its corresponding invoice. |
| AttachedDocumentId [KEY] | Long | Unique identifier for the document that is attached, providing a reference to the specific document in the system. |
| LastUpdateDate | Datetime | Timestamp indicating when the attachment was last updated, tracking modifications made to the attachment. |
| LastUpdatedBy | String | Username of the individual who last updated the attachment, providing accountability for changes made. |
| FileName | String | Name of the file associated with the attachment, used to identify and reference the file. |
| DmFolderPath | String | Folder path where the attachment is stored, helping to locate and manage the attachment in the document management system. |
| DmDocumentId | String | Unique identifier for the document in the document management system, linking the attachment to its corresponding document. |
| DmVersionNumber | String | Version number of the document, helping to track changes and updates to the attachment over time. |
| Url | String | The URL where the attachment can be accessed, used for providing a link to the document or file. |
| Uri | String | The URI for the attachment, providing a unique resource identifier for accessing the attachment. |
| FileUrl | String | The URL of the attachment, allowing for direct access to the file from external sources. |
| UploadedText | String | Text content of the attachment, typically used for text-based files or documents. |
| UploadedFileContentType | String | The content type of the uploaded attachment, indicating the file format. |
| UploadedFileLength | Long | The length (size) of the attachment file, used for file size validation and storage management. |
| UploadedFileName | String | Name of the uploaded attachment file, used for identification and organization of files. |
| ContentRepositoryFileShared | Bool | Flag indicating whether the attachment file is shared, helping to manage access permissions. |
| Title | String | Title of the attachment, used for providing a brief description or label for the attachment. |
| Description | String | Description of the attachment, providing further details or context for the attachment. |
| ErrorStatusCode | String | Error code indicating any issues encountered during the attachment process, useful for debugging or troubleshooting. |
| ErrorStatusMessage | String | Error message describing any issues or failures related to the attachment, providing more details on the error. |
| CreatedBy | String | Username of the individual who created the attachment record, providing accountability for its creation. |
| CreationDate | Datetime | Timestamp indicating when the attachment was created, helping to track when the attachment was initially added. |
| FileContents | String | Contents of the attachment, typically used for representing the raw content of a text-based attachment. |
| ExpirationDate | Datetime | Expiration date for the attachment content, indicating when the attachment is no longer valid or should be removed. |
| LastUpdatedByUserName | String | Username of the individual who last updated the attachment record, for traceability and accountability. |
| CreatedByUserName | String | Username of the individual who created the attachment, ensuring proper tracking of creation actions. |
| AsyncTrackerId | String | Identifier used for tracking the status of file uploads asynchronously, helping to monitor and manage file upload processes. |
| FileWebImage | String | Web image of the attachment, typically represented as a Base64-encoded image for displaying in web applications. |
| DownloadInfo | String | JSON object containing the necessary information to programmatically retrieve the file attachment, providing metadata for download operations. |
| PostProcessingAction | String | Action that can be performed after the attachment is uploaded, such as validation or notification actions. |
| Category | String | Category of the attachment, used to classify attachments based on their type or purpose. |
| Type | String | Type of the attachment, providing more specific classification of the document or file. |
| Finder | String | Search term or identifier used to locate and retrieve specific attachment records, facilitating efficient data retrieval. |
| InvoiceId | Long | Unique identifier of the invoice associated with the attachment, used for tracking the attachment in the context of the invoice. |
| CUReferenceNumber | Int | Reference number mapping the child aggregates with the parent tables, linking data between related entities. |
| EffectiveDate | Date | Date parameter used to fetch resources that are effective as of a specified start date, ensuring accurate retrieval of time-sensitive data. |
Lists prepayments not yet applied to invoices, indicating funds available to offset future payables.
| Name | Type | Description |
| InvoicesInvoiceId [KEY] | Long | Unique identifier of the invoice associated with available prepayments, used to link the prepayment to the corresponding invoice. |
| InvoiceNumber | String | Unique number of the invoice, used for identifying and referencing the invoice in the context of available prepayments. |
| LineNumber [KEY] | Long | Line number associated with the invoice available prepayment, helping to distinguish between multiple lines within the same invoice. |
| Description | String | Description of the available prepayment, providing details about the transaction or prepayment. |
| SupplierSite | String | Supplier site associated with the available prepayment, indicating the location or branch of the supplier where the prepayment is applied. |
| PurchaseOrder | String | Purchase order number linked to the available prepayment, used to match the prepayment to the specific purchase order. |
| Currency | String | Currency used for the available prepayment, indicating the type of currency in which the prepayment was made. |
| AvailableAmount | Decimal | The amount of prepayment available to be applied to the invoice, indicating how much of the prepayment can be used. |
| IncludedTax | Decimal | The tax amount included in the available prepayment, specifying the portion of the tax associated with the prepayment. |
| Finder | String | Search term or identifier used to locate and retrieve specific available prepayment records, helping to enhance the ability to search and filter prepayments. |
| InvoiceId | Long | Unique identifier for the invoice related to the available prepayment, assisting in linking the prepayment to its corresponding invoice. |
| CUReferenceNumber | Int | Reference number mapping child aggregates with parent tables, providing the connection between related data entities. |
| EffectiveDate | Date | Date parameter used to fetch resources that are effective as of a specified start date, ensuring accurate retrieval of time-sensitive data. |
Holds global descriptive flexfields at the invoice level, capturing additional region-specific or business-specific attributes.
| Name | Type | Description |
| InvoicesInvoiceId [KEY] | Long | Unique identifier of the invoice associated with the descriptive flexfield, linking the flexfield data to the specific invoice. |
| InvoiceId [KEY] | Long | Invoice ID of the descriptive flexfield, used to track the flexfield data related to a particular invoice. |
| _FLEX_Context | String | Context name for the descriptive flexfield, indicating the specific context in which the flexfield data is being used or stored for the invoice. |
| _FLEX_Context_DisplayValue | String | Display value for the flexfield context, providing a human-readable version of the context name for better user understanding. |
| Finder | String | Search term or identifier used to locate and retrieve specific descriptive flexfield records, enhancing search capabilities within the system. |
| CUReferenceNumber | Int | Reference number mapping child aggregates to parent tables, linking the flexfield data with the parent data entities. |
| EffectiveDate | Date | Date parameter used to fetch resources that are effective as of a specified start date, ensuring that only relevant data is retrieved. |
Allows user-defined flexfields for invoice installments, enabling specialized reporting on partial payments or custom categories.
| Name | Type | Description |
| InvoicesInvoiceId [KEY] | Long | Unique identifier of the invoice associated with the installment descriptive flexfield, linking the flexfield data to its corresponding invoice. |
| InvoiceinstallmentsInstallmentNumber [KEY] | Long | Unique number assigned to the installment within the invoice, identifying the installment in relation to the invoice. |
| InvoiceId [KEY] | Long | The unique identifier for the invoice to which the installment descriptive flexfield is linked, providing context for the flexfield. |
| InstallmentNumber [KEY] | Long | The number used to uniquely identify an installment within the invoice, helping to track and differentiate each installment. |
| _FLEX_Context | String | Context name for the descriptive flexfield, indicating the specific context in which the flexfield data is being used for the installment. |
| _FLEX_Context_DisplayValue | String | Display value for the descriptive flexfield context, offering a human-readable version of the context name for easier understanding. |
| Finder | String | Search term or identifier used to locate and retrieve specific descriptive flexfield records related to invoice installments. |
| CUReferenceNumber | Int | Reference number that maps child aggregates to parent tables, linking flexfield data with related entities in the database. |
| EffectiveDate | Date | Date parameter used to fetch resources that are effective as of a specified start date, ensuring accurate and relevant data retrieval. |
Manages global descriptive flexfields for invoice installments, facilitating regionally unique or enterprise-wide data requirements.
| Name | Type | Description |
| InvoicesInvoiceId [KEY] | Long | Unique identifier for the invoice associated with the installment's global descriptive flexfield, linking the flexfield data to the corresponding invoice. |
| InvoiceinstallmentsInstallmentNumber [KEY] | Long | The unique number assigned to the installment within the invoice, identifying the installment in relation to the invoice for the global descriptive flexfield. |
| InvoiceId [KEY] | Long | The identifier of the invoice to which the global descriptive flexfield data for the installment is linked. |
| InstallmentNumber [KEY] | Long | The number used to uniquely identify an installment within the invoice, used for tracking and referencing the installment in global descriptive flexfield data. |
| _FLEX_Context | String | Context name for the global descriptive flexfield, indicating the specific context in which the flexfield data is being used for the invoice installment. |
| _FLEX_Context_DisplayValue | String | Display value for the global descriptive flexfield context, providing a human-readable version of the context name for easier understanding. |
| Finder | String | Search term or identifier used to locate and retrieve specific global descriptive flexfield records related to invoice installments. |
| CUReferenceNumber | Int | Reference number mapping the child aggregates with the parent tables, linking flexfield data with the related data entities. |
| EffectiveDate | Date | Date parameter used to fetch resources that are effective as of a specific start date, ensuring accurate retrieval of relevant data. |
Enables custom descriptive flexfields on invoice distributions, allowing organizations to store additional data for reporting or auditing.
| Name | Type | Description |
| InvoicesInvoiceId [KEY] | Long | Unique identifier of the invoice associated with the invoice distribution and its descriptive flexfield. |
| InvoicelinesLineNumber [KEY] | Int | Unique line number for the invoice line, representing the specific line associated with the invoice distribution's descriptive flexfield. |
| InvoicedistributionsInvoiceDistributionId [KEY] | Long | Unique identifier of the invoice distribution, linking it to the descriptive flexfield in the invoice line distribution. |
| InvoiceDistributionId [KEY] | Long | The unique identifier for the invoice distribution to which the descriptive flexfield is associated, used for identifying the distribution in the system. |
| _FLEX_Context | String | The context name of the descriptive flexfield, indicating the specific context or scenario in which the descriptive flexfield is applied. |
| _FLEX_Context_DisplayValue | String | The display value of the descriptive flexfield context, representing the context in a user-friendly format. |
| Finder | String | Search term or identifier used for locating the invoice distribution's descriptive flexfield in the system. |
| InvoiceId | Long | Unique identifier of the invoice to which the invoice distribution and its descriptive flexfield are associated. |
| CUReferenceNumber | Int | Reference number linking child aggregates to parent tables, ensuring consistency across related records. |
| EffectiveDate | Date | Date parameter used to fetch resources effective as of the specified start date, indicating the validity of the descriptive flexfield for that date. |
Holds global descriptive flexfields for invoice distributions, accommodating region-specific or enterprise-wide fields and validations.
| Name | Type | Description |
| InvoicesInvoiceId [KEY] | Long | Unique identifier of the invoice associated with the invoice distribution and its general descriptive flexfield (GDF). |
| InvoicelinesLineNumber [KEY] | Int | Unique line number for the invoice line, representing the specific line associated with the invoice distribution's general descriptive flexfield. |
| InvoicedistributionsInvoiceDistributionId [KEY] | Long | Unique identifier of the invoice distribution, linking it to the general descriptive flexfield in the invoice line distribution. |
| InvoiceDistributionId [KEY] | Long | The unique identifier for the invoice distribution to which the general descriptive flexfield is associated, used for identifying the distribution in the system. |
| _FLEX_Context | String | The context name of the general descriptive flexfield, indicating the specific context or scenario in which the flexfield is applied. |
| _FLEX_Context_DisplayValue | String | The display value of the general descriptive flexfield context, representing the context in a user-friendly format. |
| Finder | String | Search term or identifier used for locating the invoice distribution's general descriptive flexfield in the system. |
| InvoiceId | Long | Unique identifier of the invoice to which the invoice distribution and its general descriptive flexfield are associated. |
| CUReferenceNumber | Int | Reference number linking child aggregates to parent tables, ensuring consistency across related records. |
| EffectiveDate | Date | Date parameter used to fetch resources effective as of the specified start date, indicating the validity of the general descriptive flexfield for that date. |
Captures project-relevant details in a flexfield format for invoice distributions, integrating cost-tracking with project management.
| Name | Type | Description |
| InvoicesInvoiceId [KEY] | Long | Unique identifier of the invoice associated with the invoice distribution's project descriptive flexfield (DFF). |
| InvoicelinesLineNumber [KEY] | Int | Unique line number for the invoice line, representing the specific line associated with the invoice distribution's project descriptive flexfield. |
| InvoicedistributionsInvoiceDistributionId [KEY] | Long | Unique identifier of the invoice distribution, linking it to the project descriptive flexfield in the invoice line distribution. |
| InvoiceDistributionId [KEY] | Long | The unique identifier for the invoice distribution to which the project descriptive flexfield is associated, used for identifying the distribution in the system. |
| _FLEX_Context | String | The context name of the project descriptive flexfield, indicating the specific context or scenario in which the flexfield is applied. |
| _FLEX_Context_DisplayValue | String | The display value of the project descriptive flexfield context, representing the context in a user-friendly format. |
| Finder | String | Search term or identifier used for locating the invoice distribution's project descriptive flexfield in the system. |
| InvoiceId | Long | Unique identifier of the invoice to which the invoice distribution and its project descriptive flexfield are associated. |
| CUReferenceNumber | Int | Reference number linking child aggregates to parent tables, ensuring consistency across related records. |
| EffectiveDate | Date | Date parameter used to fetch resources effective as of the specified start date, indicating the validity of the project descriptive flexfield for that date. |
Provides descriptive flexfields at the invoice line level, supporting specialized data collection for each line item.
| Name | Type | Description |
| InvoicesInvoiceId [KEY] | Long | Unique identifier of the invoice associated with the invoice line's descriptive flexfield. |
| InvoicelinesLineNumber [KEY] | Int | Unique line number for the invoice line, representing the specific line associated with the descriptive flexfield. |
| InvoiceId [KEY] | Long | The unique identifier for the invoice to which the line descriptive flexfield is associated. |
| LineNumber [KEY] | Int | The number used to identify an invoice line to which the descriptive flexfield is associated. |
| _FLEX_Context | String | The descriptive flexfield context name for the invoice line, indicating the specific context or scenario in which the flexfield is applied. |
| _FLEX_Context_DisplayValue | String | The display value of the descriptive flexfield context for the invoice line, representing the context in a user-friendly format. |
| Finder | String | Search term or identifier used for locating the invoice line's descriptive flexfield in the system. |
| CUReferenceNumber | Int | Reference number linking child aggregates to parent tables, ensuring consistency across related records. |
| EffectiveDate | Date | Date parameter used to fetch resources effective as of the specified start date, indicating the validity of the descriptive flexfield for that date. |
Contains global descriptive flexfields for invoice lines, ensuring compliance with various regional or organizational requirements.
| Name | Type | Description |
| InvoicesInvoiceId [KEY] | Long | Unique identifier of the invoice associated with the invoice line's general descriptive flexfield (GDF). |
| InvoicelinesLineNumber [KEY] | Int | Unique line number for the invoice line, representing the specific line associated with the general descriptive flexfield. |
| InvoiceId [KEY] | Long | InvoiceId of the invoice associated with the invoice line's general descriptive flexfield. |
| LineNumber [KEY] | Int | The unique number for the invoice line to which the general descriptive flexfield is associated. |
| _FLEX_Context | String | The context name of the general descriptive flexfield for the invoice line, indicating the specific context or scenario in which the flexfield is applied. |
| _FLEX_Context_DisplayValue | String | The display value of the general descriptive flexfield context for the invoice line, representing the context in a user-friendly format. |
| Finder | String | Search term or identifier used for locating the invoice line's general descriptive flexfield in the system. |
| CUReferenceNumber | Int | Reference number linking child aggregates to parent tables, ensuring consistency across related records. |
| EffectiveDate | Date | Date parameter used to fetch resources effective as of the specified start date, indicating the validity of the general descriptive flexfield for that date. |
Tracks project details for individual invoice lines in a flexfield format, linking payables data to project cost structures.
| Name | Type | Description |
| InvoicesInvoiceId [KEY] | Long | Unique identifier of the invoice associated with the invoice line's project descriptive flexfield. |
| InvoicelinesLineNumber [KEY] | Int | Unique line number for the invoice line, representing the specific line associated with the project descriptive flexfield. |
| InvoiceId [KEY] | Long | InvoiceId of the invoice associated with the invoice line's project descriptive flexfield. |
| LineNumber [KEY] | Int | The unique number for the invoice line to which the project descriptive flexfield is associated. |
| _FLEX_Context | String | The context name of the project descriptive flexfield for the invoice line, indicating the specific context or scenario in which the flexfield is applied. |
| _FLEX_Context_DisplayValue | String | The display value of the project descriptive flexfield context for the invoice line, representing the context in a user-friendly format. |
| Finder | String | Search term or identifier used for locating the invoice line's project descriptive flexfield in the system. |
| CUReferenceNumber | Int | Reference number linking child aggregates to parent tables, ensuring consistency across related records. |
| EffectiveDate | Date | Date parameter used to fetch resources effective as of the specified start date, indicating the validity of the project descriptive flexfield for that date. |
Offers a lookup of defined ledgers, including primary, secondary, or reporting ledgers, enabling multi-ledger financial tracking.
| Name | Type | Description |
| AccountedPeriodType | String | The period type used for accounting in the ledger, specifying the frequency of periods (for example, monthly, quarterly). |
| ChartOfAccountsId | Long | Unique identifier for the chart of accounts associated with the ledger, defining the structure of account numbers and classifications. |
| Description | String | A descriptive text providing more details about the ledger and its usage in the financial system. |
| EnableBudgetaryControlFlag | Bool | Flag indicating whether budgetary control is enabled for the ledger to monitor expenditures within the defined budgets. |
| LedgerCategoryCode | String | Code that identifies the category of the ledger, such as Primary, Sub, or Reporting ledger. |
| LedgerId [KEY] | Long | Unique identifier for the ledger used for financial transactions and accounting. |
| Name | String | The name of the ledger, typically used to identify and distinguish between ledgers. |
| LedgerTypeCode | String | Code that specifies the type of ledger, such as General, Tax, or Currency ledger. |
| PeriodSetName | String | The name of the period set associated with the ledger, defining the accounting periods for transactions. |
| SequencingModeCode | String | Code that defines how document sequencing is handled in the ledger, such as manual or automatic. |
| ApDocumentSequencingOptionFlag | Bool | Flag indicating whether automatic document sequencing is enabled for Accounts Payable (AP) transactions. |
| ArDocumentSequencingOptionFlag | Bool | Flag indicating whether automatic document sequencing is enabled for Accounts Receivable (AR) transactions. |
| EnfSequenceDateCorrelationCode | String | Code used to correlate sequence dates in the ledger to ensure proper document sequencing. |
| CurrencyCode | String | The code representing the currency used in the ledger for recording transactions. |
| BindAccessSetId | Long | Unique identifier for the access set used to control access to the ledger's data and operations. |
| BindDefaultPeriodName | String | The default period name for the ledger, which is used for accounting and financial reporting purposes. |
| Finder | String | Search term or identifier used to locate specific ledger records in the system. |
| SearchTerm | String | A general search term associated with the ledger, used to filter or identify specific records related to the ledger. |
Lists recognized legal entities, indicating each entity’s legislative compliance and responsibilities in the corporate structure.
| Name | Type | Description |
| LegalEntityId [KEY] | Long | Unique identifier for the legal entity within the system. |
| Name | String | The name of the legal entity, used to identify it in the system. |
| LegalEntityIdentifier | String | A unique identifier assigned to the legal entity, which helps in distinguishing it from others. |
| EffectiveFrom | Date | The date from which the legal entity record is considered valid within the system. |
| EffectiveTo | Date | The date until which the legal entity record remains valid in the system, after which it is no longer active. |
| PartyId | Long | Unique identifier for the party associated with the legal entity, often representing the business or organization. |
| LeSystemDateTime | String | Timestamp representing the system date and time associated with the legal entity record. |
| Finder | String | Search term or keyword used for locating specific legal entity records in the system. |
| LedgerId | Long | Unique identifier for the ledger associated with the legal entity, used for managing financial transactions. |
| SearchTerm | String | A general search term or identifier related to the legal entity, used to filter or identify specific records. |
Provides a reference to legal jurisdictions with specific legal authorities, aiding tax and regulatory compliance.
| Name | Type | Description |
| JurisdictionId [KEY] | Long | Unique identifier for the jurisdiction within the system. |
| Name | String | The name of the legal jurisdiction, used to identify it in the system. |
| LegislativeCategoryCode | String | Code indicating the legislative category associated with the legal jurisdiction. |
| GeographyId | Long | Unique identifier for the geography or location associated with the legal jurisdiction. |
| IdentifyingFlag | Bool | Flag indicating whether this jurisdiction is identified as a primary jurisdiction for legal purposes. |
| StartDate | Date | The date when the legal jurisdiction becomes active and valid in the system. |
| EndDate | Date | The date when the legal jurisdiction is no longer active or valid in the system. |
| LegalEntityRegistrationCode | String | Code assigned to the legal entity for registration purposes within the jurisdiction. |
| LegalReportingUnitRegistrationCode | String | Code assigned to the legal reporting unit within the jurisdiction for regulatory compliance. |
| Finder | String | Search term or keyword used for locating specific legal jurisdiction records in the system. |
Enumerates legal reporting units, which represent the smallest entities requiring statutory reporting within a business structure.
| Name | Type | Description |
| LegalReportingUnitId [KEY] | Long | Unique identifier for the legal reporting unit within the system. |
| LegalReportingUnitName | String | The name of the legal reporting unit used to identify it in the system. |
| LegalEntityId | Long | Unique identifier for the legal entity associated with the legal reporting unit. |
| StartDate | Date | The date when the legal reporting unit becomes effective or valid in the system. |
| EndDate | Date | The date when the legal reporting unit ceases to be effective or valid in the system. |
| MainLegalReportingUnitFlag | Bool | Flag indicating whether this reporting unit is the primary legal reporting unit for the legal entity. |
| Finder | String | Search term or keyword used for locating specific legal reporting unit records in the system. |
Allows retrieval of valid memo lines used in Receivables, defining standardized text or charge descriptions for financial documents.
| Name | Type | Description |
| MemoLineId [KEY] | Long | Unique identifier for each memo line in the system. |
| Name | String | The name or title used to identify a specific memo line. |
| Description | String | A detailed description of the memo line. |
| TaxCode | String | The tax code associated with the memo line, used for tax calculations. |
| TaxProductCategory | String | The product category for tax purposes, used to classify products for taxation. |
| UOMCode | String | The unit of measure code used to define the quantity measurement for the memo line. |
| SetName | String | The set name which categorizes a group of memo lines, often for reporting purposes. |
| Finder | String | Search term or keyword used to locate specific memo lines in the system. |
Captures fiscal classification data for parties (for example, customers, suppliers), determining applicable tax or regulatory treatment.
| Name | Type | Description |
| ClassificationTypeCategCode | String | The classification type category code that helps group party fiscal classifications based on type. |
| Levels | String | Defines the level associated with a party fiscal classification, used to determine the scope or hierarchy for tax rules. |
| ClassificationTypeCode | String | The code used to represent the classification type associated with a party fiscal classification. |
| ClassificationTypeName | String | The name of the classification type, which describes the fiscal classification of a party. |
| EffectiveFrom | Date | The start date from which the party fiscal classification is considered effective. |
| EffectiveTo | Date | The date when the party fiscal classification stops being effective or is no longer applicable. |
| OwnerIdChar | String | Represents the owner of the classification category code associated with the party fiscal classification. |
| ClassificationTypeLevelCode | String | A code that identifies the classification type level associated with a party fiscal classification, indicating its hierarchy. |
| ClassificationTypeId [KEY] | Long | A unique identifier assigned to the party fiscal classification. |
| OwnerTableCode | String | The code associated with the table that owns the party fiscal classification data. |
| PartyClassification | String | A classification assigned to a party by tax authorities, used to categorize them for tax determination and reporting. |
| ClassificationCategoryMeaning | String | The descriptive name of the classification category related to a party fiscal classification. |
| ClassificationCode | String | The specific code representing a fiscal classification associated with a party. |
| ClassificationMeaning | String | The name or description of the fiscal classification that defines a party's tax status. |
| ClassCategory | String | Category assigned to the party fiscal classification, indicating the nature of the classification. |
| ClassTypeCode | String | Code representing the type of fiscal classification assigned to a party. |
| ClassTypeName | String | Name associated with the classification type, describing the party's fiscal categorization. |
| Finder | String | Search keyword or term used to locate party fiscal classifications in the system. |
Associates fiscal classification types with relevant tax regimes for correct tax calculation and compliance.
| Name | Type | Description |
| PartyFiscalClassificationsClassificationTypeId [KEY] | Long | Unique identifier for the party fiscal classification type within the tax regime associations. |
| ClassificationTypeCode [KEY] | String | The code representing the classification type associated with a party's fiscal classification in the tax regime. |
| TaxRegimeCode | String | The code representing the tax regime associated with the party fiscal classification. |
| EffectiveFrom | Date | The start date when the tax regime association becomes effective for the party fiscal classification. |
| EffectiveTo | Date | The end date when the tax regime association is no longer effective for the party fiscal classification. |
| ClassCategory | String | Category of the fiscal classification associated with the tax regime, used for categorization purposes. |
| ClassificationTypeId | Long | The unique identifier for the classification type associated with the fiscal classification within the tax regime. |
| ClassTypeCode | String | A code representing the specific class type associated with the fiscal classification for the tax regime. |
| ClassTypeName | String | The name given to the classification type in relation to the tax regime. |
| Finder | String | Search term or keyword used to locate the fiscal classification type tax regime associations. |
Holds tax profile information for a party, including tax registrations and configuration, ensuring proper tax handling and reporting.
| Name | Type | Description |
| PartyTypeCode | String | The code representing the type of party for which the tax profile is defined (for example, Customer, Supplier). |
| PartyName | String | The name of the party (customer or supplier) associated with the party tax profile. |
| PartyNumber | String | A unique number assigned to the party for identification purposes in the party tax profile. |
| PartySiteNumber | String | A unique number assigned to the party site (specific location) associated with the party tax profile. |
| RoundingLevelCode | String | The rounding level code used for rounding calculations in the party tax profile. |
| RoundingRuleCode | String | The rounding rule code that defines the specific rounding method for tax calculations in the party tax profile. |
| InclusiveTaxFlag | Bool | Indicates whether the party tax profile is set up to include tax in the price. The default value is NO. |
| TaxClassificationCode | String | The tax classification code associated with the party for tax determination and calculation. |
| CustomerFlag | Bool | Indicates whether the tax profile is associated with a customer. Valid values are Y or N. |
| SiteFlag | Bool | Indicates whether the tax profile is associated with a customer or supplier site. Valid values are Y or N. |
| SupplierFlag | Bool | Indicates whether the tax profile is for a supplier. Valid values are Y or N. |
| AllowOffsetTaxFlag | Bool | Indicates whether withholding tax (WHT) is allowed in the party tax profile. The default value is NO. |
| AllowZeroAmountWhtInvoiceFlag | Bool | Indicates whether the profile allows zero amount withholding tax invoices. The default value is NO. |
| CountryCode | String | The country code associated with the party's address for which the tax profile is defined. |
| EffectiveFromUseLe | Date | The date when the tax profile becomes effective, marking the start of its validity. |
| PartyId | Long | The unique identifier for the party that the tax profile belongs to. |
| ProcessForApplicabilityFlag | Bool | Indicates whether the party tax profile is considered in tax applicability determination. The default value is YES. |
| RegistrationTypeCode | String | The registration type code used to define the party's tax registration status. |
| RepresentativeRegistrationNumber | String | The registration number of the representative party for the tax profile. |
| UseLeAsSubscriberFlag | Bool | Indicates whether a business unit uses the legal entity's subscription for transaction tax determination. Default is NO. |
| WhtDateBasis | String | Defines the basis or date for withholding tax determination, used to calculate tax applicability. |
| WhtRoundingLevelCode | String | The rounding level code used for withholding tax calculation in the party's tax profile. |
| WhtRoundingRuleCode | String | The rounding rule code used for withholding tax calculation in the party's tax profile. |
| WhtUseLeAsSubscriberFlag | Bool | Indicates whether the legal entity's subscription is used for withholding tax determination. The default value is NO. |
| PartyTaxProfileId [KEY] | Long | A unique system-generated identifier for the party tax profile. |
| TaxGrossNetFlagCode | String | Indicates whether the tax is calculated on the net or gross amount for Payables retainage invoices. The default value is Net. |
| BPartyId | Long | The business party identifier associated with the party tax profile. |
| BPartyTypeCode | String | The business party type code associated with the party tax profile. |
| Finder | String | Search term or keyword used for finding the party tax profile. |
Centralizes configuration for Payables, such as defaulting rules and processing parameters, shaping invoice and payment workflows.
| Name | Type | Description |
| SettlementDays | Int | The number of days allowed for settling payments in the payables system. |
| BusinessUnitId [KEY] | Long | The unique identifier for the business unit associated with the payables options. |
| AllowFinalMatchingFlag | Bool | Indicates whether final matching of invoices to purchase orders is allowed. |
| AllowMatchingDistributionOverrideFlag | Bool | Indicates whether the distribution of matched invoices can be overridden. |
| AllowForceApprovalFlag | Bool | Indicates whether invoices can be forcefully approved, bypassing approval workflows. |
| AllowAdjustmentsToPaidInvoicesFlag | Bool | Indicates whether adjustments to already paid invoices are allowed. |
| AllowRemitToSupplierOverrideForThirdPartyPaymentsFlag | Bool | Indicates whether the 'Remit to Supplier' option can be overridden for third-party payments. |
| AllowPayeeOverrideForThirdPartyPaymentsFlag | Bool | Indicates whether the 'Payee' field can be overridden for third-party payments. |
| AllowOverrideOfSupplierSiteBankAccountFlag | Bool | Indicates whether the bank account information associated with the supplier site can be overridden. |
| AlwaysTakeDiscFlag | Bool | Indicates whether discounts should always be taken, even if not specified. |
| RequireAccountingBeforeApproval | String | Indicates whether accounting entries must be created before invoice approval. |
| EnableInvoiceApprovalFlag | Bool | Indicates whether invoice approval workflows are enabled. |
| CreateInterestInvoicesFlag | Bool | Indicates whether interest invoices should be automatically created. |
| BankChargeDeductionType | String | Specifies the method for deducting bank charges from payments. |
| BudgetDateBasis | String | Defines the basis for budget date determination for payables transactions. |
| UseDistributionFromPurchaseOrderFlag | Bool | Indicates whether distribution information should be pulled from the purchase order. |
| DiscountAllocationMethod | String | Specifies how discounts should be allocated to invoice lines. |
| ExcludeTaxFromDiscountCalculationFlag | Bool | Indicates whether tax should be excluded from discount calculations. |
| PaymentRequestPaymentPriority | Int | Defines the priority for processing payment requests. |
| PaymentRequestPayGroup | String | Specifies the pay group associated with the payment request. |
| ExcludeFreightFromDiscountCalculationFlag | Bool | Indicates whether freight costs should be excluded from discount calculations. |
| GlDateFromReceiptFlag | Bool | Indicates whether the GL date should be derived from the receipt date. |
| MinimumInterestAmount | Decimal | Specifies the minimum amount for which interest is calculated. |
| InvoiceCurrency | String | The currency used for the invoice, which may be different from the payment currency. |
| AllowInvoiceDocumentCategoryOverrideFlag | Bool | Indicates whether the document category for an invoice can be overridden. |
| LastUpdateDate | Datetime | The date when the payables options were last updated. |
| RequireConversionRateEntryForPaymentsFlag | Bool | Indicates whether a conversion rate is required for payments in foreign currencies. |
| PaymentCurrency | String | The currency in which payments is made. |
| PayDateBasis | String | Defines the basis for determining the payment date for payables transactions. |
| AllowPaymentDocumentCategoryOverrideFlag | Bool | Indicates whether the document category for a payment can be overridden. |
| PaymentPriority | Int | The priority level for payments, determining their order of processing. |
| AllowPaymentDateBeforeTheSystemDateFlag | Bool | Indicates whether payments can be scheduled before the system's current date. |
| ShowAvailablePrepaymentsDuringInvoiceEntryFlag | Bool | Indicates whether available prepayments should be shown during invoice entry. |
| InterestAllocationMethodFlag | Bool | Indicates whether the interest allocation method is enabled. |
| RecalculateInvoiceInstallmentsFlag | Bool | Indicates whether the system should recalculate invoice installments after changes. |
| ReceiptAcceptanceDays | Long | The number of days allowed for receipt acceptance after an invoice is issued. |
| EnableInvoiceAccountCodingWorkflowFlag | Bool | Indicates whether the workflow for coding invoices to accounts is enabled. |
| AllowInvoiceBackdatingForSelfServiceInvoicesFlag | Bool | Indicates whether backdating of invoices is allowed for self-service invoices. |
| LimitInvoiceToSinglePurchaseOrderForSelfServiceInvoicesFlag | Bool | Indicates whether invoices should be limited to a single purchase order for self-service invoices. |
| AllowUnitPriceChangeForQuantityBasedMatchesForSelfServiceInvoices | String | Specifies whether unit prices can be changed for quantity-based matches for self-service invoices. |
| TermsDateBasis | String | Defines the basis for calculating terms dates on invoices. |
| TransferPOdistributionAdditionalInformationFlag | Bool | Indicates whether additional distribution information from the purchase order should be transferred. |
| RequireValidationBeforeApprovalFlag | Bool | Indicates whether invoices must be validated before approval. |
| PayGroup | String | Specifies the pay group associated with the payables transactions. |
| AccountForPayment | String | The account from which payments should be made in the payables system. |
| LastUpdateLogin | String | The login of the user who last updated the payables options. |
| LastUpdatedBy | String | The name of the user who last updated the payables options. |
| CreatedBy | String | The name of the user who created the payables options. |
| CreationDate | Datetime | The date and time when the payables options were created. |
| BusinessUnitName | String | The name of the business unit associated with the payables options. |
| PaymentRequestPaymentTerms | String | Defines the payment terms for payment requests in the payables system. |
| InterestExpenseDistribution | String | Defines how interest expenses should be distributed in payables. |
| PrepaymentPaymentTerms | String | Defines the payment terms applicable to prepayment invoices. |
| AmountTolerances | String | Defines the tolerances allowed for amounts in the payables system. |
| PaymentTerms | String | Specifies the payment terms for invoices. |
| QuantityTolerances | String | Defines the tolerances allowed for quantities in the payables system. |
| LedgerId | Long | The unique identifier for the ledger associated with the payables options. |
| LedgerCurrency | String | The currency associated with the ledger in the payables options. |
| FederalIdentificationNumber | String | The federal identification number associated with the payables options. |
| LocationId | Long | The location ID associated with the payables options. |
| AllowAddressChange | String | Indicates whether address changes are allowed in the payables system. |
| IncomeTaxCombinedFilingProgram | String | Specifies the income tax combined filing program in the payables options. |
| IncomeTaxRegion | String | The region for income tax purposes in the payables options. |
| SupplierTaxRegion | String | The tax region for the supplier in the payables options. |
| USSGLTransactionCode | String | The USSGL transaction code for payables transactions. |
| USSGLTrxDescriptiveFlexfieldContext | String | The context for USSGL transaction descriptive flexfields in payables. |
| IncludeWitholdingDistInIncometaxreports | String | Indicates whether withholding distribution should be included in income tax reports. |
| RequireInvoiceGroup | String | Indicates whether invoices should be grouped for payment processing. |
| AttachmentMandatoryForSelfServiceInvoicesFlag | Bool | Indicates whether attachments are mandatory for self-service invoices. |
| DisallowAttachmentDeleteFlag | Bool | Indicates whether the deletion of attachments is disallowed in the payables system. |
| AccountingDateBasis | String | Defines the basis for accounting dates in the payables system. |
| Finder | String | Search term or keyword used for finding the payables options. |
Defines the rules (for example, net 30, net 60) for paying a supplier, setting installment schedules and discount opportunities.
| Name | Type | Description |
| TermsId [KEY] | Long | The unique identifier of the payment terms in the payables system. |
| Name | String | The name of the payment terms for the supplier or customer in the payables system. |
| EnabledFlag | Bool | Indicates whether the payment terms are enabled or active in the system. |
| FromDate | Date | The start date from which the payment terms are effective. |
| ToDate | Date | The end date until which the payment terms are valid. |
| CutoffDay | Int | The day of the month when the cutoff for the payment terms occurs. Typically, this defines the day when payments are due. |
| Rank | Long | The rank or priority of the payment terms, typically used to determine precedence when multiple terms are applicable. |
| CreatedBy | String | The name of the user who created the payment terms. |
| CreationDate | Datetime | The date and time when the payment terms were created in the system. |
| LastUpdateDate | Datetime | The date and time when the payment terms were last updated. |
| LastUpdateLogin | String | The login session of the user who last updated the payment terms. |
| LastUpdatedBy | String | The name of the user who last updated the payment terms. |
| Description | String | A brief description of the payment terms, outlining the payment conditions. |
| SetId | Long | The identifier of the set of payment terms, which may group related payment terms together. |
| Finder | String | Search term or keyword used for finding the payment terms in the system. |
Specifies the line-level breakdown of each payment term, detailing how installments or discounts are structured across due dates.
| Name | Type | Description |
| PayablesPaymentTermstermsId [KEY] | Long | The unique identifier for the payment terms associated with the payment terms line. |
| DuePercent | Decimal | The percentage of the total due amount for the payment terms line. |
| AmountDue | Decimal | The total amount due for the payment terms line. |
| Days | Int | The number of days until payment is due for the payment terms line. |
| DayOfMonth | Int | The specific day of the month on which the payment is due. |
| MonthsAhead | Int | The number of months ahead from the invoice date when the payment terms line applies. |
| FirstDiscountPercent | Decimal | The discount percentage applied to the payment if paid by the first discount date. |
| FirstDiscountDays | Int | The number of days after the invoice date by which the first discount must be paid. |
| FirstDiscountDayOfMonth | Int | The specific day of the month when the first discount can be applied. |
| FirstDiscountMonthsForward | Int | The number of months ahead from the invoice date when the first discount is available. |
| SecondDiscountPercent | Decimal | The discount percentage applied to the payment if paid by the second discount date. |
| SecondDiscountDays | Int | The number of days after the invoice date by which the second discount must be paid. |
| SecondDiscountDayOfMonth | Int | The specific day of the month when the second discount can be applied. |
| SecondDiscountMonthsForward | Int | The number of months ahead from the invoice date when the second discount is available. |
| ThirdDiscountPercent | Decimal | The discount percentage applied to the payment if paid by the third discount date. |
| ThirdDiscountDays | Int | The number of days after the invoice date by which the third discount must be paid. |
| ThirdDiscountDayOfMonth | Int | The specific day of the month when the third discount can be applied. |
| ThirdDiscountMonthsForward | Int | The number of months ahead from the invoice date when the third discount is available. |
| FixedDate | Date | The fixed date used for calculating the payment terms, if applicable. |
| Calendar | String | The calendar associated with the payment terms line, used to define payment due dates. |
| SequenceNumber [KEY] | Int | The sequence number indicating the order of the payment terms line within the set of terms. |
| TermsId [KEY] | Long | The identifier of the payment terms set to which the line belongs. |
| Finder | String | A search term or keyword used for identifying the payment terms line. |
| FromDate | Date | The start date when the payment terms line becomes effective. |
| ToDate | Date | The end date when the payment terms line is no longer effective. |
Maps payment terms to reference data sets, allowing different business units or legal entities to share or customize terms.
| Name | Type | Description |
| PayablesPaymentTermstermsId [KEY] | Long | The unique identifier for the payment terms associated with the payment terms set. |
| SetName | String | The name of the payment terms set, which is used to group and identify different payment terms. |
| Finder | String | A search term or keyword used for identifying the payment terms set. |
| FromDate | Date | The start date when the payment terms set becomes effective. |
| TermsId | Long | The identifier of the specific payment terms within the set. |
| ToDate | Date | The end date when the payment terms set is no longer effective. |
Stores multilingual translations of payment terms, facilitating global operations with localized term descriptions.
| Name | Type | Description |
| PayablesPaymentTermstermsId [KEY] | Long | The unique identifier for the payment terms associated with the translation. |
| Name | String | The name of the translated payment terms. |
| Description | String | The description of the payment terms translation. |
| TermsId [KEY] | Long | The identifier of the specific payment terms related to the translation. |
| Language [KEY] | String | The language in which the payment terms are translated. |
| Finder | String | A search term or keyword used to identify the translated payment terms. |
| FromDate | Date | The start date when the translated payment terms become effective. |
| ToDate | Date | The end date when the translated payment terms are no longer effective. |
Maintains entities required for tax reporting (for example, 1099 in the U.S.), linking tax obligations to specific organizational segments.
| Name | Type | Description |
| ReportingEntityName | String | The name of the reporting entity for tax reporting purposes. |
| TaxEntityId [KEY] | Long | Unique identifier for the tax entity associated with the reporting entity. |
| LocationId | Long | Identifier of the location associated with the tax reporting entity. |
| TaxpayerIdentification | String | Tax Indentification Number (TIN) associated with the tax entity. |
| CreatedBy | String | User who created the tax reporting entity record. |
| CreationDate | Datetime | The date and time when the tax reporting entity record was created. |
| LastUpdateDate | Datetime | The date and time when the tax reporting entity record was last updated. |
| LastUpdateLogin | String | Login session associated with the last update of the tax reporting entity record. |
| LastUpdatedBy | String | User who last updated the tax reporting entity record. |
| LocationDescription | String | Description of the location associated with the tax reporting entity. |
| BusinessUnit | String | Business unit associated with the tax reporting entity. |
| Location | String | The location name or address associated with the tax reporting entity. |
| Finder | String | A search term or keyword used to find tax reporting entities. |
| EffectiveDate | Date | The date when the tax reporting entity becomes effective. |
Captures multiple tax reporting lines under a single entity, supporting consolidated or segmented 1099 reporting configurations.
| Name | Type | Description |
| PayablesTaxReportingEntitiestaxEntityId [KEY] | Long | Unique identifier for the tax entity associated with the tax reporting entity line. |
| BalancingSegmentValue [KEY] | String | The value of the balancing segment associated with the tax reporting entity line. |
| TaxEntityId [KEY] | Long | Unique identifier for the tax entity associated with the tax reporting entity line. |
| CreatedBy | String | User who created the tax reporting entity line record. |
| CreationDate | Datetime | The date and time when the tax reporting entity line record was created. |
| LastUpdateDate | Datetime | The date and time when the tax reporting entity line record was last updated. |
| LastUpdateLogin | String | Login session associated with the last update of the tax reporting entity line record. |
| LastUpdatedBy | String | User who last updated the tax reporting entity line record. |
| Description | String | Description of the tax reporting entity line. |
| Finder | String | A search term or keyword used to find tax reporting entity lines. |
| EffectiveDate | Date | The date when the tax reporting entity line becomes effective. |
Displays valid bank accounts for payees, helping confirm account details during disbursements or refunds.
| Name | Type | Description |
| BankAccountId | Long | Unique identifier for the payee bank account. |
| AccountNumber [KEY] | String | Account number associated with the payee's bank account. |
| IBAN | String | International Bank Account Number (IBAN) associated with the payee's bank account. |
| AccountName | String | The name of the account holder for the payee's bank account. |
| AlternateAccountName | String | Alternate name for the payee's bank account holder. |
| AccountCountry | String | Country of the bank account associated with the payee. |
| CurrencyCode | String | Currency code for the payee's bank account. |
| AllowInternationalPaymentsIndicator | String | Indicates whether international payments are allowed for the payee's bank account. |
| BankName | String | Name of the bank where the payee holds the account. |
| BankCode | String | Code identifying the payee's bank. |
| BranchName | String | Name of the branch of the payee's bank. |
| BranchNumber | String | Number of the branch of the payee's bank. |
| SWIFTCode | String | SWIFT code used for international payments associated with the payee's bank. |
| CheckDigits | String | Check digits used to validate the payee's bank account number. |
| AccountSuffix | String | Suffix added to the account number for the payee's bank account. |
| SecondaryAccountReference | String | Reference number for a secondary account of the payee. |
| AgencyLocationCode | String | Code identifying the location of the bank agency for the payee. |
| AccountType | String | Type of the payee's bank account (for example, Checking, Savings). |
| FactorAccountIndicator | String | Indicates whether the payee's bank account is a factoring account. |
| Description | String | Description associated with the payee's bank account. |
| StartDate | Date | Date when the payee's bank account became effective. |
| EndDate | Date | Date when the payee's bank account became inactive. |
| Finder | String | A keyword or search term for locating the payee's bank account. |
| PayeePartyId | Long | Unique identifier for the payee party associated with the bank account. |
| PayeePartySiteId | Long | Unique identifier for the payee party site associated with the bank account. |
| PaymentFunction | String | Function associated with the payment for the payee's bank account. |
| SupplierSiteId | Long | Unique identifier for the supplier site associated with the payee's bank account. |
Defines external payees (for example, suppliers, vendors) for payments, enabling creation and modification of payee records.
| Name | Type | Description |
| PayeeId [KEY] | Long | This column holds the unique identifier of the external payee in the financial system, which is automatically generated by the application. |
| PaymentFunctionCode | String | This code identifies the function or purpose of the payment. It maps to predefined values in the IBY_PAYMENT_FUNCTIONS lookup, including categories such as SUPPLIER_PAYMENT, CUSTOMER_REFUNDS, and others. |
| OrganizationIdentifier | String | This column contains the unique identifier associated with the business unit that is linked to an external payee, used for organizational classification. |
| OrganizationName | String | This column stores the name of the business unit tied to an external payee, helping distinguish between different payee relationships in financial transactions. |
| OrganizationType | String | Defines the type of organization for the external payee, classifying the payee within organizational structures such as company, department, or external vendor. |
| PayEachDocumentAloneOption | String | Indicates whether the external payee's documents are required to be processed separately from other documents, ensuring they are not grouped with other payees for payment. |
| DefaultPaymentMethodCode | String | This column stores the default payment method code, indicating how payments to the external payee are typically processed, such as bank transfer, check, etc. |
| DefaultPaymentMethodName | String | The name corresponding to the default payment method of the external payee, used to simplify transaction processing by assigning a standard method. |
| BankChargeBearerCode | String | Specifies who is responsible for paying the bank charges in a payment transaction. The values for this field are defined in the IBY_BANK_CHARGE_BEARER lookup, with options like Payee or Payer. |
| BankChargeBearerName | String | This column stores the name of the external payee responsible for paying the bank charges, as defined by the IBY_BANK_CHARGE_BEARER lookup. |
| BankInstructionCodeOne | String | This is the code used for the first bank instruction, specifying the exact action the payee’s bank should perform for the transaction. |
| BankInstructionNameOne | String | Contains the name or description of the first bank instruction, providing clarity on the specific action required from the payee's bank. |
| BankInstructionCodeTwo | String | The code of the second bank instruction for an external payee, used to indicate additional steps or actions to be taken by the bank during the transaction. |
| BankInstructionNameTwo | String | The name associated with the second bank instruction, describing the action the bank is required to take as per the second set of instructions. |
| BankInstructionDetails | String | Stores any additional information regarding further bank instructions, providing more context on the required actions from the bank in the transaction. |
| PaymentReasonCode | String | The code representing the reason for making a payment to the external payee, such as for services rendered or refund processing. |
| PaymentReasonName | String | The name of the reason for the payment to the external payee, providing more context about the nature of the transaction. |
| PaymentReasonComments | String | Allows for the inclusion of additional text to explain or provide further details on the reason for making the payment to the external payee. |
| PaymentTextMessageOne | String | The first message that is sent to the external payee as part of the payment notification or remittance advice. |
| PaymentTextMessageTwo | String | The second message included with the payment notification, which can provide further details to the payee. |
| PaymentTextMessageThree | String | The third message in the set of payment notifications, allowing more specific information to be shared with the external payee. |
| DeliveryChannelCode | String | The code of the delivery channel used for communicating with the external payee. This could include methods such as EMAIL, FAX, or PRINTED. |
| DeliveryChannelName | String | This column stores the name of the delivery channel used for communication with the external payee, helping categorize the communication method. |
| ServiceLevelCode | String | Represents the code that defines the service level for the external payee, which impacts how promptly or securely payments are processed. |
| ServiceLevelName | String | This column holds the name associated with the service level, which provides a descriptive label for the type of service provided to the external payee. |
| SettlementPriority | String | Defines the priority with which payments to the external payee are processed, affecting the speed of settlement by the financial institution or payment system. |
| DeliveryMethod | String | Specifies how the payment information or remittance advice is delivered to the external payee, based on the defined preferences for delivery such as EMAIL, FAX, or PRINTED. |
| String | The email address where remittance advice is sent to the external payee, enabling electronic communication of payment details. | |
| Fax | String | The fax number at which the external payee receives remittance advice, used for traditional methods of communicating payment information. |
| PayeePartyIdentifier | Long | A unique identifier for an external payee party, used to link the payee with payment records and manage their information. |
| PartyName | String | The name of the external payee party, used for identifying and distinguishing payees in the payment system. |
| PayeePartyNumber | String | An application-generated number for the external payee in the Trading Community Architecture, used for tracking and referencing within the system. |
| PayeePartySiteIdentifier | Long | The identifier associated with the specific site or location of the external payee, useful for managing payee records in multiple locations. |
| SupplierNumber | String | An application-generated identifier for a supplier within the procurement system, used to track suppliers for payment purposes. |
| SupplierSiteCode | String | The code used to identify the supplier site, important for distinguishing between different locations of the same supplier. |
| SupplierSiteIdentifier | Long | The unique identifier for a supplier site, helping the system differentiate between multiple supplier locations for payment or ordering. |
| PayeePartySiteNumber | String | The number assigned to an external payee site, which helps in organizing and categorizing multiple payee sites. |
| PaymentFormatCode | String | The code associated with the payment format used for processing payments to an external payee, like ACH or wire transfer. |
| PaymentFormatName | String | The name of the payment format, providing an easily recognizable label for the type of payment method associated with the external payee. |
| PersonId | Long | The identifier used when the external payee is an employee, tying the payment to the individual within the organization. |
| Intent | String | Describes the purpose of the external payee in the context of the payment. Common values include PAYABLES_DISB (supplier), EMPLOYEE_EXP (person), AR_CUSTOMER_REFUNDS (refund), and others. |
| Finder | String | A search term or query used to filter or identify external payees in the system, assisting in quick access and management of payee records. |
Lists payment methods (check, EFT, ACH, etc.) available to a specific external payee, ensuring valid disbursement choices.
| Name | Type | Description |
| PaymentsExternalPayeesPayeeId [KEY] | Long | Unique identifier for the payee in the PaymentsExternalPayees table, which is used to track external payees in the payment system. |
| ExternalPartyPaymentMethodsId [KEY] | Long | Unique identifier for the external party payment method assignment. This associates a payment method with a specific payee. |
| PayeeId | Long | Unique identifier of the external payee associated with the payment method. This is used to link the payment method to the payee in the system. |
| PayeeName | String | The name of the payee associated with the payment method. This identifies the recipient of payments. |
| PaymentMethodCode | String | Code assigned to the payment method, which defines how the payment is processed (for example, bank transfer, check, etc.). |
| PaymentMethodName | String | The name of the payment method, corresponding to the PaymentMethodCode. This provides a human-readable description of the payment method. |
| PrimaryIndicator | String | Indicates whether this payment method is the primary one used for making payments to the payee. It helps identify the default payment method. |
| FromDate | Date | The date when the assignment of the payment method to the payee becomes effective. |
| ToDate | Date | The date when the assignment of the payment method to the payee ends or becomes inactive. |
| SiteName | String | The name of the site associated with the external payee. This identifies the location related to the payee’s account. |
| AddressName | String | The name of the address associated with the external payee’s site. This is typically used for billing or payment purposes. |
| Finder | String | A reference identifier used to locate or search for a particular external party payment method within the system. |
| Intent | String | The intended purpose of the payment method, defining whether the payment is for supplier disbursement, employee expenses, or another payment function. |
| OrganizationName | String | The name of the organization associated with the external payee, such as the company or business unit responsible for the payee. |
| PartyName | String | The name of the party associated with the external payee, which is typically the entity representing the payee in the system. |
| PayeePartyIdentifier | Long | Unique identifier of the party (business or individual) that represents the external payee in the system. |
| PayeePartyNumber | String | A unique number assigned to the payee party, typically used to reference the payee in related documents and transactions. |
| PayeePartySiteIdentifier | Long | Unique identifier for the specific site of the external payee. This helps distinguish between multiple sites for the same payee. |
| PayeePartySiteNumber | String | Number assigned to the specific site of the external payee. This is useful when multiple sites exist for the same payee. |
| PaymentFunctionCode | String | Code representing the function or purpose of the payment to the external payee, such as supplier payment, employee expense reimbursement, etc. |
| SupplierNumber | String | Unique number assigned to the supplier, which identifies them in procurement or supply chain management systems. |
| SupplierSiteCode | String | Code assigned to the supplier’s site, used to track transactions and payments associated with a specific location of the supplier. |
| SupplierSiteIdentifier | Long | Unique identifier for the supplier site, used to associate payment methods and other details with specific supplier locations. |
Provides a quick lookup of defined Receivables payment terms, such as net due days or early payment discount schedules.
| Name | Type | Description |
| PaymentTermsId [KEY] | Long | Unique identifier for the payment terms in the PaymentTermsLOV table, which helps in linking payment terms to invoices or payment transactions. |
| Name | String | The name of the payment terms, which provides a human-readable label for the specific set of payment conditions, such as 'Net 30' or 'Due on Receipt'. |
| Description | String | A detailed description of the payment terms, outlining the conditions of the payment agreement such as due dates, discounts, or other payment schedules. |
| SetName | String | The name of the set that the payment terms belong to. This could represent a grouping or classification of payment terms for organizational purposes. |
| Finder | String | A reference identifier or search term used to locate specific payment terms in the system. It helps in searching and filtering payment terms for specific use cases. |
Enumerates currency preferences used by users or business units, enabling automated conversions and standardized reporting.
| Name | Type | Description |
| CurrencyCode [KEY] | String | The unique identifier for the currency in the PreferredCurrenciesLOV table. This is typically a 3-character currency code such as USD or EUR. |
| CurrencyName | String | The full name of the currency, such as USD or EUR, providing more clarity than just the currency code. |
| CurrencyFlag | Bool | Indicates whether the currency is currently flagged for use in transactions or reporting within the system. True signifies that the currency is active and usable. |
| EnabledFlag | Bool | Indicates whether the currency is enabled for use in the system. A value of True means the currency can be used in financial transactions, while False means it is disabled. |
| DisplaySequence | Long | The sequence number that determines the order in which currencies are displayed in user interfaces or reports, allowing for a customized presentation of currency options. |
| StartDateActive | Date | The date when the currency became active and available for use within the system. This is the date from which the currency can be selected for financial transactions. |
| EndDateActive | Date | The date when the currency was deactivated or is no longer available for use. After this date, the currency cannot be selected for transactions. |
| Precision | Int | The number of decimal places to which the currency values can be rounded. For example, USD might have a precision of 2 (representing two decimal places). |
| MinimumAccountableUnit | Decimal | The smallest possible unit of the currency that can be accounted for in transactions. For example, in some currencies, this could represent the smallest coin unit like 'cent' in USD. |
| Symbol | String | The symbol associated with the currency, such as '$' for USD or '€' for EUR. This is used in financial reports or interfaces to denote the currency. |
| LedgerSetId | Long | The unique identifier linking the currency to a specific ledger set. This is used to group different currencies for specific ledgers within the financial system. |
| ExtendedPrecision | Int | The number of additional decimal places (beyond the typical precision) used for certain currencies when higher precision is needed for specific calculations. |
| IssuingTerritoryCode | String | The code of the geographical territory or country that issues the currency. For example, US. |
| Name | String | A descriptive name for the currency record in the system, which can be used for easy reference within reports or financial records. |
| CurrencyFormat | String | The format in which the currency is displayed in reports or transactions, typically specifying the placement of the symbol, such as 'USD 100.00'. |
| CurrencyFormatWithSymbol | String | The format for displaying the currency along with its symbol, for example, '$100.00' or '€100.00', ensuring the correct visual representation of the currency. |
| CurrencyFormatWithCode | String | The format used to display the currency along with its code, such as 'USD 100.00', which includes both the currency symbol and the ISO code. |
| BindCurrencyEnabledFlag | String | Indicates whether the binding of the currency to a ledger or report is enabled. This flag helps manage the association between the currency and its usage. |
| BindEndDate | Date | The end date for the binding of the currency to a particular ledger set or financial report. After this date, the currency is no longer associated with the binding. |
| BindLedgerSetId | Long | The identifier for the ledger set with which the currency is bound. This links the currency to specific financial ledgers. |
| BindStartDate | Date | The start date for the binding of the currency to a specific ledger or financial report. This is the date when the currency begins being used in the designated context. |
| Finder | String | A unique identifier or search term used to find and reference this currency record within the system. Useful for locating specific currency data during searches. |
| SearchTerm | String | A text field that is used to search for specific currencies or records related to the currency in the system, improving the efficiency of searching for currency data. |
Manages the assignment of receipt methods (for example, cash, check, credit card) to customer accounts or sites, controlling how payments are received.
| Name | Type | Description |
| CustomerReceiptMethodId [KEY] | Long | A unique identifier assigned to each customer receipt method. This ID helps to distinguish different receipt methods for each customer. |
| CustomerAccountNumber | String | The account number associated with the customer, used to identify the customer within the system. |
| CustomerSiteNumber | String | The unique site number linked to the customer account, helping to identify specific locations or branches associated with the customer. |
| ReceiptMethodName | String | The name of the receipt method used by the customer, such as 'Bank Transfer', 'Credit Card', or 'Check'. This is used to specify how payments are made. |
| Primary | String | Indicates whether the receipt method is the primary method used for receiving payments from the customer. 'Y' represents primary, and 'N' indicates a secondary method. |
| StartDate | Date | The date when the receipt method becomes active and can be used for processing payments. |
| EndDate | Date | The date when the receipt method is no longer valid for use, after which it becomes inactive. |
| CreatedBy | String | The user or system that created the receipt method assignment entry. |
| CreationDate | Datetime | The date and time when the receipt method assignment entry was created. |
| LastUpdateDate | Datetime | The date and time when the receipt method assignment was last updated. |
| LastUpdatedBy | String | The user who last updated the receipt method assignment entry. |
| Finder | String | A reference value used to search and locate receipt method assignments within the system. |
Allows modification of existing invoices, credit memos, or other transactions, adjusting charges, freight, taxes, or lines.
| Name | Type | Description |
| AdjustmentId [KEY] | Long | The unique identifier assigned to each receivables adjustment, helping to distinguish one adjustment from another. |
| AdjustmentNumber | String | A unique number given to the adjustment transaction, which helps in tracking and referencing the specific adjustment. |
| AdjustmentType | String | The type of the adjustment (such as 'Write-off', 'Refund', or 'Correction') indicating the nature of the modification applied to the receivable. |
| AdjustmentAmount | Decimal | The total amount of the adjustment applied to the receivable, which could be an increase or decrease depending on the adjustment type. |
| AdjustmentDate | Date | The date on which the adjustment was processed, marking when the modification to the receivable occurred. |
| AccountingDate | Date | The accounting date assigned to the adjustment, used for accounting entries and reporting, which may differ from the transaction date. |
| Status | String | The current status of the adjustment, such as 'Pending', 'Approved', or 'Rejected', indicating the progress of the adjustment in the workflow. |
| ReceivablesActivity | String | A reference to the activity or process associated with the adjustment, such as 'Payment Application' or 'Charge-off'. |
| BusinessUnit | String | The business unit within the organization that is responsible for the receivables adjustment. It typically represents a division or a department. |
| CustomerTransactionId | Long | The unique identifier of the customer transaction that the adjustment is related to, linking the adjustment back to the original transaction. |
| TransactionNumber | String | The transaction number associated with the customer’s original transaction that is being adjusted. |
| TransactionClass | String | The class of the transaction (for example, 'Invoice', 'Credit Memo'), which categorizes the type of transaction that is being adjusted. |
| AccountedAmount | Decimal | The amount of the adjustment that has been accounted for in the general ledger, ensuring that the financial records reflect the change. |
| Currency | String | The currency in which the adjustment is made, ensuring that amounts are appropriately calculated and reported in the correct currency. |
| InstallmentNumber | Long | The specific installment of the receivable that the adjustment applies to, helping to track adjustments made to particular payment plans or installments. |
| InstallmentBalance | Decimal | The balance remaining for the specific installment after the adjustment is applied, helping to track how much is still due for that installment. |
| AdjustmentReason | String | The reason for making the adjustment, such as 'Discount Applied', 'Overpayment', or 'Write-off', which provides context for the adjustment. |
| ApprovedBy | String | The individual or system that authorized or approved the adjustment, ensuring proper governance and oversight of receivables changes. |
| BillToSiteUseId | Long | The unique identifier for the billing site associated with the adjustment, which helps to link the adjustment to a specific customer or location. |
| Comments | String | Additional comments or notes related to the adjustment, often used to provide context or explanations for the adjustment made. |
| AccountCombination | String | The account combination used for posting the adjustment in the general ledger, linking it to the appropriate accounts and ensuring proper accounting. |
| CreationDate | Datetime | The date and time when the adjustment record was initially created, used for tracking and auditing purposes. |
| CreatedBy | String | The user or system that created the adjustment entry, providing accountability for the creation of the adjustment. |
| LastUpdateDate | Datetime | The date and time when the adjustment was last modified, ensuring that the most up-to-date information is available. |
| LastUpdatedBy | String | The individual who last updated the adjustment, allowing for traceability and accountability in the adjustment’s lifecycle. |
| Finder | String | A reference field used to search for and locate receivables adjustments within the system. |
Enables custom fields for receivables adjustments, capturing additional business details or classification codes.
| Name | Type | Description |
| ReceivablesAdjustmentsAdjustmentId [KEY] | Long | The unique identifier for the receivables adjustment, used to reference a specific adjustment record within the receivables system. |
| AdjustmentId [KEY] | Long | The identifier of the adjustment, which links the descriptive flexfield (DFF) to the specific adjustment entry being described. |
| _FLEX_Context | String | The context name for the descriptive flexfield, which helps identify the category or classification of the adjustment and ensures proper data storage. |
| _FLEX_Context_DisplayValue | String | The display value of the descriptive flexfield context, providing a human-readable label for the context in which the adjustment is categorized. |
| Finder | String | A search key or reference used to locate and retrieve the specific receivables adjustment descriptive flexfield records within the system. |
Lists valid business units for the Receivables module, identifying each organization’s operational scope and ledger association.
| Name | Type | Description |
| BusinessUnitId [KEY] | Long | The unique identifier for the business unit, used to differentiate between different organizational units within the receivables module. |
| BusinessUnitName | String | The name of the business unit, representing the organizational division or functional unit responsible for managing receivables. |
| PrimaryLedgerId | String | The identifier of the primary ledger associated with the business unit, used for financial reporting and transaction tracking. |
| BindBillsReceivableFlag | String | A flag indicating whether bills receivable are bound to this business unit, allowing the unit to track outstanding customer invoices. |
| BindBusinessFunction | String | The business function tied to the business unit, defining the specific role or service the unit provides within the receivables structure. |
| Finder | String | A reference key or search term used to locate and retrieve specific business unit records within the receivables system. |
| Intent | String | Describes the intended purpose of the business unit, such as managing customer accounts, billing, or financial reporting in the receivables process. |
| SearchTerm | String | A search term used to filter or locate relevant business units based on key characteristics or identifiers. |
Enables adding or reviewing attachments linked to credit memos, ensuring supporting documentation for transactions.
| Name | Type | Description |
| ReceivablesCreditMemosCustomerTransactionId [KEY] | Long | The unique identifier for the credit memo associated with the attachment in the ReceivablesCreditMemos table. |
| AttachedDocumentId [KEY] | Long | A unique identifier assigned to each attached document, enabling tracking and retrieval. |
| LastUpdateDate | Datetime | The date and time when the attached document record was last updated, useful for auditing and tracking changes. |
| LastUpdatedBy | String | The user who last updated the document attachment record, ensuring traceability of changes. |
| DatatypeCode | String | The value indicating the type of data contained in the attachment (for example, PDF, image, etc.). |
| FileName | String | The name of the file attached to the record, used for file identification and reference. |
| DmFolderPath | String | The path to the folder where the document is stored, indicating its physical or logical location. |
| DmDocumentId | String | A unique identifier for the document from which the attachment was created, used to link related documents. |
| DmVersionNumber | String | The version number of the document from which the attachment was created, allowing version control. |
| Url | String | The URL of a web page attachment, enabling access to the document via a web interface. |
| CategoryName | String | The category or classification of the attachment, used to group similar documents together. |
| UserName | String | The user who is responsible for uploading the document attachment, providing context for the upload process. |
| Uri | String | The URI (Uniform Resource Identifier) pointing to the attachment, used for programmatic access. |
| FileUrl | String | The direct URI path to the file, used to locate the attachment for download or viewing. |
| UploadedText | String | The text content of an attachment if it is a text-based file or document. |
| UploadedFileContentType | String | The content type of the file being uploaded, specifying the file's data format. |
| UploadedFileLength | Long | The size of the attachment file in bytes, helping to assess the file's content volume. |
| UploadedFileName | String | The name of the file when it is uploaded, used for storage and identification. |
| ContentRepositoryFileShared | Bool | Indicates whether the file is shared with other users or systems, useful for access control. |
| Title | String | The title of the attachment, providing a brief description or label for the document. |
| Description | String | A detailed description of the attachment, offering context about its contents or purpose. |
| ErrorStatusCode | String | The error code generated during the attachment process, if any, useful for troubleshooting and resolution. |
| ErrorStatusMessage | String | The error message describing the issue that occurred during the attachment process, for diagnostic purposes. |
| CreatedBy | String | The user who initially created the attachment record, ensuring auditability of document creation. |
| CreationDate | Datetime | The date and time when the attachment record was created, useful for tracking document lifecycle. |
| FileContents | String | The actual content of the attachment in text format, for text-based attachments. |
| ExpirationDate | Datetime | The expiration date of the attachment, used to determine when the document is no longer valid or accessible. |
| LastUpdatedByUserName | String | The username of the person who last updated the attachment record, ensuring accountability. |
| CreatedByUserName | String | The username of the person who initially created the attachment record. |
| AsyncTrackerId | String | A unique identifier used by the Attachment UI components to track and manage file uploads asynchronously. |
| FileWebImage | String | The image representation of the file used in web interfaces, such as thumbnail previews. |
| DownloadInfo | String | A JSON object containing the necessary information to programmatically retrieve the file attachment. |
| PostProcessingAction | String | The action that can be performed after an attachment has been uploaded, such as processing or validation. |
| BindAccountingDate | Date | The date used for accounting purposes in relation to the attached document, ensuring accurate financial recording. |
| BindAllowCompletion | String | Indicates whether the transaction associated with the attachment can be completed, often marked as 'Y' for yes. |
| BindBillToCustomer | String | The bill-to customer associated with the attachment, linking the document to the customer account. |
| BindBillToCustomerNumber | String | The account number of the bill-to customer, ensuring that the document is associated with the correct customer. |
| BindBillToSite | String | The customer site number associated with the attachment, used for physical or service site identification. |
| BindBusinessUnit | String | The business unit linked to the attachment, identifying the specific division or department handling the transaction. |
| BindCreditMemoCurrency | String | The currency used for the credit memo associated with the attachment, ensuring currency consistency. |
| BindCreditMemoStatus | String | The status of the credit memo, indicating whether it is complete, incomplete, or in another processing state. |
| BindCrossReference | String | A reference used to link the attachment to related transactions or documents for easier reconciliation. |
| BindDeliveryMethod | String | The method of delivery for the attachment, such as email, fax, or printed document. |
| BindDocumentNumber | Long | The document number associated with the attachment, helping to track the specific document in the system. |
| BindIntercompany | String | Indicates whether the attachment relates to an intercompany transaction, marked as 'Y' if applicable. |
| BindPrimarySalesperson | String | The primary salesperson associated with the transaction linked to the attachment. |
| BindPrintStatus | String | The print status of the document, indicating whether the document has been printed or not. |
| BindPurchaseOrder | String | The purchase order linked to the attachment, ensuring that the document is associated with the correct order. |
| BindShipToCustomerName | String | The name of the customer receiving the shipment linked to the attachment. |
| BindShipToSite | String | The site number of the customer receiving the shipment associated with the attachment. |
| BindTransactionDate | Date | The date the transaction related to the attachment occurred, used for accurate record-keeping. |
| BindTransactionNumber | String | The transaction number associated with the attachment, helping to identify the related transaction. |
| BindTransactionSource | String | The source system that generated the transaction related to the attachment. |
| BindTransactionType | String | The type of the transaction, such as purchase or return, linked to the attachment. |
| CustomerTransactionId | Long | The transaction ID of the customer associated with the attachment, ensuring correct document referencing. |
| Finder | String | A search term or reference used to find the attachment record in the system, simplifying query operations. |
Holds note objects for credit memos, capturing additional instructions, clarifications, or comments.
| Name | Type | Description |
| ReceivablesCreditMemosCustomerTransactionId [KEY] | Long | The unique identifier of the customer transaction associated with the credit memo, linking the note to a specific transaction in Receivables Credit Memos. |
| NoteId [KEY] | Long | The unique identifier for the note within the ReceivablesCreditMemosnotes table, allowing individual tracking of each note. |
| SourceObjectCode | String | The source object code, used to identify the origin or category of the object associated with the note, based on the OBJECTS Metadata. |
| SourceObjectId | String | The unique identifier for the parent source object related to the note, providing a link to the associated parent entity in the database. |
| PartyName | String | The name of the party (for example, customer, supplier) associated with the note in the Receivables Credit Memos system. |
| NoteTxt | String | The actual content of the note, typically in text format, used to capture details or comments regarding the credit memo or associated transaction. |
| NoteTypeCode | String | A code used to categorize the note type, enabling classification of notes into various types such as internal or external notes. |
| VisibilityCode | String | Indicates the visibility level of the note. This code determines whether the note is visible internally, externally, or is restricted to specific users. |
| CreatorPartyId | Long | The unique identifier of the party responsible for creating the note, ensuring traceability of the note's origin. |
| CreatedBy | String | The username or ID of the person who created the note, ensuring accountability for the creation of each note. |
| CreationDate | Datetime | The date and time when the note was created, providing context for its relevance and timeliness. |
| LastUpdateDate | Datetime | The date and time when the note was last updated, helping to track the latest modifications. |
| PartyId | Long | The unique identifier of the party related to the note, typically linking it to the customer or supplier in the Receivables Credit Memos system. |
| CorpCurrencyCode | String | The corporate currency code used for extensibility, providing the currency in which the credit memo or transaction is handled. |
| CurcyConvRateType | String | The type of currency conversion rate applied to the credit memo or transaction, which influences how foreign currency amounts are converted. |
| CurrencyCode | String | The specific currency code used for the credit memo or transaction, facilitating currency handling and conversion in multi-currency environments. |
| ContactRelationshipId | Long | The ID of the relationship populated when the note is associated with a contact, enabling direct links to the related contact. |
| ParentNoteId | Long | The unique identifier of the parent note, used to create a hierarchical structure of notes, where one note can reference another. |
| LastUpdatedBy | String | The username or ID of the person who last updated the note, ensuring proper tracking of changes. |
| LastUpdateLogin | String | The login session or identifier that corresponds to the last update of the note, providing security context. |
| EmailAddress | String | The email address associated with the note, typically used for sending notifications or reminders related to the credit memo. |
| FormattedAddress | String | The address associated with the note, formatted for clarity and presentation, typically used for mailing or notification purposes. |
| FormattedPhoneNumber | String | The phone number related to the note, formatted for easy reading, often used for contact purposes. |
| UpdateFlag | Bool | Indicates whether the note is marked for update, helping identify if the note is in an editable state. |
| DeleteFlag | Bool | Indicates whether the note is flagged for deletion, typically used to mark notes for removal from the system. |
| NoteNumber | String | An alternate unique identifier for the note, which can be system-generated or come from an external system, providing another way to reference the note. |
| NoteTitle | String | The title of the note, entered by the user, used to provide a brief description or label for the note. |
| BindAccountingDate | Date | The accounting date associated with the note, used for financial reporting and reconciliation purposes. |
| BindAllowCompletion | String | Indicates whether the transaction associated with the note is allowed to complete. A 'Y' value typically indicates that the note-related transaction can be finished. |
| BindBillToCustomer | String | The bill-to customer associated with the note, ensuring the note is linked to the correct billing party. |
| BindBillToCustomerNumber | String | The bill-to customer number, providing a unique identifier for the customer in the billing system. |
| BindBillToSite | String | The site number of the bill-to customer, used to link the note to the specific site within the billing customer organization. |
| BindBusinessUnit | String | The business unit associated with the note, identifying the unit responsible for the credit memo or transaction. |
| BindCreditMemoCurrency | String | The currency used for the credit memo, ensuring the note is linked to the correct currency context. |
| BindCreditMemoStatus | String | The current status of the credit memo linked to the note, indicating whether it is complete, pending, or in any other state. |
| BindCrossReference | String | The cross-reference used to relate the note to other transactions or documents in the system, typically used for reconciliations. |
| BindDeliveryMethod | String | The method of delivery associated with the note, such as email, fax, or physical mail. |
| BindDocumentNumber | Long | The document number associated with the note, helping to link it to a specific document in the Receivables Credit Memos system. |
| BindIntercompany | String | Indicates whether the note is related to an intercompany transaction, marked as 'Y' if applicable. |
| BindPrimarySalesperson | String | The primary salesperson associated with the transaction or credit memo related to the note. |
| BindPrintStatus | String | The print status of the note, indicating whether the associated transaction has been printed. |
| BindPurchaseOrder | String | The purchase order linked to the note, ensuring it is connected to the correct order for reference. |
| BindShipToCustomerName | String | The name of the customer receiving the shipment, linked to the note. |
| BindShipToSite | String | The site number of the customer receiving the shipment, associated with the note. |
| BindTransactionDate | Date | The transaction date associated with the note, used for record-keeping and reporting. |
| BindTransactionNumber | String | The transaction number linked to the note, used for identifying the specific transaction. |
| BindTransactionSource | String | The source system of the transaction related to the note, helping to trace the origin of the transaction. |
| BindTransactionType | String | The type of the transaction, such as a sale, return, or other types of transactions, associated with the note. |
| CustomerTransactionId | Long | The customer transaction ID linked to the note, ensuring it references the correct customer transaction. |
| Finder | String | A search term or reference used to locate the note within the system. |
Enables descriptive flexfields on credit memos, capturing custom data points relevant to an organization’s needs.
| Name | Type | Description |
| ReceivablesCreditMemosCustomerTransactionId [KEY] | Long | The unique identifier for the customer transaction associated with the credit memo in Receivables Credit Memos, used for tracking and linking transactions. |
| CustomerTrxId [KEY] | Long | The unique identifier for the customer transaction, used for referencing and associating the credit memo with a specific transaction. |
| _FLEX_Context | String | The context of the descriptive flexfield for the Receivables Credit Memo, used to categorize the credit memo based on user-defined criteria. |
| _FLEX_Context_DisplayValue | String | The display value of the flexfield context, providing a user-readable representation of the flexfield's context. |
| BindAccountingDate | Date | The accounting date linked to the credit memo, used for financial reporting and accounting purposes to reflect when the transaction should be recorded. |
| BindAllowCompletion | String | Indicates whether the transaction linked to the credit memo is allowed to complete. Typically marked as 'Y' to allow completion. |
| BindBillToCustomer | String | The customer associated with the billing of the credit memo, ensuring that the correct bill-to customer is linked to the transaction. |
| BindBillToCustomerNumber | String | The unique account number assigned to the bill-to customer, providing a direct link to the customer in the billing system. |
| BindBillToSite | String | The site associated with the bill-to customer, used to identify the specific location within the customer’s organization to which the credit memo applies. |
| BindBusinessUnit | String | The business unit under which the credit memo is processed, used to categorize and manage financial transactions within the organization. |
| BindCreditMemoCurrency | String | The currency in which the credit memo is issued, allowing for accurate financial tracking and reporting in the correct currency. |
| BindCreditMemoStatus | String | The current status of the credit memo, such as 'Complete', 'Incomplete', or 'Frozen', indicating the state of the transaction. |
| BindCrossReference | String | A cross-reference code linking the credit memo to other related transactions or documents, helping to establish relationships across systems. |
| BindDeliveryMethod | String | The method by which the credit memo is delivered, such as Email, Print, or XML, specifying how the document is sent to the customer. |
| BindDocumentNumber | Long | The document number associated with the credit memo, used for referencing and tracking the specific credit memo in the document management system. |
| BindIntercompany | String | Indicates whether the credit memo is an intercompany transaction, typically marked as 'Y' if the transaction involves multiple entities within the organization. |
| BindPrimarySalesperson | String | The primary salesperson associated with the credit memo, helping to attribute the transaction to a specific sales representative. |
| BindPrintStatus | String | Indicates the print status of the credit memo, such as whether it has been printed or is pending printing. |
| BindPurchaseOrder | String | The purchase order number associated with the credit memo, ensuring that the credit memo is linked to a specific purchase order. |
| BindShipToCustomerName | String | The name of the customer to whom the goods or services are shipped, helping to link the credit memo to the recipient. |
| BindShipToSite | String | The site at which the goods or services are delivered, ensuring the credit memo is associated with the correct delivery location. |
| BindTransactionDate | Date | The date of the transaction related to the credit memo, helping to determine when the transaction occurred and how it should be recorded. |
| BindTransactionNumber | String | The transaction number for the credit memo, used to uniquely identify and track the specific transaction. |
| BindTransactionSource | String | The source system or process that generated the credit memo transaction, providing traceability for the origin of the transaction. |
| BindTransactionType | String | The type of transaction associated with the credit memo, such as 'Sale', 'Return', or other types, allowing for categorization of the transaction. |
| CustomerTransactionId | Long | The customer transaction ID associated with the credit memo, helping to link the credit memo to the specific customer transaction. |
| Finder | String | A reference term or search keyword used to find and identify the credit memo within the system. |
Tracks distribution entries for credit memos, detailing account allocations and supporting ledger postings.
| Name | Type | Description |
| ReceivablesCreditMemosCustomerTransactionId [KEY] | Long | The unique identifier for the customer transaction associated with the credit memo distribution, used for tracking and linking the distribution to its parent transaction. |
| DistributionId [KEY] | Long | The unique identifier for the specific credit memo distribution, enabling the tracking and management of different distribution records within a credit memo. |
| AccountedAmount | Decimal | The amount of the credit memo distribution recorded in the ledger's currency, used for accounting and financial reporting purposes. |
| Amount | Decimal | The amount of the credit memo distribution in the credit memo's currency, representing the value of the distribution for the transaction. |
| Comments | String | User-defined comments associated with the credit memo distribution, providing additional context or notes about the distribution. |
| CreatedBy | String | The name or identifier of the user who created the credit memo distribution record. |
| CreationDate | Datetime | The date and time when the credit memo distribution record was created in the system. |
| DetailedTaxLineNumber | Long | The number associated with the detailed tax line of a credit memo line, providing reference to tax-related calculations linked to the distribution. |
| CreditMemoLineNumber | Long | The number of the specific credit memo line that is associated with the distribution, helping to connect the distribution to its originating credit memo line. |
| LastUpdateDate | Datetime | The date and time when the credit memo distribution record was last updated in the system. |
| LastUpdatedBy | String | The name or identifier of the user who last updated the credit memo distribution record. |
| Percent | Decimal | The percentage of the total line amount that is allocated to this particular distribution, useful for proportionally dividing amounts. |
| AccountClass | String | The class of account associated with the credit memo distribution, such as 'Revenue', 'Receivable', 'Freight', or 'Tax', used for categorization. |
| AccountCombination | String | The account code combination for the distribution, specifying the appropriate financial accounts involved in the credit memo distribution. |
| BindAccountingDate | Date | The accounting date associated with the credit memo distribution, used for determining when the distribution is recognized in the accounting system. |
| BindAllowCompletion | String | Indicates whether the credit memo distribution is allowed to complete the transaction process. Typically marked as 'Y' to allow completion. |
| BindBillToCustomer | String | The bill-to customer associated with the credit memo distribution, ensuring the correct customer is linked to the distribution. |
| BindBillToCustomerNumber | String | The unique number assigned to the bill-to customer, used for referencing the specific customer associated with the credit memo distribution. |
| BindBillToSite | String | The site number for the bill-to customer, ensuring the distribution is correctly linked to the intended site location within the customer's organization. |
| BindBusinessUnit | String | The business unit under which the credit memo distribution is processed, helping to categorize and manage financial transactions within the organization. |
| BindCreditMemoCurrency | String | The currency used for the credit memo distribution, ensuring that the distribution is recorded in the correct currency for the transaction. |
| BindCreditMemoStatus | String | The status of the credit memo distribution, indicating whether it is completed, pending, or in another state in the workflow. |
| BindCrossReference | String | A reference identifier that links the credit memo distribution to related transactions or documents, ensuring traceability across systems. |
| BindDeliveryMethod | String | The method by which the credit memo distribution is delivered, such as email, printed document, or XML, specifying the format of the distribution. |
| BindDocumentNumber | Long | The document number assigned to the credit memo distribution, serving as a unique identifier within the document management system. |
| BindIntercompany | String | Indicates whether the credit memo distribution is part of an intercompany transaction, helping to distinguish between internal and external transactions. |
| BindPrimarySalesperson | String | The primary salesperson associated with the credit memo distribution, providing sales attribution for the distribution. |
| BindPrintStatus | String | Indicates whether the credit memo distribution has been printed or if it is pending printing, used for tracking physical document statuses. |
| BindPurchaseOrder | String | The purchase order number linked to the credit memo distribution, ensuring that the distribution is connected to a specific purchase order. |
| BindShipToCustomerName | String | The name of the customer receiving the goods or services as per the credit memo distribution, ensuring correct recipient information. |
| BindShipToSite | String | The site number for the ship-to customer, ensuring that the distribution is linked to the correct shipping address. |
| BindTransactionDate | Date | The date of the transaction for the credit memo distribution, which helps in reporting and determining the accounting period. |
| BindTransactionNumber | String | The unique transaction number associated with the credit memo distribution, allowing for identification and traceability of the transaction. |
| BindTransactionSource | String | The source from which the credit memo distribution originates, such as a sales order or purchase order. |
| BindTransactionType | String | The type of transaction associated with the credit memo distribution, helping to categorize the nature of the distribution. |
| CustomerTransactionId | Long | The customer transaction ID associated with the credit memo distribution, ensuring that the distribution is linked to a specific customer transaction. |
| Finder | String | A keyword or reference term used to search and identify the credit memo distribution in the system, helping to locate specific records. |
Provides descriptive flexfields for credit memo distribution lines, adding specialized data for comprehensive financial tracking.
| Name | Type | Description |
| ReceivablesCreditMemosCustomerTransactionId [KEY] | Long | The unique identifier for the customer transaction linked to the credit memo distribution, used for associating the distribution with the parent transaction. |
| ReceivablescreditmemodistributionsDistributionId [KEY] | Long | The unique identifier for the credit memo distribution, used to track and manage individual distributions within a credit memo. |
| CustTrxLineGlDistId [KEY] | Long | The General Ledger distribution identifier associated with the customer transaction line, linking the distribution to the appropriate financial record. |
| _FLEX_Context | String | The context name of the descriptive flexfield for the credit memo distribution, used for additional classification or categorization in the system. |
| _FLEX_Context_DisplayValue | String | The display value of the descriptive flexfield context, providing a user-friendly interpretation of the flexfield context. |
| BindAccountingDate | Date | The accounting date for the credit memo distribution, determining when the distribution is recognized in the financial statements. |
| BindAllowCompletion | String | Indicates whether the credit memo distribution can proceed to completion in the system, typically marked as 'Y' for yes or 'N' for no. |
| BindBillToCustomer | String | The identifier for the bill-to customer associated with the credit memo distribution, ensuring the correct customer is linked to the transaction. |
| BindBillToCustomerNumber | String | The unique number for the bill-to customer, used to identify the customer within the system and associate them with the distribution. |
| BindBillToSite | String | The site number for the bill-to customer, specifying the location within the customer's organization to which the distribution is linked. |
| BindBusinessUnit | String | The business unit under which the credit memo distribution is processed, used to categorize and manage financial transactions. |
| BindCreditMemoCurrency | String | The currency code used for the credit memo distribution, ensuring that the distribution is recorded in the correct currency. |
| BindCreditMemoStatus | String | The status of the credit memo distribution, which can indicate whether it is completed, pending, or in another stage of processing. |
| BindCrossReference | String | A reference identifier that links the credit memo distribution to related transactions or documents, ensuring traceability across systems. |
| BindDeliveryMethod | String | The method by which the credit memo distribution is delivered, such as email, paper, or XML, specifying how the distribution is processed. |
| BindDocumentNumber | Long | The document number associated with the credit memo distribution, serving as a unique identifier for the distribution record. |
| BindIntercompany | String | Indicates whether the credit memo distribution is part of an intercompany transaction, which is used to distinguish between internal and external transactions. |
| BindPrimarySalesperson | String | The primary salesperson associated with the credit memo distribution, providing sales attribution and helping to track commission and responsibility. |
| BindPrintStatus | String | Indicates the print status of the credit memo distribution, showing whether the distribution has been printed or is pending printing. |
| BindPurchaseOrder | String | The purchase order number associated with the credit memo distribution, linking the distribution to a specific purchase order for reference. |
| BindShipToCustomerName | String | The name of the customer who is receiving the goods or services as per the credit memo distribution, ensuring correct recipient information. |
| BindShipToSite | String | The site number for the ship-to customer, linking the distribution to the correct shipping address for fulfillment. |
| BindTransactionDate | Date | The date of the transaction for the credit memo distribution, which is used for reporting, accounting, and determining the accounting period. |
| BindTransactionNumber | String | The unique transaction number associated with the credit memo distribution, serving as an identifier for the transaction in the system. |
| BindTransactionSource | String | The source of the transaction, such as sales order or purchase order, which is used to categorize the credit memo distribution. |
| BindTransactionType | String | The type of transaction associated with the credit memo distribution, helping to categorize the nature of the distribution and its financial treatment. |
| CustomerTransactionId | Long | The customer transaction ID associated with the credit memo distribution, linking it to the customer's original transaction record. |
| Finder | String | A keyword or reference term used to search and identify the credit memo distribution in the system, helping to locate specific records for analysis or review. |
Houses global descriptive flexfields for credit memos, accommodating region-specific or corporate-wide fields.
| Name | Type | Description |
| ReceivablesCreditMemosCustomerTransactionId [KEY] | Long | The unique identifier of the customer transaction associated with the credit memo, linking the credit memo to the customer’s transaction in the system. |
| CustomerTrxId [KEY] | Long | The customer transaction ID that uniquely identifies the original transaction for the credit memo. |
| ExcludeFromNetting | String | Indicates whether the credit memo should be excluded from netting calculations, typically used when consolidating receivables across multiple transactions. |
| DeliveryDateforTaxPointDate | Date | The date on which the delivery occurred, used to determine the tax point date for the credit memo transaction, which affects tax calculations. |
| _FLEX_Context | String | The context name of the descriptive flexfield for the credit memo, allowing for additional categorization or classification within the system. |
| _FLEX_Context_DisplayValue | String | The display value of the descriptive flexfield context, providing a user-friendly interpretation of the credit memo’s context. |
| BindAccountingDate | Date | The accounting date assigned to the credit memo, determining when the transaction is recorded in the financial statements. |
| BindAllowCompletion | String | Indicates whether the credit memo can be completed in the system, typically marked as 'Y' for yes or 'N' for no. |
| BindBillToCustomer | String | The identifier for the bill-to customer associated with the credit memo, ensuring the correct customer is linked to the credit transaction. |
| BindBillToCustomerNumber | String | The unique number for the bill-to customer, used to identify the customer within the system and link them to the credit memo. |
| BindBillToSite | String | The site number for the bill-to customer, specifying the location within the customer's organization where the credit memo is linked. |
| BindBusinessUnit | String | The business unit under which the credit memo is processed, used for organizational categorization and financial management. |
| BindCreditMemoCurrency | String | The currency used for the credit memo, ensuring that the credit memo is processed in the correct currency. |
| BindCreditMemoStatus | String | The status of the credit memo, indicating its current processing stage, such as pending, approved, or completed. |
| BindCrossReference | String | A reference identifier that links the credit memo to other related transactions or documents for improved traceability. |
| BindDeliveryMethod | String | The method of delivering the credit memo, such as email, paper, or XML, to specify how the credit memo is communicated to the customer. |
| BindDocumentNumber | Long | The document number assigned to the credit memo, serving as the primary identifier for the credit memo in the system. |
| BindIntercompany | String | Indicates whether the credit memo is part of an intercompany transaction, useful for managing transactions between related business entities. |
| BindPrimarySalesperson | String | The primary salesperson associated with the credit memo, used for tracking commissions and sales attribution. |
| BindPrintStatus | String | The print status of the credit memo, indicating whether the credit memo has been printed or is still pending. |
| BindPurchaseOrder | String | The purchase order number associated with the credit memo, linking the credit memo to the original purchase order. |
| BindShipToCustomerName | String | The name of the customer receiving the goods or services billed by the credit memo. |
| BindShipToSite | String | The site number for the ship-to customer, specifying the location for delivery associated with the credit memo. |
| BindTransactionDate | Date | The transaction date for the credit memo, which is used for reporting and accounting purposes. |
| BindTransactionNumber | String | The unique transaction number associated with the credit memo, identifying the transaction in the system. |
| BindTransactionSource | String | The source of the transaction for the credit memo, helping to categorize and trace the credit memo's origin. |
| BindTransactionType | String | The type of transaction for the credit memo, which helps categorize the nature of the transaction and its financial treatment. |
| CustomerTransactionId | Long | The unique identifier for the customer transaction associated with the credit memo, linking it back to the original customer transaction. |
| Finder | String | A keyword or reference term used to search and identify the credit memo in the system, facilitating quick lookups for analysis or review. |
Represents each line item of a credit memo, specifying product, amounts, and adjustments for the transaction.
| Name | Type | Description |
| ReceivablesCreditMemosCustomerTransactionId [KEY] | Long | The unique identifier for the customer transaction associated with the credit memo, linking the credit memo to a specific customer transaction. |
| CustomerTransactionLineId [KEY] | Long | The unique identifier for each individual line of the credit memo, ensuring traceability of the specific items or services being credited. |
| LineNumber | Decimal | The sequential number of each line in the credit memo, providing an ordered reference for each line item. |
| LineDescription | String | A brief description of the product or service associated with the credit memo line, used for identification and reference purposes. |
| CreatedBy | String | The user who initially created the credit memo line, providing accountability for the creation process. |
| CreationDate | Datetime | The date and time when the credit memo line was created in the system, helping to track the creation timeline. |
| LastUpdatedBy | String | The user who last updated the credit memo line, ensuring proper tracking of changes made to the line. |
| LastUpdateDate | Datetime | The date and time when the credit memo line was last updated, ensuring that modifications are recorded. |
| UnitSellingPrice | Decimal | The price per unit of the product or service listed on the credit memo line, determining the value of the credited item. |
| LineQuantityCredit | Decimal | The quantity of items or services credited on the credit memo line, indicating the number of units being adjusted. |
| LineAmountCredit | Decimal | The total amount credited on the credit memo line, calculated by multiplying the unit price by the credited quantity. |
| Warehouse | String | The warehouse or location from which the items were shipped, relevant for inventory management and logistical tracking. |
| UnitOfMeasure | String | The unit of measure used to quantify the product or service on the credit memo line, such as pieces, hours, or kilograms. |
| ItemNumber | String | The unique identifier of the inventory item being credited, linking the credit memo line to a specific product in the inventory. |
| MemoLine | String | A user-defined identifier or description for the credit memo line, often used when the line is not associated with an inventory item. |
| LineCreditReason | String | The reason for crediting all or part of the line amount, providing context for why a credit is being applied. |
| LineTranslatedDescription | String | A translation of the credit memo line description, allowing for multi-language support in international transactions. |
| TaxInvoiceNumber | String | The unique identifier of the tax invoice related to the credit memo, supporting the credit process by linking it to the original invoice. |
| TaxInvoiceDate | Date | The date when the tax invoice, which supports the credit memo, was issued, helping to establish the timing of the original transaction. |
| TransactionLineAssessableValue | Decimal | The taxable base amount for the credit memo line, used for calculating tax on the credited items or services. |
| SalesOrderNumber | String | The sales order number associated with the credit memo line, linking the credit memo to the original sales order. |
| SalesOrderDate | Date | The date the sales order was created, establishing the context for when the order that led to the credit memo was placed. |
| SalesOrderLine | String | The line number of the sales order that corresponds to the credit memo line, ensuring the credit memo is matched with the correct order. |
| SalesOrderRevision | Decimal | The revision number for the sales order, helping to track updates or changes made to the original order. |
| SalesOrderChannel | String | The sales channel through which the sales order was created, providing insight into the medium used to place the order. |
| TaxClassificationCode | String | The tax classification code that governs how tax is calculated on the credit memo line, impacting the tax rate applied. |
| LineFreightCreditAmount | Decimal | The amount credited for freight charges on the credit memo line, used for adjusting shipping-related charges. |
| LineProductType | String | The type of product or service, which may influence how taxes are calculated or how the item is treated in the system. Valid values include 'Goods' and 'Services'. |
| ProductFiscalClassification | String | The fiscal classification assigned to the product, which determines its tax treatment based on regulations from tax authorities. |
| LineProductCategory | String | The product category for tax purposes, used to define the taxability of non-inventory items on the credit memo line. |
| TransactionBusinessCategory | String | The business category of the transaction, which helps categorize the credit memo for tax and reporting purposes. |
| UserDefinedFiscalClassification | String | A custom classification for the credit memo line, defined by the user to meet specific tax or regulatory requirements. |
| LineTaxExemptionHandling | String | Indicates how tax exemptions should be applied to the credit memo line, with valid values such as 'Standard', 'Require', and 'Exempt'. |
| LineAmountIncludesTax | String | Indicates whether the line amount includes tax, excludes tax, or is determined by the tax setup, impacting the calculation of the credited amount. |
| TaxExemptionReason | String | The reason why a party or product is exempt from tax, providing context for the tax exemption applied to the credit memo line. |
| TaxExemptionCertificateNumber | String | The certificate number that proves a party or product's eligibility for tax exemption, ensuring compliance with tax laws. |
| LineIntendedUse | String | The intended use of the product for tax purposes, which may influence the tax rate or exemptions applied to the credit memo line. |
| BindAccountingDate | Date | The accounting date that binds the credit memo line for financial reporting, indicating when the transaction is recorded. |
| BindAllowCompletion | String | Indicates whether the credit memo line is ready for completion in the system, with valid values such as 'Y' for yes or 'N' for no. |
| BindBillToCustomer | String | The customer associated with the credit memo line, specifying the entity to which the credit is applied. |
| BindBillToCustomerNumber | String | The unique identifier for the bill-to customer, used to track the credit memo line's relationship with the customer. |
| BindBillToSite | String | The site associated with the bill-to customer, ensuring the credit memo line is linked to the correct customer location. |
| BindBusinessUnit | String | The business unit responsible for the credit memo line, which may influence the financial and organizational handling of the credit. |
| BindCreditMemoCurrency | String | The currency used for the credit memo line, ensuring proper handling of multi-currency transactions. |
| BindCreditMemoStatus | String | The status of the credit memo line, such as 'Pending', 'Completed', or 'Cancelled', indicating the processing stage of the credit. |
| BindCrossReference | String | A reference that links the credit memo line to related transactions or documents, ensuring traceability. |
| BindDeliveryMethod | String | The method of delivering the credit memo to the customer, such as email or printed copy, for customer communication. |
| BindDocumentNumber | Long | The document number assigned to the credit memo line, used to uniquely identify and track the credit memo. |
| BindIntercompany | String | Indicates whether the credit memo line is part of an intercompany transaction, relevant for transactions between related business entities. |
| BindPrimarySalesperson | String | The salesperson responsible for the credit memo line, used for sales tracking and commission purposes. |
| BindPrintStatus | String | The status of the print process for the credit memo, indicating whether it has been printed or is still pending. |
| BindPurchaseOrder | String | The purchase order number associated with the credit memo line, linking the credit back to the original order. |
| BindShipToCustomerName | String | The name of the customer receiving the goods or services associated with the credit memo line. |
| BindShipToSite | String | The site number for the ship-to customer, ensuring the correct delivery location for goods or services. |
| BindTransactionDate | Date | The date the credit memo transaction occurred, helping with accounting and reporting. |
| BindTransactionNumber | String | The unique number for the credit memo transaction, used for tracking and referencing the credit. |
| BindTransactionSource | String | The source of the transaction that led to the creation of the credit memo, providing context for how the credit memo was generated. |
| BindTransactionType | String | The type of transaction, such as a return or adjustment, which defines how the credit memo is processed. |
| CustomerTransactionId | Long | The identifier for the customer transaction related to the credit memo line, ensuring the credit is linked to the appropriate customer record. |
| Finder | String | A reference term used to search and identify the credit memo line within the system, facilitating quick retrieval of the record. |
Facilitates document attachments at the credit memo line level, ensuring full traceability of line-specific data.
| Name | Type | Description |
| ReceivablesCreditMemosCustomerTransactionId [KEY] | Long | The unique identifier for the customer transaction associated with the credit memo line, linking the credit memo to a specific customer transaction. |
| ReceivablescreditmemolinesCustomerTransactionLineId [KEY] | Long | The unique identifier for the specific transaction line within the credit memo, allowing tracking of each item or service credited. |
| AttachedDocumentId [KEY] | Long | The unique identifier for the attached document, linking the attachment to the credit memo line. |
| LastUpdateDate | Datetime | The date and time when the attachment was last updated, helping to track when modifications were made. |
| LastUpdatedBy | String | The user who last updated the attachment, ensuring accountability for changes to the document. |
| DatatypeCode | String | Indicates the data type of the attachment, providing information on the format or structure of the attached document. |
| FileName | String | The file name of the attachment, used to identify the document within the system. |
| DmFolderPath | String | The folder path where the attachment is stored, providing information on the directory structure within the document management system. |
| DmDocumentId | String | The document ID associated with the attachment, used for referencing the document in the document management system. |
| DmVersionNumber | String | The version number of the document, indicating the revision of the attachment. |
| Url | String | The URL for web-based attachments, directing users to the location where the document can be accessed. |
| CategoryName | String | The category assigned to the attachment, which helps in organizing and classifying attachments within the system. |
| UserName | String | The user associated with the attachment, indicating who uploaded or is managing the document. |
| Uri | String | The URI (Uniform Resource Identifier) for the attachment, providing a path to access the document in the system. |
| FileUrl | String | The direct URL of the file attachment, allowing users to access the file directly from the web. |
| UploadedText | String | The text content of a new text-based attachment, allowing users to upload textual information as part of the credit memo process. |
| UploadedFileContentType | String | The content type of the uploaded attachment, indicating the format. |
| UploadedFileLength | Long | The size of the uploaded file, measured in bytes, providing information about the file's storage requirements. |
| UploadedFileName | String | The name given to the uploaded file, used to identify and manage the file in the system. |
| ContentRepositoryFileShared | Bool | Indicates whether the attachment is shared across the organization or remains private to a specific user or department. |
| Title | String | The title of the attachment, providing a brief descriptor for the document that helps users identify the content. |
| Description | String | The detailed description of the attachment, offering additional context or explanation for the attached document. |
| ErrorStatusCode | String | The error code associated with the attachment, if any, indicating issues during file upload or processing. |
| ErrorStatusMessage | String | The error message associated with the attachment, if any, providing detailed information about the problem with the attachment. |
| CreatedBy | String | The user who created the attachment, ensuring traceability for the document's origin. |
| CreationDate | Datetime | The date and time when the attachment was initially created, helping to track the document's history. |
| FileContents | String | The content of the attachment itself, such as a text-based document or the metadata of a file upload. |
| ExpirationDate | Datetime | The expiration date for the attachment, specifying when the file should no longer be considered valid or accessible. |
| LastUpdatedByUserName | String | The username of the person who last updated the attachment, ensuring accountability for modifications. |
| CreatedByUserName | String | The username of the person who originally created the attachment, helping to identify the document's creator. |
| AsyncTrackerId | String | An identifier used to track the file upload process, assisting in managing asynchronous file operations. |
| FileWebImage | String | A web-based image version of the attachment, typically used for previewing documents in web-based applications. |
| DownloadInfo | String | A JSON object that contains the necessary information to retrieve the file programmatically, enabling automated file downloads. |
| PostProcessingAction | String | The action that can be performed after the attachment is uploaded, such as validation, transformation, or archiving. |
| BindAccountingDate | Date | The accounting date for the attachment, ensuring that the document is associated with the correct financial period. |
| BindAllowCompletion | String | Indicates whether the attachment process can be completed, with valid values like 'Y' or 'N' to denote the attachment's status. |
| BindBillToCustomer | String | The customer associated with the credit memo line, indicating the party to which the credit memo and its attachments pertain. |
| BindBillToCustomerNumber | String | The customer number associated with the credit memo line, uniquely identifying the bill-to customer in the system. |
| BindBillToSite | String | The customer site number where the goods or services related to the credit memo are billed, allowing for location-specific billing. |
| BindBusinessUnit | String | The business unit handling the credit memo, which may influence the processing and management of the associated documents. |
| BindCreditMemoCurrency | String | The currency in which the credit memo and its attachments are processed, ensuring the document is correctly associated with the appropriate currency. |
| BindCreditMemoStatus | String | The current status of the credit memo, such as 'Pending', 'Completed', or 'Cancelled', indicating its progress in the workflow. |
| BindCrossReference | String | A cross-reference field used to link the credit memo with related documents or transactions, enhancing traceability. |
| BindDeliveryMethod | String | The method used to deliver the credit memo and its attachments, such as email, printed copy, or electronic document. |
| BindDocumentNumber | Long | The document number for the credit memo, ensuring that the attachment is properly linked to a specific document in the system. |
| BindIntercompany | String | Indicates whether the credit memo line pertains to an intercompany transaction, allowing for appropriate intercompany accounting. |
| BindPrimarySalesperson | String | The salesperson associated with the credit memo, enabling the assignment of credit or commissions to the correct individual. |
| BindPrintStatus | String | The status of the print process for the credit memo and its attachments, indicating whether the documents have been printed or are pending. |
| BindPurchaseOrder | String | The purchase order number associated with the credit memo, linking the credit memo to the original order and its related documents. |
| BindShipToCustomerName | String | The customer name associated with the shipment of goods or services, used to link the credit memo to the customer involved. |
| BindShipToSite | String | The site number for the customer where the goods or services related to the credit memo are shipped, ensuring correct delivery information. |
| BindTransactionDate | Date | The transaction date for the credit memo, providing a reference point for when the transaction occurred in the system. |
| BindTransactionNumber | String | The unique transaction number associated with the credit memo, which is used to track and identify the credit in the system. |
| BindTransactionSource | String | The source of the transaction that generated the credit memo, indicating whether it came from a sales return, adjustment, or other transaction type. |
| BindTransactionType | String | The type of transaction that the credit memo represents, such as a return, adjustment, or dispute. |
| CustomerTransactionId | Long | The identifier for the customer transaction associated with the credit memo, ensuring the credit memo is properly linked to the original transaction. |
| Finder | String | A reference term used to search and identify the credit memo attachment within the system, facilitating quick retrieval of records. |
Enables descriptive flexfields for individual credit memo lines, capturing extended transaction details.
| Name | Type | Description |
| ReceivablesCreditMemosCustomerTransactionId [KEY] | Long | The unique identifier for the customer transaction associated with the credit memo line, linking the credit memo to a specific customer transaction. |
| ReceivablescreditmemolinesCustomerTransactionLineId [KEY] | Long | The unique identifier for the specific transaction line within the credit memo, allowing tracking of each item or service credited. |
| CustomerTrxLineId [KEY] | Long | The identifier for the customer transaction line, linking each credit memo line to the associated transaction line. |
| _FLEX_Context | String | The context associated with the credit memo line's descriptive flexfield, providing additional attributes or settings relevant to the credit memo line. |
| _FLEX_Context_DisplayValue | String | The display value of the descriptive flexfield context, offering a human-readable label or description of the flexfield context. |
| BindAccountingDate | Date | The accounting date for the credit memo line, ensuring the document is recorded in the correct financial period. |
| BindAllowCompletion | String | Indicates whether the credit memo line can be completed. Valid values typically include 'Y' for yes or 'N' for no, depending on the completion status. |
| BindBillToCustomer | String | The customer associated with the credit memo line, specifying which customer is being billed or credited. |
| BindBillToCustomerNumber | String | The customer number associated with the credit memo line, uniquely identifying the customer in the system. |
| BindBillToSite | String | The customer site number for the bill-to customer, linking the credit memo to the specific billing location. |
| BindBusinessUnit | String | The business unit under which the credit memo line is created, categorizing it within the organizational structure. |
| BindCreditMemoCurrency | String | The currency in which the credit memo line is processed, ensuring the correct financial calculations for the transaction. |
| BindCreditMemoStatus | String | The status of the credit memo line, indicating its progress, such as 'Pending', 'Completed', or 'Cancelled'. |
| BindCrossReference | String | A reference used to link the credit memo line to related documents or transactions, ensuring traceability across systems. |
| BindDeliveryMethod | String | The method used to deliver the credit memo and its associated documents, such as email, printed copy, or electronic document. |
| BindDocumentNumber | Long | The document number assigned to the credit memo, used for tracking and referencing the credit memo within the system. |
| BindIntercompany | String | Indicates whether the credit memo line pertains to an intercompany transaction, facilitating intercompany accounting and reconciliation. |
| BindPrimarySalesperson | String | The salesperson associated with the credit memo line, used to assign credit or commissions to the correct sales representative. |
| BindPrintStatus | String | The status indicating whether the credit memo line has been printed, such as 'Printed' or 'Not Printed'. |
| BindPurchaseOrder | String | The purchase order number associated with the credit memo line, linking the credit memo to the original purchase order. |
| BindShipToCustomerName | String | The name of the customer to whom the goods or services related to the credit memo are shipped. |
| BindShipToSite | String | The customer site number where the goods or services related to the credit memo are delivered, ensuring accurate shipping details. |
| BindTransactionDate | Date | The transaction date for the credit memo line, indicating when the credit memo transaction occurred. |
| BindTransactionNumber | String | The transaction number assigned to the credit memo line, used for tracking and referencing the transaction within the system. |
| BindTransactionSource | String | The source of the transaction that generated the credit memo line, indicating whether it came from a sales return, adjustment, or other transaction type. |
| BindTransactionType | String | The type of transaction that the credit memo line represents, such as a return, adjustment, or dispute. |
| CustomerTransactionId | Long | The identifier for the customer transaction associated with the credit memo line, linking it back to the original transaction. |
| Finder | String | A reference term used to search and identify the credit memo line within the system, helping users quickly locate records. |
Holds global descriptive flexfields for credit memo lines, supporting worldwide or business-specific data requirements.
| Name | Type | Description |
| ReceivablesCreditMemosCustomerTransactionId [KEY] | Long | The unique identifier for the customer transaction associated with the credit memo line in Receivables Credit Memos. |
| ReceivablescreditmemolinesCustomerTransactionLineId [KEY] | Long | The unique identifier for the specific line within a credit memo, linking it to the customer transaction line. |
| CustomerTrxLineId [KEY] | Long | The identifier for the customer transaction line associated with the credit memo line, used to link the credit memo to a specific transaction. |
| _FLEX_Context | String | The context of the descriptive flexfield for the credit memo line, allowing for additional attributes and settings related to the credit memo line. |
| _FLEX_Context_DisplayValue | String | A human-readable display value for the flexfield context, providing more clarity about the context in which the credit memo line is processed. |
| BindAccountingDate | Date | The accounting date associated with the credit memo line, ensuring that the document is recorded in the correct financial period. |
| BindAllowCompletion | String | Indicates whether the credit memo line can be completed. Valid values typically include 'Y' for yes or 'N' for no. |
| BindBillToCustomer | String | The customer associated with the credit memo line, identifying which customer is being billed or credited. |
| BindBillToCustomerNumber | String | The unique customer number associated with the credit memo line, helping to track the customer within the system. |
| BindBillToSite | String | The site number associated with the bill-to customer for the credit memo, specifying the location of the billed customer. |
| BindBusinessUnit | String | The business unit under which the credit memo line is created, categorizing the transaction within the organization. |
| BindCreditMemoCurrency | String | The currency in which the credit memo line is processed, ensuring that the correct financial calculations are made. |
| BindCreditMemoStatus | String | The status of the credit memo line, such as 'Pending', 'Completed', or 'Cancelled', indicating the processing state of the credit memo. |
| BindCrossReference | String | A reference linking the credit memo line to related documents or transactions, providing traceability across systems. |
| BindDeliveryMethod | String | The method used to deliver the credit memo, such as email, paper, or XML, based on the settings in the system. |
| BindDocumentNumber | Long | The document number assigned to the credit memo line, which serves as a unique identifier for tracking the credit memo. |
| BindIntercompany | String | Indicates whether the credit memo line is part of an intercompany transaction, facilitating the process of intercompany accounting. |
| BindPrimarySalesperson | String | The salesperson associated with the credit memo line, used to track sales commissions or credit allocation. |
| BindPrintStatus | String | The print status of the credit memo line, indicating whether it has been printed or is pending printing. |
| BindPurchaseOrder | String | The purchase order number associated with the credit memo line, linking it to the original purchase order. |
| BindShipToCustomerName | String | The name of the customer to whom the goods or services are shipped as per the credit memo line. |
| BindShipToSite | String | The site number where the goods or services related to the credit memo line are delivered. |
| BindTransactionDate | Date | The date when the credit memo transaction occurred, used for accurate financial reporting and tracking. |
| BindTransactionNumber | String | The transaction number assigned to the credit memo line, serving as a reference within the accounting system. |
| BindTransactionSource | String | The source of the transaction that generated the credit memo line, identifying whether it originated from a sales return, adjustment, or other source. |
| BindTransactionType | String | The type of transaction represented by the credit memo line, such as return, adjustment, or dispute. |
| CustomerTransactionId | Long | The identifier for the customer transaction related to the credit memo line, used to link it back to the original customer transaction. |
| Finder | String | A reference term used to search and locate credit memo lines in the system, aiding in efficient record retrieval. |
Stores tax line details for credit memo lines, specifying calculated taxes, jurisdictions, and associated rates.
| Name | Type | Description |
| ReceivablesCreditMemosCustomerTransactionId [KEY] | Long | The unique identifier for the customer transaction associated with the credit memo line tax details. |
| ReceivablescreditmemolinesCustomerTransactionLineId [KEY] | Long | The unique identifier for the specific credit memo line related to the customer transaction, used to link it with tax information. |
| CustomerTrxLineId [KEY] | Long | The identifier for the customer transaction line that the tax line corresponds to, providing a detailed breakdown of the transaction. |
| CreatedBy | String | The user who created the tax line record for the credit memo, allowing traceability of data entry. |
| CreationDate | Datetime | The date and time when the tax line record for the credit memo was created. |
| LastUpdateDate | Datetime | The most recent date and time when the tax line for the credit memo was updated, reflecting changes in tax data. |
| LastUpdatedBy | String | The user who last updated the tax line record for the credit memo, aiding in tracking modifications. |
| TaxJurisdictionCode | String | The code indicating the tax jurisdiction under which the tax line for the credit memo is assessed, ensuring compliance with local tax laws. |
| TaxRate | Decimal | The applicable tax rate for the credit memo line, used to calculate the tax amount on the transaction. |
| TaxRateCode | String | The code representing the tax rate, used for categorization and reference in tax calculations. |
| TaxRegimeCode | String | The code representing the tax regime applied to the credit memo line, determining the tax rules for the transaction. |
| TaxStatusCode | String | The status of the tax line, such as 'Active' or 'Inactive', indicating the validity of the tax details. |
| Tax | String | The tax code assigned to the credit memo line, identifying the specific tax type applied to the transaction. |
| TaxAmount | Decimal | The total tax amount calculated for the credit memo line in the entered currency. |
| TaxableAmount | Decimal | The taxable amount for the credit memo line, before the tax is applied, determining the base for tax calculation. |
| TaxPointBasis | String | The basis for determining the tax point, indicating whether the tax applies at the point of sale, shipment, or other relevant events. |
| TaxPointDate | Date | The date that determines when the tax point is triggered for the credit memo line, crucial for tax reporting. |
| TaxLineNumber | Int | The unique identifier for the tax line within the credit memo, used for tracking multiple tax lines associated with the same credit memo. |
| PlaceOfSupply | Int | The location where the supply of goods or services is considered to take place for tax purposes, determining the applicable tax rates. |
| TaxInclusiveIndicator | String | Indicates whether the credit memo line amount includes tax, or if tax is calculated separately. Valid values are 'Yes' or 'No'. |
| BindAccountingDate | Date | The accounting date for the credit memo line tax, used to record the tax event in the correct financial period. |
| BindAllowCompletion | String | Indicates whether the tax line for the credit memo can be completed. Typically set to 'Y' for yes or 'N' for no. |
| BindBillToCustomer | String | The customer associated with the credit memo, indicating which party is responsible for the tax obligations. |
| BindBillToCustomerNumber | String | The unique number identifying the bill-to customer for the credit memo line, used for reference in accounting and tax processing. |
| BindBillToSite | String | The site number associated with the bill-to customer for the credit memo, used for identifying the specific location of the billed customer. |
| BindBusinessUnit | String | The business unit under which the credit memo and its associated tax are processed, ensuring proper financial categorization. |
| BindCreditMemoCurrency | String | The currency in which the credit memo tax line is calculated, ensuring consistency with the business's financial transactions. |
| BindCreditMemoStatus | String | The current status of the credit memo line, such as 'Pending', 'Completed', or 'Cancelled', determining if the tax line can be processed. |
| BindCrossReference | String | A cross-reference code linking the tax line of the credit memo to other associated documents or transactions. |
| BindDeliveryMethod | String | The method used to deliver the credit memo, such as 'Email' or 'Printed', determining how the tax details are communicated to the customer. |
| BindDocumentNumber | Long | The unique number assigned to the credit memo document, used for tracking and referencing the tax line within the system. |
| BindIntercompany | String | Indicates whether the credit memo line is part of an intercompany transaction, enabling correct accounting treatment for internal transfers. |
| BindPrimarySalesperson | String | The salesperson associated with the credit memo line, tracking sales commissions or other relevant attributes. |
| BindPrintStatus | String | The print status of the credit memo line, indicating whether it has been printed or is pending printing. |
| BindPurchaseOrder | String | The purchase order number associated with the credit memo line, linking it to the original sales transaction. |
| BindShipToCustomerName | String | The name of the customer receiving the goods or services associated with the credit memo line. |
| BindShipToSite | String | The site number where the goods or services associated with the credit memo line are delivered. |
| BindTransactionDate | Date | The date when the transaction occurred, used for tax reporting and accounting purposes. |
| BindTransactionNumber | String | The transaction number of the credit memo, providing a reference to track the specific transaction in the system. |
| BindTransactionSource | String | The source document or system from which the credit memo originated, used to link the credit memo back to its original source. |
| BindTransactionType | String | The type of transaction for the credit memo line, such as 'Return' or 'Adjustment', used for categorizing the tax treatment. |
| CustomerTransactionId | Long | The identifier for the customer transaction associated with the credit memo, linking the tax line to the original transaction. |
| Finder | String | A search term used to locate specific credit memo lines and tax details within the system. |
Manages descriptive flexfields for credit memo transactions at the line level, enhancing finance data granularity.
| Name | Type | Description |
| ReceivablesCreditMemosCustomerTransactionId [KEY] | Long | The unique identifier for the customer transaction associated with the credit memo line transaction details. |
| ReceivablescreditmemolinesCustomerTransactionLineId [KEY] | Long | The unique identifier for the specific credit memo line related to the customer transaction, used to link it with transaction details. |
| CustomerTrxLineId [KEY] | Long | The identifier for the customer transaction line that the credit memo transaction details correspond to, providing a breakdown of the transaction. |
| _FLEX_Context | String | The context value of the descriptive flexfield (DFF) that applies to the credit memo line transaction, used for capturing additional transaction details. |
| _FLEX_Context_DisplayValue | String | The display value of the context from the DFF, providing a human-readable description of the context. |
| BindAccountingDate | Date | The accounting date for the credit memo line transaction, determining the financial period in which the transaction is recognized. |
| BindAllowCompletion | String | Indicates whether the transaction line for the credit memo can be completed. Typically set to 'Y' for yes or 'N' for no. |
| BindBillToCustomer | String | The bill-to customer associated with the credit memo, identifying the customer responsible for payment. |
| BindBillToCustomerNumber | String | The unique number identifying the bill-to customer, used for tracking and referencing customer transactions. |
| BindBillToSite | String | The site number associated with the bill-to customer, indicating the location to which the credit memo is billed. |
| BindBusinessUnit | String | The business unit under which the credit memo and its associated transaction details are processed. |
| BindCreditMemoCurrency | String | The currency in which the credit memo line transaction is calculated, ensuring consistency with the customer's financial transaction. |
| BindCreditMemoStatus | String | The current status of the credit memo, such as 'Pending', 'Completed', or 'Cancelled', indicating the processing state of the credit memo. |
| BindCrossReference | String | A cross-reference code linking the credit memo line transaction to other related documents or transactions for easy tracking. |
| BindDeliveryMethod | String | The method used to deliver the credit memo, such as 'Email', 'Fax', or 'Printed', indicating how the credit memo is sent to the customer. |
| BindDocumentNumber | Long | The unique document number assigned to the credit memo, used for referencing and tracking within the system. |
| BindIntercompany | String | Indicates whether the credit memo line is part of an intercompany transaction, enabling proper handling for internal business transfers. |
| BindPrimarySalesperson | String | The salesperson associated with the credit memo line, used for tracking sales commissions or identifying the responsible sales representative. |
| BindPrintStatus | String | The print status of the credit memo line, indicating whether it has been printed or is pending printing. |
| BindPurchaseOrder | String | The purchase order number associated with the credit memo line, linking the credit memo back to the original sales or procurement order. |
| BindShipToCustomerName | String | The name of the customer receiving the goods or services associated with the credit memo line. |
| BindShipToSite | String | The site number identifying the destination for goods or services related to the credit memo line. |
| BindTransactionDate | Date | The transaction date for the credit memo, indicating when the transaction took place and is used for reporting purposes. |
| BindTransactionNumber | String | The transaction number for the credit memo, providing a reference for identifying specific transactions in the system. |
| BindTransactionSource | String | The source of the transaction, such as a sales order or return request, linking the credit memo back to its origin. |
| BindTransactionType | String | The type of transaction associated with the credit memo line, such as 'Return' or 'Adjustment', used for categorizing the transaction. |
| CustomerTransactionId | Long | The unique identifier for the customer transaction associated with the credit memo, linking the tax line to the original transaction. |
| Finder | String | A search term used to locate specific credit memo lines and transaction details within the system. |
Applies descriptive flexfields at the credit memo transaction level, capturing custom attributes for the entire memo.
| Name | Type | Description |
| ReceivablesCreditMemosCustomerTransactionId [KEY] | Long | The unique identifier for the customer transaction related to the credit memo, linking the transaction to its corresponding credit memo. |
| CustomerTrxId [KEY] | Long | The identifier for the customer transaction associated with the credit memo, providing a reference to the original transaction. |
| _FLEX_Context | String | The descriptive flexfield (DFF) context for the credit memo transaction, which allows additional user-defined attributes to be captured for the transaction. |
| _FLEX_Context_DisplayValue | String | The human-readable display value for the DFF context, providing a more understandable representation of the context. |
| BindAccountingDate | Date | The accounting date for the credit memo transaction, indicating the financial period in which the transaction is recognized. |
| BindAllowCompletion | String | Indicates whether the credit memo transaction can be completed. The value is typically 'Y' for yes or 'N' for no. |
| BindBillToCustomer | String | The bill-to customer associated with the credit memo, indicating the customer responsible for payment. |
| BindBillToCustomerNumber | String | The unique number that identifies the bill-to customer in the system, used for transaction tracking and reporting. |
| BindBillToSite | String | The site number associated with the bill-to customer, indicating the location to which the credit memo is billed. |
| BindBusinessUnit | String | The business unit under which the credit memo and its related transaction are processed, used for internal reporting and management. |
| BindCreditMemoCurrency | String | The currency used for the credit memo transaction, ensuring that the amounts are calculated in the correct financial currency. |
| BindCreditMemoStatus | String | The current status of the credit memo transaction, such as 'Pending', 'Completed', or 'Cancelled', indicating its processing state. |
| BindCrossReference | String | A cross-reference code used to link the credit memo to other related documents or transactions for easier tracking and management. |
| BindDeliveryMethod | String | The method used for delivering the credit memo, such as 'Email', 'Fax', or 'Printed', specifying how the document is sent to the customer. |
| BindDocumentNumber | Long | The unique number assigned to the credit memo document, used for identifying and referencing the document within the system. |
| BindIntercompany | String | Indicates whether the credit memo transaction is part of an intercompany transaction, used to track internal transfers between different business entities. |
| BindPrimarySalesperson | String | The salesperson associated with the credit memo transaction, used for tracking sales commissions and identifying the responsible sales representative. |
| BindPrintStatus | String | The print status of the credit memo, indicating whether it has been printed or is pending printing. |
| BindPurchaseOrder | String | The purchase order number associated with the credit memo, linking the credit memo to the original purchase or procurement order. |
| BindShipToCustomerName | String | The name of the customer who is receiving the goods or services associated with the credit memo. |
| BindShipToSite | String | The site number identifying the destination for the goods or services related to the credit memo. |
| BindTransactionDate | Date | The date the transaction associated with the credit memo occurred, used for tracking and reporting purposes. |
| BindTransactionNumber | String | The unique number assigned to the credit memo transaction, used for tracking and identifying specific transactions. |
| BindTransactionSource | String | The source of the transaction that generated the credit memo, such as a sales order or return request. |
| BindTransactionType | String | The type of transaction related to the credit memo, such as 'Return', 'Adjustment', or 'Discount'. |
| CustomerTransactionId | Long | The unique identifier for the customer transaction that corresponds to the credit memo, used to link the transaction with the credit memo. |
| Finder | String | A search term used to locate specific credit memo transactions and their details in the system. |
Consolidates activities for a customer’s accounts, including transactions, receipts, and credit applications within Receivables.
| Name | Type | Description |
| AccountId [KEY] | Long | The unique identifier for the customer account associated with the receivables activities, used for referencing the account in various transactions. |
| AccountNumber | String | The number associated with the customer account, typically used as an account identifier for tracking and managing receivables. |
| CustomerName | String | The name of the customer whose account activities are being recorded, providing identification for the account holder. |
| CustomerId | Long | The unique identifier for the customer in the system, used to link the customer to their account and transactions. |
| TaxRegistrationNumber | String | The tax registration number assigned to the customer, used for tax reporting and compliance purposes. |
| TaxpayerIdentificationNumber | String | The Tax Indentification Number (TIN) for the customer, used for government tax identification and reporting. |
| TotalOpenReceivablesForAccount | Decimal | The total amount of outstanding receivables on the customer’s account, representing amounts that are yet to be paid. |
| TotalTransactionsDueForAccount | Decimal | The total amount of transactions that are due for payment on the customer’s account, including invoices and credits. |
| CreatedBy | String | The user or system that created the account activity record, used for tracking and accountability in the system. |
| CreationDate | Datetime | The date and time when the account activity record was created, useful for auditing and tracking record history. |
| LastUpdatedBy | String | The user or system that last updated the account activity record, providing visibility into who made changes to the record. |
| LastUpdateDate | Datetime | The date and time when the account activity record was last updated, allowing for tracking of the most recent modifications. |
| Finder | String | A search term used to locate specific account activity records based on the attributes or details provided. |
| TransactionLimitByDays | Int | The maximum number of days allowed for the transaction limit, which may be used to determine the aging or payment terms for receivables. |
| TransactionStatus | String | The current status of the transaction associated with the account activity, such as 'Pending', 'Completed', or 'Overdue'. |
Lists credit memo applications tied to customer account activities, enabling partial or full offset of outstanding transactions.
| Name | Type | Description |
| ReceivablesCustomerAccountActivitiesAccountId [KEY] | Long | The unique identifier for the customer account associated with the credit memo application, used to track the account in receivables. |
| ApplicationId [KEY] | Long | The unique identifier for the credit memo application, used to reference the specific application of a credit memo to an account. |
| ApplicationDate | Date | The date when the credit memo application was processed or applied to the customer's account. |
| ApplicationAmount | Decimal | The monetary amount of the credit memo being applied to the account, reflecting the amount credited to the customer. |
| ApplicationStatus | String | The status of the credit memo application, such as 'Pending', 'Applied', or 'Cancelled', indicating the current state of the application. |
| ReferenceInstallmentId | Long | The unique identifier for the installment associated with the credit memo application, if applicable. |
| ReferenceTransactionNumber | String | The reference number of the transaction linked to the credit memo application, providing a way to track the original transaction. |
| ReferenceTransactionId | Long | The unique identifier for the transaction associated with the credit memo application, allowing for linkage between the credit memo and the transaction. |
| AccountingDate | Date | The accounting date assigned to the credit memo application, indicating when the application is recorded in the accounting system. |
| CreditMemoId | Long | The unique identifier for the credit memo associated with the application, allowing for tracking and management of credit memos. |
| CreditMemoNumber | String | The number assigned to the credit memo, used for referencing the specific credit memo document. |
| CreditMemoStatus | String | The status of the credit memo, such as 'Approved', 'Pending', or 'Applied', providing information on the current state of the credit memo. |
| EnteredCurrency | String | The currency code in which the credit memo is entered, reflecting the currency used for the transaction. |
| TransactionType | String | The type of transaction associated with the credit memo application, such as 'Adjustment', 'Refund', or 'Payment'. |
| ActivityName | String | The name of the activity associated with the credit memo application, providing context to the action performed. |
| IsLatestApplication | String | Indicates whether this credit memo application is the most recent application for the account, useful for tracking the latest updates. |
| CreationDate | Datetime | The date and time when the credit memo application record was created, helping track the creation of the application. |
| CreatedBy | String | The user or system that created the credit memo application record, providing accountability for record creation. |
| LastUpdateDate | Datetime | The date and time when the credit memo application record was last updated, useful for tracking changes to the record. |
| LastUpdatedBy | String | The user or system that last updated the credit memo application record, providing visibility into modifications. |
| BillToSiteNumber | String | The site number of the customer’s billing address associated with the credit memo application. |
| ReferenceTransactionStatus | String | The status of the reference transaction, providing information on the state of the transaction being referenced in the credit memo application. |
| AccountId | Long | The unique identifier for the account linked to the credit memo application, used for tracking customer account activities. |
| AccountNumber | String | The account number associated with the credit memo application, allowing for quick identification of the customer’s account. |
| CustomerName | String | The name of the customer whose account is being credited, providing identification of the account holder. |
| Finder | String | A search term used to locate specific credit memo application records based on the attributes or details provided. |
| TaxpayerIdentificationNumber | String | The Tax Indentification Number (TIN) associated with the customer or transaction, used for tax reporting and compliance purposes. |
| TaxRegistrationNumber | String | The tax registration number associated with the customer, used for tax identification in accordance with tax authorities. |
| TransactionLimitByDays | Int | The maximum limit, in days, within which a transaction can be processed, typically used to define credit limits or payment terms. |
| TransactionStatus | String | The current status of the transaction associated with the credit memo application, such as 'Completed', 'Pending', or 'Cancelled'. |
Supports descriptive flexfields for credit memo applications, storing additional data during the application process.
| Name | Type | Description |
| ReceivablesCustomerAccountActivitiesAccountId [KEY] | Long | The unique identifier for the customer account associated with the credit memo application in the ReceivablesCustomerAccountActivities table, used to track account activities. |
| CreditmemoapplicationsApplicationId [KEY] | Long | The unique identifier for the credit memo application in the ReceivablesCustomerAccountActivitiescreditMemoApplications table, used to reference specific applications of credit memos. |
| ReceivableApplicationId [KEY] | Long | The identifier for the receivable application, used to track the application of receivables to the customer’s account. |
| _FLEX_Context | String | The context value for the descriptive flexfield (DFF) in the ReceivablesCustomerAccountActivitiescreditMemoApplicationscreditMemoApplicationDFF table, defining the specific context in which the data is used. |
| _FLEX_Context_DisplayValue | String | The display value for the flexfield context, offering a user-friendly version of the context value to help understand its meaning. |
| AccountId | Long | The unique identifier for the account in the ReceivablesCustomerAccountActivitiescreditMemoApplicationscreditMemoApplicationDFF table, linking the credit memo application to the specific account. |
| AccountNumber | String | The account number for the customer in the ReceivablesCustomerAccountActivitiescreditMemoApplicationscreditMemoApplicationDFF table, used for identification and tracking of account transactions. |
| CustomerName | String | The name of the customer associated with the credit memo application, providing clear identification of the account holder for the application. |
| Finder | String | A search term used to locate specific credit memo application records, typically used within the system for querying and filtering data. |
| TaxpayerIdentificationNumber | String | The Tax Indentification Number (TIN) assigned to the customer for tax purposes, used for legal and compliance reporting. |
| TaxRegistrationNumber | String | The tax registration number for the customer, required for tax identification in accordance with tax authorities’ regulations. |
| TransactionLimitByDays | Int | The maximum allowable days limit within which a transaction can be processed, typically used to set payment terms or credit limits. |
| TransactionStatus | String | The status of the credit memo application transaction, such as 'Pending', 'Completed', or 'Cancelled', reflecting the current state of the application. |
Displays credit memos issued to a customer’s account, including on-account memos and standard credit memos.
| Name | Type | Description |
| ReceivablesCustomerAccountActivitiesAccountId [KEY] | Long | The unique identifier for the customer account in the ReceivablesCustomerAccountActivitiescreditMemos table, used to associate credit memo activities with a specific account. |
| CreditMemoId [KEY] | Long | The unique identifier of the credit memo in the ReceivablesCustomerAccountActivitiescreditMemos table, used to track individual credit memo transactions. |
| CreditMemoNumber | String | The unique number assigned to each credit memo, used for referencing and identifying specific credit memo transactions. |
| CreditMemoDate | Date | The date the credit memo was created or issued, representing when the credit memo became effective. |
| TransactionClass | String | The classification of the transaction, which could include various types of credit transactions, helping categorize the nature of the credit memo. |
| AccountingDate | Date | The accounting date associated with the credit memo, typically representing when the financial impact of the credit memo is recorded in the books. |
| PurchaseOrder | String | The purchase order number associated with the credit memo, linking the credit memo to a specific purchase order. |
| TotalOriginalAmount | Decimal | The original total amount of the credit memo before any adjustments or payments have been applied. |
| TotalBalanceAmount | Decimal | The remaining balance amount of the credit memo, reflecting the amount still available for application after any adjustments. |
| AvailableAmount | Decimal | The amount of the credit memo that is still available for future applications or allocations to other transactions. |
| TransactionType | String | The type of the transaction, such as credit, refund, or adjustment, used to specify the nature of the credit memo activity. |
| InstallmentId | Long | The unique identifier for the installment associated with the credit memo, used to track partial payments or installment-based credit memo applications. |
| CreditMemoCurrency | String | The currency code in which the credit memo is issued, indicating the currency used for the credit memo transaction. |
| CreditMemoStatus | String | The status of the credit memo, such as 'Open', 'Paid', or 'Cancelled', representing the current state of the credit memo in the system. |
| CreatedBy | String | The user who created the credit memo, providing a reference to the individual responsible for initiating the transaction. |
| CreationDate | Datetime | The date and time when the credit memo was created in the system, providing an audit trail for when the transaction was recorded. |
| LastUpdateDate | Datetime | The date and time when the credit memo was last updated, tracking any changes made to the original record. |
| LastUpdatedBy | String | The user who last updated the credit memo, offering accountability and tracking for changes made to the credit memo details. |
| BillToSiteNumber | String | The site number for the billing address associated with the credit memo, used for identifying where the credit memo applies. |
| AccountId | Long | The account identifier of the customer, linking the credit memo to the customer's account in the ReceivablesCustomerAccountActivitiescreditMemos table. |
| AccountNumber | String | The account number associated with the credit memo, used for identifying the customer’s account in the receivables system. |
| CustomerName | String | The name of the customer associated with the credit memo, providing clear identification of the customer receiving the credit. |
| Finder | String | A search term or reference used to locate specific credit memo records, typically used within the system for querying or filtering data. |
| TaxpayerIdentificationNumber | String | The Tax Indentification Number (TIN) of the customer, used for tax reporting and compliance purposes. |
| TaxRegistrationNumber | String | The tax registration number associated with the customer, used to identify them for tax and legal purposes in transactions. |
| TransactionLimitByDays | Int | The maximum number of days allowed for processing the credit memo transaction, typically used for managing payment terms and limits. |
| TransactionStatus | String | The current status of the credit memo transaction, such as 'Pending', 'Completed', or 'Closed', indicating where the credit memo stands in the process. |
Lists standard receipt applications for a customer’s account activities, showing how receipts are allocated to open items.
| Name | Type | Description |
| ReceivablesCustomerAccountActivitiesAccountId [KEY] | Long | The unique identifier for the customer account in the ReceivablesCustomerAccountActivitiesstandardReceiptApplications table, used to associate receipt activities with a specific customer account. |
| ApplicationId [KEY] | Long | The unique identifier for each receipt application, used to track individual receipts and their applications to customer accounts. |
| ApplicationDate | Date | The date when the receipt application was processed or recorded, representing when the payment was applied to the customer account. |
| ApplicationAmount | Decimal | The amount of the receipt applied to the customer account, representing the value of the payment made by the customer. |
| ApplicationStatus | String | The current status of the receipt application, indicating whether it is 'Pending', 'Completed', or 'Failed', and helping track the progress of the payment application. |
| AccountingDate | Date | The date on which the receipt is recorded in the accounting system, reflecting the financial posting date for the receipt. |
| ReferenceInstallmentId | Long | The unique identifier for the installment referenced by the receipt application, indicating which installment the payment is applied to. |
| ReferenceTransactionNumber | String | The number of the reference transaction associated with the receipt application, used to link the payment to the transaction being settled. |
| ReferenceTransactionId | Long | The unique identifier of the reference transaction associated with the receipt, used to track which transaction the receipt application pertains to. |
| ActivityName | String | The name or description of the activity related to the receipt application, used for categorizing the type of transaction or action. |
| StandardReceiptId | Long | The unique identifier for the standard receipt record, linking the receipt application to the receipt document. |
| ReceiptNumber | String | The unique receipt number assigned to the payment, used for identification and reference in financial reporting and transaction tracking. |
| EnteredCurrency | String | The currency code in which the receipt is entered, indicating the currency in which the payment was made. |
| ReceiptMethod | String | The method by which the receipt was made, such as cash, cheque, or bank transfer, indicating how the customer paid. |
| ProcessStatus | String | The status of the receipt application processing, indicating whether it is 'Processed', 'Pending', or 'Failed'. |
| IsLatestApplication | String | A flag indicating whether the current receipt application is the most recent application for the account or transaction. |
| CreatedBy | String | The user who created the receipt application record, providing accountability and auditability for the receipt process. |
| CreationDate | Datetime | The date and time when the receipt application record was created in the system. |
| LastUpdateDate | Datetime | The date and time when the receipt application record was last updated, providing tracking for changes to the record. |
| LastUpdatedBy | String | The user who last updated the receipt application record, allowing for audit tracking of modifications. |
| CustomerSite | String | The customer site associated with the receipt application, used to specify the location or site for the customer involved in the transaction. |
| ReferenceTransactionStatus | String | The status of the reference transaction associated with the receipt application, indicating whether the referenced transaction is paid, partially paid, or outstanding. |
| AccountId | Long | The account identifier for the customer account, used to link the receipt application to the customer’s account in the receivables system. |
| AccountNumber | String | The account number associated with the customer’s account in the receivables system, providing a reference for the customer’s financial transactions. |
| CustomerName | String | The name of the customer associated with the receipt application, used for identifying the customer making the payment. |
| Finder | String | A search term or reference used to locate specific receipt application records in the system. |
| TaxpayerIdentificationNumber | String | The Tax Indentification Number (TIN) associated with the customer, used for tax reporting and compliance purposes. |
| TaxRegistrationNumber | String | The tax registration number associated with the customer, used to identify them for tax purposes and in accordance with local tax regulations. |
| TransactionLimitByDays | Int | The maximum number of days allowed for processing a receipt application, used for managing payment terms and limits for the transaction. |
| TransactionStatus | String | The status of the receipt application transaction, indicating whether it is 'Successful', 'Failed', or 'Pending', and reflecting the completion status of the receipt process. |
Enables custom descriptive flexfields for standard receipt applications, capturing extra data or references.
| Name | Type | Description |
| ReceivablesCustomerAccountActivitiesAccountId [KEY] | Long | The unique identifier of the customer account in the ReceivablesCustomerAccountActivitiesstandardReceiptApplicationsstandardReceiptApplicationDFF table, used to associate receipt applications with specific customer accounts. |
| StandardreceiptapplicationsApplicationId [KEY] | Long | The unique identifier for each receipt application in the standard receipt applications table, used to track and manage the individual applications of customer payments. |
| ReceivableApplicationId [KEY] | Long | The unique identifier for the receivable application, linking the payment application to the corresponding receivable transaction or account. |
| _FLEX_Context | String | The context of the descriptive flexfield (DFF) for the receipt application, capturing the specific business context in which the receipt application operates. |
| _FLEX_Context_DisplayValue | String | The display value of the descriptive flexfield context, providing a human-readable representation of the DFF context for easier interpretation in reports and forms. |
| AccountId | Long | The account identifier for the customer, linking the receipt application to the appropriate customer account in the receivables system. |
| AccountNumber | String | The account number associated with the customer's account, used for identification and tracking of customer financial transactions. |
| CustomerName | String | The name of the customer associated with the receipt application, used to identify the customer making the payment. |
| Finder | String | A search term or reference used to locate specific receipt application records within the system, facilitating easy retrieval of information. |
| TaxpayerIdentificationNumber | String | The Tax Indentification Number (TIN) associated with the customer, used for tax reporting and compliance purposes. |
| TaxRegistrationNumber | String | The tax registration number for the customer, used for identifying them in accordance with local tax laws and regulations. |
| TransactionLimitByDays | Int | The maximum number of days allowed for processing a receipt application, used to manage payment terms and define time limits for transaction completion. |
| TransactionStatus | String | The status of the receipt application transaction, indicating whether it is 'Completed', 'Pending', 'Failed', or in another state, reflecting the progress of the application process. |
Shows standard receipts recorded for a customer’s account, reflecting payments received for goods or services.
| Name | Type | Description |
| ReceivablesCustomerAccountActivitiesAccountId [KEY] | Long | The unique identifier of the customer account in the ReceivablesCustomerAccountActivitiesstandardReceipts table, used to link receipt records with specific customer accounts. |
| StandardReceiptId [KEY] | Long | The unique identifier for each standard receipt, used to track and manage the individual receipts that apply to customer transactions. |
| ReceiptNumber | String | The number assigned to the receipt for identification and tracking purposes, ensuring that receipts can be easily referenced. |
| BusinessUnit | String | The business unit responsible for processing the receipt, typically used to organize and categorize receipts based on the organizational structure. |
| LegalEntity | String | The legal entity under which the receipt is processed, used to distinguish between different business entities within an organization. |
| ReceiptDate | Date | The date when the receipt was issued or received, used for recording the timing of payment and financial transaction. |
| AccountingDate | Date | The accounting date associated with the receipt, used for determining when the receipt is recognized in the financial records. |
| UnappliedAmount | Decimal | The amount of the receipt that has not yet been applied to any specific transaction or account balance. |
| AvailableAmount | Decimal | The amount of the receipt that is available for application against outstanding transactions or balances. |
| ReceiptMethod | String | The method used to process the receipt, such as cash, check, credit card, or electronic transfer. |
| ProcessStatus | String | The current status of the receipt in the processing workflow, indicating whether the receipt is completed, pending, or requires further action. |
| State | String | The state of the receipt, reflecting its current condition in the system, such as 'New', 'Pending', or 'Applied'. |
| Currency | String | The currency used for the receipt transaction, indicating the denomination in which the payment was made. |
| Amount | Decimal | The total amount of the receipt, reflecting the total payment made by the customer. |
| DocumentNumber | Long | The unique document number associated with the receipt, used for tracking and reference in accounting and transaction systems. |
| CreatedBy | String | The user who created the receipt record in the system, used for tracking the source of data entry. |
| CreationDate | Datetime | The date and time when the receipt record was created in the system. |
| LastUpdateDate | Datetime | The date and time when the receipt record was last updated in the system. |
| LastUpdatedBy | String | The user who last updated the receipt record, helping track modifications or changes to the receipt information. |
| CustomerSite | String | The customer site associated with the receipt, used to specify the location where the transaction occurred or where payment is applied. |
| AccountId | Long | The unique identifier for the customer account to which the receipt is applied, helping link receipts to customer-specific records. |
| AccountNumber | String | The account number for the customer account, used to uniquely identify the customer’s account for receipt and payment application. |
| CustomerName | String | The name of the customer associated with the receipt, used for identifying the paying party. |
| Finder | String | A search term or reference that helps locate specific receipt records within the system, improving data retrieval and reporting. |
| TaxpayerIdentificationNumber | String | The Tax Indentification Number (TIN) of the customer, used for tax reporting and compliance purposes. |
| TaxRegistrationNumber | String | The tax registration number of the customer, required for legal and tax reporting in certain jurisdictions. |
| TransactionLimitByDays | Int | The maximum number of days allowed for processing a receipt transaction, used to enforce time-based transaction limits. |
| TransactionStatus | String | The status of the transaction associated with the receipt, indicating whether it is 'Pending', 'Completed', 'Failed', or in another state. |
Details any adjustments (increases or decreases) applied to a customer’s transactions, reflecting corrections or policy updates.
| Name | Type | Description |
| ReceivablesCustomerAccountActivitiesAccountId [KEY] | Long | The unique identifier for the customer account, linking the transaction adjustment to a specific account in the ReceivablesCustomerAccountActivities transaction adjustments table. |
| AdjustmentId [KEY] | Long | The unique identifier for the adjustment, used to track and manage individual transaction adjustments applied to a customer account. |
| AdjustmentNumber | String | A unique number assigned to each transaction adjustment for tracking and reference purposes within the accounting system. |
| AdjustmentAmount | Decimal | The total amount of the adjustment applied to the customer account, either increasing or decreasing the balance. |
| ApplicationDate | Date | The date when the adjustment was applied to the customer account, indicating when the financial change took place. |
| AccountingDate | Date | The date when the adjustment is recognized for accounting purposes, typically aligning with the posting date for financial reporting. |
| ProcessStatus | String | The current status of the adjustment in the process flow, such as 'Pending', 'Applied', or 'Rejected'. |
| EnteredCurrency | String | The currency used for the adjustment, reflecting the currency in which the transaction was originally recorded. |
| AdjustmentType | String | The type of adjustment being made, such as 'Credit', 'Debit', or other category defined by business rules. |
| AdjustmentReason | String | The reason for making the adjustment, helping to provide context for the financial modification. |
| ReferenceTransactionNumber | String | The transaction number of the original transaction to which the adjustment is applied, used for reference and auditing purposes. |
| ReferenceTransactionId | Long | The unique identifier for the transaction referenced by the adjustment, linking the adjustment to its original transaction. |
| ReferenceInstallmentId | Long | The unique identifier for the installment related to the adjustment, used to track partial payments or installment-based adjustments. |
| LastUpdateDate | Datetime | The date and time when the adjustment was last updated in the system, used to track changes or corrections to the adjustment record. |
| LastUpdatedBy | String | The user who last updated the adjustment record, providing accountability for changes made to the transaction. |
| CreatedBy | String | The user who initially created the adjustment record, providing accountability for the creation of the adjustment. |
| CreationDate | Datetime | The date and time when the adjustment record was created, used to track the historical context of the adjustment. |
| BillToSiteNumber | String | The site number for the billing address associated with the adjustment, helping to identify the location of the customer making the adjustment. |
| ReferenceTransactionStatus | String | The status of the referenced transaction, indicating whether the original transaction is 'Paid', 'Unpaid', or in another state. |
| AccountId | Long | The unique identifier for the account to which the adjustment is applied, linking the adjustment to a specific customer account. |
| AccountNumber | String | The account number for the customer account receiving the adjustment, helping to identify the correct account for processing. |
| CustomerName | String | The name of the customer associated with the adjustment, used to identify the party making or receiving the adjustment. |
| Finder | String | A search term or reference that helps locate specific adjustment records in the system for reporting or management purposes. |
| TaxpayerIdentificationNumber | String | The Tax Identification Number (TIN) associated with the customer, used for tax reporting and compliance. |
| TaxRegistrationNumber | String | The tax registration number of the customer, important for legal and tax reporting in certain jurisdictions. |
| TransactionLimitByDays | Int | The maximum number of days allowed for processing adjustments on a specific transaction, used to enforce time-based rules for financial transactions. |
| TransactionStatus | String | The status of the transaction adjustment, indicating whether it is 'Completed', 'Pending', or 'Rejected'. |
Tracks payment schedules (for example, installments) for a customer’s transactions, ensuring consistent collections and visibility.
| Name | Type | Description |
| ReceivablesCustomerAccountActivitiesAccountId [KEY] | Long | The unique identifier for the customer account linked to the transaction payment schedule, used to track payments and their associated accounts. |
| InstallmentId [KEY] | Long | The unique identifier for each installment in the payment schedule, allowing for individual tracking of scheduled payments. |
| InstallmentNumber | Long | The sequential number assigned to each installment in the payment schedule, indicating its order in the payment plan. |
| TotalOriginalAmount | Decimal | The original amount due for the installment before any adjustments, discounts, or partial payments. |
| TotalBalanceAmount | Decimal | The remaining balance for the installment that is still due for payment, accounting for any partial payments made. |
| PaymentDaysLate | Int | The number of days that the payment is late, used to assess whether any penalties or interest should be applied. |
| InstallmentStatus | String | The current status of the installment, such as 'Pending', 'Paid', or 'Overdue', indicating the payment's progress. |
| TransactionNumber | String | A unique reference number assigned to the transaction associated with the installment, used for tracking and reporting. |
| TransactionId | Long | The unique identifier for the transaction related to the installment, linking it to a specific financial entry. |
| TransactionDate | Date | The date when the transaction was recorded, providing context for the installment's timing. |
| TransactionClass | String | The classification of the transaction, used to group similar types of financial activities for accounting purposes. |
| PaymentScheduleDueDate | Date | The date by which the payment for the installment is due, helping to track deadlines and ensure timely payments. |
| AccountingDate | Date | The date when the transaction is recorded in the system for accounting purposes, used to align with financial periods. |
| PurchaseOrder | String | The purchase order number associated with the transaction, often used in business processes to match payments to specific orders. |
| TransactionType | String | The type of transaction, such as 'Payment', 'Refund', or 'Adjustment', providing context for the financial event. |
| ReceiptMethod | String | The method used to receive payment, such as 'Check', 'Wire Transfer', or 'Credit Card', indicating how the installment was paid. |
| EnteredCurrency | String | The currency in which the transaction was originally entered, ensuring accurate currency conversion and reporting. |
| TransactionSourceName | String | The name of the source system or origin of the transaction, such as 'Order Entry' or 'Payment Gateway'. |
| StructuredPaymentReference | String | A reference used for structured payments, which may include specific formatting or identifiers for tracking purposes. |
| CreatedBy | String | The user who created the payment schedule record, ensuring accountability for the initial entry. |
| CreationDate | Datetime | The date and time when the payment schedule record was created, used for auditing and tracking record creation. |
| LastUpdateDate | Datetime | The date and time when the payment schedule record was last updated, providing a history of changes made. |
| LastUpdatedBy | String | The user who last updated the payment schedule record, providing accountability for modifications. |
| BillToSiteNumber | String | The site number for the bill-to location associated with the customer, indicating where invoices are directed. |
| AccountId | Long | The unique identifier for the account associated with the payment schedule, allowing for easy lookup and tracking. |
| AccountNumber | String | The account number for the customer receiving the payment schedule, used for identification and reporting. |
| CustomerName | String | The name of the customer associated with the payment schedule, used to identify the party responsible for the payments. |
| Finder | String | A reference or search term that helps locate the specific transaction payment schedule in the system for reporting or management. |
| TaxpayerIdentificationNumber | String | The Tax Indentification Number (TIN) associated with the customer, used for tax reporting and compliance. |
| TaxRegistrationNumber | String | The tax registration number of the customer, important for legal and tax reporting in certain jurisdictions. |
| TransactionLimitByDays | Int | The maximum number of days allowed for processing payments in the payment schedule, used to enforce time-based rules for transactions. |
| TransactionStatus | String | The status of the transaction, such as 'Completed', 'Pending', or 'Canceled', indicating the payment's processing state. |
Highlights instances where a different customer remits payment on behalf of the primary customer’s outstanding transactions.
| Name | Type | Description |
| ReceivablesCustomerAccountActivitiesAccountId [KEY] | Long | The unique identifier for the customer account linked to transactions paid by other customers, allowing for accurate tracking of related transactions. |
| ApplicationId [KEY] | Long | The unique identifier of the application associated with the transaction, used to track how payments are applied to open balances. |
| ApplicationDate | Date | The date when the payment application was made, providing the timeline for how and when the payment was allocated. |
| ApplicationAmount | Decimal | The total amount of money applied to the customer account, reflecting how much of the payment was credited against outstanding balances. |
| ApplicationStatus | String | The status of the application, such as 'Pending', 'Applied', or 'Unapplied', indicating the current state of the payment. |
| AccountingDate | Date | The date when the payment is recorded in the system for accounting purposes, typically representing the date the payment was processed. |
| ReferenceInstallmentId | Long | The identifier of the installment related to the transaction, enabling the linkage of payments to specific installments. |
| ReferenceTransactionNumber | String | The reference number of the original transaction being paid, helping to tie the payment to the corresponding transaction. |
| ReferenceTransactionId | Long | The unique identifier of the transaction being settled by the payment, used for detailed tracking and reconciliation. |
| StandardReceiptId | Long | The unique identifier of the receipt generated for the payment, allowing for easy reference to the corresponding receipt. |
| ReceiptNumber | String | The unique number assigned to the receipt, used for identification and to track the payment transaction in the system. |
| EnteredCurrency | String | The currency in which the payment was originally entered, ensuring accurate currency handling and conversion. |
| ReceiptMethod | String | The method used to make the payment, such as 'Check', 'Wire Transfer', or 'Credit Card', indicating the form of payment. |
| ProcessStatus | String | The status of the payment processing, such as 'Completed', 'Pending', or 'Failed', providing insight into the transaction's processing state. |
| IsLatestApplication | String | Indicates whether this is the latest payment application, helping to track the most recent transaction activity on the account. |
| CreatedBy | String | The user who created the payment application record, providing accountability for the entry of payment data. |
| CreationDate | Datetime | The date and time when the payment application record was created, serving as a reference point for the timing of payment activities. |
| LastUpdateDate | Datetime | The date and time when the payment application record was last updated, providing a history of modifications. |
| LastUpdatedBy | String | The user who last updated the payment application record, ensuring accountability for any changes made. |
| ReferenceTransactionStatus | String | The status of the referenced transaction, providing information on whether the transaction being paid is open, closed, or pending. |
| AccountId | Long | The unique identifier for the account associated with the transaction, helping to link payment applications to customer accounts. |
| AccountNumber | String | The account number associated with the payment, used for identification and tracking of customer financial transactions. |
| CustomerName | String | The name of the customer linked to the payment, helping to identify which customer account the payment is being applied to. |
| Finder | String | A reference or search term used to help locate specific payment application records, improving efficiency in transaction management. |
| TaxpayerIdentificationNumber | String | The Tax Indentification Number (TIN) of the customer, used for tax reporting and compliance purposes. |
| TaxRegistrationNumber | String | The tax registration number of the customer, required for certain tax filings and reporting. |
| TransactionLimitByDays | Int | The maximum number of days allowed for processing the payment application, enforcing time constraints for payment processing. |
| TransactionStatus | String | The status of the transaction related to the payment, such as 'Pending', 'Completed', or 'Failed', indicating the current state of the transaction. |
Presents activities linked to both the customer account and the specific billing site, providing a unified transaction overview.
| Name | Type | Description |
| BillToSiteUseId [KEY] | Long | The unique identifier for the bill-to site use associated with the customer account, allowing tracking of which sites are used for billing purposes. |
| BillToSiteNumber | String | The site number associated with the bill-to address for the customer account, helping to identify the location where the billing is managed. |
| BillToSiteAddress | String | The physical address of the bill-to site, providing the necessary location details for invoicing and correspondence. |
| AccountNumber | String | The account number associated with the customer, used for identification and tracking of financial transactions linked to the customer. |
| AccountId | Long | The unique identifier of the customer account, linking financial data and activities to the specific account. |
| CustomerName | String | The name of the customer associated with the account, used for identifying and managing the customer relationship. |
| CustomerId | Long | The unique identifier of the customer, providing a reference for all customer-related activities and transactions. |
| TaxRegistrationNumber | String | The tax registration number of the customer, required for tax reporting and compliance with tax regulations. |
| TaxpayerIdentificationNumber | String | The Tax Indentification Number (TIN) of the customer, essential for tax filings and ensuring tax compliance. |
| TotalOpenReceivablesForSite | Decimal | The total amount of receivables that remain open and unpaid for the specific bill-to site, representing outstanding balances. |
| TotalTransactionsDueForSite | Decimal | The total value of transactions due for the bill-to site, reflecting the full amount of current obligations. |
| CreatedBy | String | The user who created the record for the bill-to site activities, ensuring accountability for data entry. |
| CreationDate | Datetime | The date and time when the bill-to site activities record was created, providing context for when the data was first recorded. |
| LastUpdateDate | Datetime | The date and time when the record for bill-to site activities was last updated, showing the most recent change. |
| LastUpdatedBy | String | The user who last updated the record, ensuring accountability for subsequent changes made to the bill-to site activity data. |
| Finder | String | A search term or identifier used to locate specific records of bill-to site activities, helping with quick data retrieval. |
| TransactionLimitByDays | Int | The maximum number of days allowed for processing transactions related to the bill-to site, defining a time frame for transaction management. |
| TransactionStatus | String | The status of transactions associated with the bill-to site, such as 'Pending', 'Completed', or 'Failed', indicating the current state of transactions. |
Lists credit memo applications for site-level transactions, allowing offsets or adjustments to outstanding amounts at the site.
| Name | Type | Description |
| ReceivablesCustomerAccountSiteActivitiesBillToSiteUseId [KEY] | Long | The unique identifier for the bill-to site use in the customer account, indicating how the site is utilized for billing and credit memo applications. |
| ApplicationId [KEY] | Long | The unique identifier for the credit memo application, used to reference and track the application of credit memos to customer accounts. |
| ApplicationDate | Date | The date when the credit memo application is recorded, providing a timestamp for when the application took place. |
| ApplicationAmount | Decimal | The amount of the credit memo applied to the customer's account, reflecting the monetary value of the credit memo allocation. |
| ApplicationStatus | String | The current status of the credit memo application, such as 'Pending', 'Completed', or 'Failed', indicating whether the application process was successful. |
| ReferenceInstallmentId | Long | The unique identifier for the installment associated with the reference transaction, used to link the credit memo application to a specific installment. |
| ReferenceTransactionNumber | String | The transaction number of the reference transaction to which the credit memo is applied, helping to link the credit memo with the originating transaction. |
| ReferenceTransactionId | Long | The unique identifier for the reference transaction related to the credit memo application, used for precise tracking and reconciliation. |
| AccountingDate | Date | The date assigned to the credit memo application for accounting purposes, ensuring accurate financial reporting and reconciliation. |
| CreditMemoId | Long | The unique identifier for the credit memo being applied, used to track the specific credit memo involved in the application process. |
| CreditMemoNumber | String | The number assigned to the credit memo, typically used for identification and tracking in reporting and reconciliation. |
| CreditMemoStatus | String | The status of the credit memo application, such as 'Approved', 'Pending', or 'Rejected', indicating the current state of the credit memo. |
| EnteredCurrency | String | The currency in which the credit memo application is entered, essential for handling multi-currency transactions and conversions. |
| TransactionType | String | The type of transaction being applied, indicating whether the application is related to a specific type of customer transaction (for example, payment, charge, adjustment). |
| ActivityName | String | The name or description of the activity being recorded, such as 'Credit Memo Application' or similar terms. |
| IsLatestApplication | String | Indicates whether this application is the most recent credit memo application for the customer account. Values typically are 'Yes' or 'No'. |
| CreationDate | Datetime | The date and time when the credit memo application record was created, providing an audit trail for when the action took place. |
| CreatedBy | String | The user who created the credit memo application record, ensuring accountability and traceability of the action. |
| LastUpdateDate | Datetime | The date and time when the credit memo application record was last updated, providing a history of modifications made to the record. |
| LastUpdatedBy | String | The user who last updated the credit memo application record, ensuring accountability for changes made after the original creation. |
| BillToSiteNumber | String | The number identifying the bill-to site where the credit memo application is being processed, providing location-specific information for billing. |
| ReferenceTransactionStatus | String | The status of the reference transaction, such as 'Paid', 'Unpaid', or 'Partially Paid', indicating the state of the transaction being referenced. |
| AccountNumber | String | The account number of the customer to which the credit memo is applied, helping to identify the specific customer account. |
| BillToSiteUseId | Long | The unique identifier for the bill-to site use in the customer account, linking the site use to the credit memo application. |
| CustomerName | String | The name of the customer associated with the credit memo application, providing customer-specific information for transaction tracking. |
| Finder | String | A search term or identifier used to locate the specific credit memo application record, enhancing data retrieval capabilities. |
| TaxpayerIdentificationNumber | String | The Tax Indentification Number (TIN) of the customer, essential for tax reporting and compliance purposes. |
| TaxRegistrationNumber | String | The tax registration number of the customer, used for regulatory and tax purposes to identify the customer's tax obligations. |
| TransactionLimitByDays | Int | The maximum number of days allowed for processing the transaction related to the credit memo application, defining the time frame for transaction validity. |
| TransactionStatus | String | The status of the transaction associated with the credit memo application, such as 'Completed', 'Pending', or 'Failed', providing insight into the transaction's progress. |
Supports custom descriptive flexfields for credit memo applications at the account site level, capturing specialized data.
| Name | Type | Description |
| ReceivablesCustomerAccountSiteActivitiesBillToSiteUseId [KEY] | Long | The unique identifier for the bill-to site use in the customer account, indicating how the site is utilized for billing and credit memo applications. It helps link the site use to the credit memo application record. |
| CreditmemoapplicationsApplicationId [KEY] | Long | The unique identifier for the credit memo application. This field helps track and manage the credit memo application against the customer account and transactions. |
| ReceivableApplicationId [KEY] | Long | The unique identifier of the receivable application associated with the credit memo application, used to link credit memo applications with the receivable records. |
| _FLEX_Context | String | A context value for the flexible account context in Oracle systems. It provides additional configuration information for the credit memo application within the system. |
| _FLEX_Context_DisplayValue | String | The display value of the flexible context, offering a user-friendly representation of the context value for ease of use and interpretation. |
| AccountNumber | String | The account number of the customer to which the credit memo is applied. This is a unique identifier for the customer’s account in the receivables system. |
| BillToSiteNumber | String | The number identifying the bill-to site associated with the credit memo application. It is used to specify the billing location related to the credit memo transaction. |
| BillToSiteUseId | Long | The unique identifier for the bill-to site use, denoting how a specific bill-to site is utilized within the customer's account for billing purposes. |
| CustomerName | String | The name of the customer associated with the credit memo application, used to identify the customer involved in the transaction. |
| Finder | String | A search term or key that helps locate and retrieve specific credit memo application records based on certain criteria or keywords. |
| TaxpayerIdentificationNumber | String | The Tax Indentification Number (TIN) of the customer, used for tax reporting and compliance purposes. It uniquely identifies the customer for tax matters. |
| TaxRegistrationNumber | String | The tax registration number of the customer, required for proper tax identification and reporting in regulatory systems. |
| TransactionLimitByDays | Int | The maximum allowed time (in days) for processing and completing the credit memo application transaction. This defines the time frame for the application validity. |
| TransactionStatus | String | The status of the credit memo application transaction. Possible values include 'Completed', 'Pending', or 'Failed', indicating the current state of the credit memo application process. |
Shows credit memos associated with the customer’s site, covering both standard and on-account credits.
| Name | Type | Description |
| ReceivablesCustomerAccountSiteActivitiesBillToSiteUseId [KEY] | Long | The unique identifier for the bill-to site use in the context of credit memo applications. It links the site to a specific use for billing purposes in the receivables system. |
| CreditMemoId [KEY] | Long | The unique identifier for the credit memo. This helps track and manage the credit memo within the receivables system, including adjustments, applications, and related transactions. |
| CreditMemoNumber | String | The number assigned to the credit memo for reference. This number is used to uniquely identify and track credit memo transactions within the system. |
| CreditMemoDate | Date | The date when the credit memo was issued. This date is used for record-keeping and determining the application of accounting policies, such as recognition of revenue. |
| TransactionClass | String | A classification that identifies the type of transaction represented by the credit memo. Examples may include 'Sales Credit' or 'Returns'. |
| AccountingDate | Date | The accounting date for the credit memo. This date is used for the posting of journal entries and reflects the financial period in which the credit memo should be recognized. |
| PurchaseOrder | String | The purchase order number associated with the credit memo. This links the credit memo to the specific order that it is crediting. |
| TotalOriginalAmount | Decimal | The total original amount of the credit memo before any adjustments or payments. This is used for calculating the credit impact on the customer’s account. |
| TotalBalanceAmount | Decimal | The balance remaining on the credit memo after payments or adjustments have been applied. |
| AvailableAmount | Decimal | The amount of the credit memo that is still available to be applied to transactions or invoices. This reflects the current status of the credit memo. |
| TransactionType | String | The type of transaction represented by the credit memo. This could include values like 'Credit' or 'Refund', which describe how the credit memo affects the customer’s account. |
| InstallmentId | Long | The identifier for the installment associated with the credit memo. This is used to track how the credit memo is applied over multiple payments or installments. |
| CreditMemoCurrency | String | The currency in which the credit memo is issued. This allows for multi-currency processing and ensures that the credit memo is correctly applied to customer transactions in the appropriate currency. |
| CreditMemoStatus | String | The current status of the credit memo, such as 'Open', 'Closed', or 'Pending'. This helps track the lifecycle of the credit memo in the receivables system. |
| CreatedBy | String | The name or identifier of the user who created the credit memo in the system. This information is used for audit purposes. |
| CreationDate | Datetime | The date and time when the credit memo was created in the system. |
| LastUpdateDate | Datetime | The date and time when the credit memo was last updated. This ensures that users can track any changes to the credit memo. |
| LastUpdatedBy | String | The name or identifier of the user who last updated the credit memo. |
| BillToSiteNumber | String | The unique number identifying the bill-to site where the credit memo is applied. This helps track which location or department within the customer organization is responsible for the credit. |
| AccountNumber | String | The customer’s account number associated with the credit memo. This uniquely identifies the customer in the receivables system. |
| BillToSiteUseId | Long | The identifier for the specific use of the bill-to site for the credit memo. This is used for tracking how a bill-to site is leveraged in customer account activities. |
| CustomerName | String | The name of the customer associated with the credit memo. This is used for identification and reporting purposes. |
| Finder | String | A search term used to locate and retrieve credit memo records based on specific criteria. |
| TaxpayerIdentificationNumber | String | The unique Tax Indentification Number (TIN) of the customer. This is required for tax reporting and compliance purposes. |
| TaxRegistrationNumber | String | The tax registration number of the customer. This is required for the customer’s tax records and reporting. |
| TransactionLimitByDays | Int | The time limit, in days, for processing the credit memo transaction. This defines how long the credit memo remains valid for applying to customer transactions. |
| TransactionStatus | String | The status of the credit memo transaction, indicating whether the transaction is 'Completed', 'Pending', or in any other state as per the system's workflow. |
Tracks standard receipt applications at the site level, mapping applied payments to site-specific invoices or transactions.
| Name | Type | Description |
| ReceivablesCustomerAccountSiteActivitiesBillToSiteUseId [KEY] | Long | The unique identifier for the bill-to site use in the context of standard receipt applications. This links a specific bill-to site to receipt activities. |
| ApplicationId [KEY] | Long | The unique identifier of the application of a standard receipt to a transaction or account. It is used to track and manage the application of customer payments. |
| ApplicationDate | Date | The date when the standard receipt application was made. This date is important for accounting and reporting purposes. |
| ApplicationAmount | Decimal | The amount applied to the transaction or account in the standard receipt application. It reflects the part of the receipt being allocated. |
| ApplicationStatus | String | The status of the receipt application, such as 'Applied', 'Pending', or 'Unapplied'. |
| AccountingDate | Date | The accounting date when the application is posted. This date is used for financial reporting and journal entries. |
| ReferenceInstallmentId | Long | The identifier for the installment associated with the receipt application. This links the application to specific installments for payment. |
| ReferenceTransactionNumber | String | The reference number of the transaction to which the receipt is applied. This helps in tracking and reconciling payment applications. |
| ReferenceTransactionId | Long | The identifier for the specific transaction to which the receipt is applied. It ensures that payments are linked to the correct transaction. |
| ActivityName | String | The name or description of the activity that triggered the receipt application, such as 'Payment', 'Adjustment', or 'Refund'. |
| StandardReceiptId | Long | The unique identifier for the standard receipt. This links the application to the specific receipt record. |
| ReceiptNumber | String | The receipt number associated with the standard receipt application. This is used for tracking and identifying the receipt in the system. |
| EnteredCurrency | String | The currency in which the receipt application was made. This ensures that transactions in different currencies are handled correctly. |
| ReceiptMethod | String | The method used to make the receipt payment, such as 'Cash', 'Check', or 'Wire Transfer'. |
| ProcessStatus | String | The status of the process for the receipt application, indicating whether it's in progress, completed, or pending further action. |
| IsLatestApplication | String | Indicates whether this application is the latest for the given transaction. This helps in identifying and tracking the most recent application. |
| CreatedBy | String | The name or ID of the user who created the receipt application. It is used for audit purposes. |
| CreationDate | Datetime | The date and time when the receipt application was created. This timestamp helps track when the application occurred. |
| LastUpdateDate | Datetime | The date and time when the receipt application was last updated. This helps track any changes or updates to the application. |
| LastUpdatedBy | String | The name or ID of the user who last updated the receipt application. It is used for audit purposes. |
| CustomerSite | String | The site number for the customer to which the receipt application is linked. This helps track which location is making the payment. |
| ReferenceTransactionStatus | String | The status of the reference transaction to which the receipt is applied. This could be 'Open', 'Closed', or 'In Progress'. |
| AccountNumber | String | The customer’s account number associated with the receipt application. This is used to track which customer made the payment. |
| BillToSiteNumber | String | The site number for the bill-to address where the receipt is applied. This helps track the billing location for the customer. |
| BillToSiteUseId | Long | The identifier for the use of the bill-to site in relation to the receipt application. It helps in linking the receipt application to the right billing location. |
| CustomerName | String | The name of the customer who made the payment. This is used to identify the payer in the system. |
| Finder | String | A search term used to locate and retrieve receipt application records based on specific criteria. |
| TaxpayerIdentificationNumber | String | The unique Tax Indentification Number (TIN) of the customer. This is used for tax reporting and compliance purposes. |
| TaxRegistrationNumber | String | The tax registration number of the customer. This number is required for tax-related activities and compliance. |
| TransactionLimitByDays | Int | The maximum number of days by which the receipt application can be processed based on the transaction policy. |
| TransactionStatus | String | The current status of the transaction, indicating whether it is 'Completed', 'Pending', or 'In Progress'. |
Holds custom descriptive flexfields for receipt applications at the account site level, capturing extra data for reporting or integrations.
| Name | Type | Description |
| ReceivablesCustomerAccountSiteActivitiesBillToSiteUseId [KEY] | Long | The unique identifier for the bill-to site use in the context of standard receipt applications. It links specific bill-to sites to receipt activities. |
| StandardreceiptapplicationsApplicationId [KEY] | Long | The unique identifier for the application of a standard receipt to a transaction or account, used to track and manage customer payment allocations. |
| ReceivableApplicationId [KEY] | Long | The identifier for the specific receivable application linked to the standard receipt application. It ensures that the receipt is applied to the correct receivable. |
| _FLEX_Context | String | A system-specific context identifier that links to flexible data structures. It is used for referencing business context in receipt applications. |
| _FLEX_Context_DisplayValue | String | The display value of the context referenced by the _FLEX_Context field. This provides a human-readable value for system context. |
| AccountNumber | String | The unique account number associated with the customer who made the receipt application. It is used for tracking payments within the system. |
| BillToSiteNumber | String | The site number associated with the bill-to address where the receipt is applied. This helps track and manage payments by customer site. |
| BillToSiteUseId | Long | The unique identifier for the use of the bill-to site in relation to the receipt application. It helps in linking receipt applications to the appropriate billing site. |
| CustomerName | String | The name of the customer associated with the receipt application. This helps identify the payer and ensures correct payment allocation. |
| Finder | String | A search term used to locate and retrieve standard receipt application records based on specific search criteria. |
| TaxpayerIdentificationNumber | String | The Tax Indentification Number (TIN) (TIN) of the customer, used for tax reporting and compliance purposes, especially in cross-border transactions. |
| TaxRegistrationNumber | String | The tax registration number of the customer, required for tax-related reporting and compliance purposes. |
| TransactionLimitByDays | Int | The maximum number of days by which a transaction can be processed for receipt application. It determines the payment due date and transaction limits. |
| TransactionStatus | String | The current status of the transaction, such as 'Completed', 'Pending', or 'In Progress'. This helps track the processing stage of the receipt application. |
Lists standard receipts managed at the account site, indicating payments received for site-specific transactions.
| Name | Type | Description |
| ReceivablesCustomerAccountSiteActivitiesBillToSiteUseId [KEY] | Long | The unique identifier for the bill-to site use in the context of standard receipts. It links receipt applications to the appropriate billing site. |
| StandardReceiptId [KEY] | Long | The unique identifier for each standard receipt, used for tracking and managing customer payments. |
| ReceiptNumber | String | The receipt number assigned to the standard receipt for easy reference and tracking in financial records. |
| BusinessUnit | String | The business unit under which the standard receipt is processed. This helps identify the organizational unit within the company handling the transaction. |
| LegalEntity | String | The legal entity responsible for processing the receipt, which is necessary for tax and financial reporting. |
| ReceiptDate | Date | The date when the receipt was issued, which typically corresponds to the date the payment was received. |
| AccountingDate | Date | The accounting date for the receipt, used for determining the period in which the receipt is recorded for accounting purposes. |
| UnappliedAmount | Decimal | The amount of the receipt that has not yet been applied to any transaction or account. |
| AvailableAmount | Decimal | The total amount of the receipt that is available to be applied to transactions or accounts. |
| ReceiptMethod | String | The method used for processing the receipt, such as cash, check, or electronic transfer. |
| ProcessStatus | String | The status of the receipt, which indicates whether it is in progress, completed, or pending. |
| State | String | The state or condition of the receipt, typically indicating its current phase in the payment process (for example, 'Received', 'Applied'). |
| Currency | String | The currency in which the receipt was made, important for managing multi-currency transactions. |
| Amount | Decimal | The total amount of the receipt. |
| DocumentNumber | Long | The document number associated with the receipt, which links the receipt to the corresponding financial document. |
| CreatedBy | String | The user or system that created the receipt record. |
| CreationDate | Datetime | The date and time when the receipt record was created in the system. |
| LastUpdateDate | Datetime | The date and time when the receipt record was last updated. |
| LastUpdatedBy | String | The user or system that last updated the receipt record. |
| CustomerSite | String | The customer site associated with the receipt, providing additional context about the location of the payer. |
| AccountNumber | String | The account number of the customer from which the receipt originated, used for tracking the payment in the system. |
| BillToSiteNumber | String | The number of the bill-to site associated with the receipt, used to determine the site of the customer being billed. |
| BillToSiteUseId | Long | The unique identifier for the use of the bill-to site in relation to the receipt. |
| CustomerName | String | The name of the customer who made the payment, used for customer identification and receipt tracking. |
| Finder | String | A search term or identifier used to locate and retrieve receipt records based on specific search criteria. |
| TaxpayerIdentificationNumber | String | The Tax Indentification Number (TIN) (TIN) of the customer, used for tax reporting and compliance purposes. |
| TaxRegistrationNumber | String | The tax registration number of the customer, required for tax reporting and compliance. |
| TransactionLimitByDays | Int | The maximum number of days by which the transaction can be processed for receipt application, impacting the due date and payment processing. |
| TransactionStatus | String | The status of the transaction related to the receipt, indicating its current state in the processing cycle. |
Tracks adjustments (credits, debits) to site-based transactions, ensuring accurate account records and resolving discrepancies.
| Name | Type | Description |
| ReceivablesCustomerAccountSiteActivitiesBillToSiteUseId [KEY] | Long | The unique identifier for the bill-to site use in the context of transaction adjustments, linking the adjustment to the appropriate billing site. |
| AdjustmentId [KEY] | Long | The unique identifier for each adjustment, used to track and manage adjustments made to customer transactions. |
| AdjustmentNumber | String | The number assigned to the adjustment for easy reference and tracking in financial records. |
| AdjustmentAmount | Decimal | The amount of the adjustment applied to the transaction. It can either increase or decrease the balance of a transaction. |
| ApplicationDate | Date | The date when the adjustment was applied to the transaction, typically corresponding to the date of the action. |
| AccountingDate | Date | The accounting date for the adjustment, which determines the accounting period in which the adjustment is recorded. |
| ProcessStatus | String | The status of the adjustment, indicating whether it has been processed, is in progress, or is pending. |
| EnteredCurrency | String | The currency in which the adjustment was made, relevant for multi-currency accounting. |
| AdjustmentType | String | The type of adjustment, which could be a credit, debit, or other types of adjustments, based on the nature of the transaction. |
| AdjustmentReason | String | The reason for the adjustment, describing the cause or justification for modifying the transaction amount. |
| ReferenceTransactionNumber | String | The number of the transaction to which the adjustment is linked, providing a reference for auditing and tracking. |
| ReferenceTransactionId | Long | The unique identifier of the transaction associated with the adjustment, linking it to the original transaction. |
| ReferenceInstallmentId | Long | The installment ID associated with the transaction being adjusted, relevant when the transaction is paid in installments. |
| LastUpdateDate | Datetime | The date and time when the adjustment record was last updated. |
| LastUpdatedBy | String | The user or system that last updated the adjustment record. |
| CreatedBy | String | The user or system that created the adjustment record. |
| CreationDate | Datetime | The date and time when the adjustment record was first created. |
| BillToSiteNumber | String | The number identifying the bill-to site associated with the adjustment. |
| ReferenceTransactionStatus | String | The status of the reference transaction, indicating whether it has been fully processed, partially applied, or is still pending. |
| AccountNumber | String | The account number of the customer to which the adjustment is applied, used for identifying the customer's account. |
| BillToSiteUseId | Long | The unique identifier for the use of the bill-to site in relation to the adjustment. |
| CustomerName | String | The name of the customer associated with the adjustment, providing context for customer-related accounting. |
| Finder | String | A search term or identifier used to locate and retrieve adjustment records based on specific search criteria. |
| TaxpayerIdentificationNumber | String | The Tax Indentification Number (TIN) (TIN) of the customer, used for tax reporting and compliance purposes. |
| TaxRegistrationNumber | String | The tax registration number of the customer, required for tax reporting and compliance. |
| TransactionLimitByDays | Int | The maximum number of days by which the transaction can be adjusted, affecting the due date and payment processing. |
| TransactionStatus | String | The status of the transaction related to the adjustment, indicating its current state in the processing cycle. |
Displays scheduled payments for site-level transactions (for example, installment plans), enhancing cash flow planning and visibility.
| Name | Type | Description |
| ReceivablesCustomerAccountSiteActivitiesBillToSiteUseId [KEY] | Long | The unique identifier for the bill-to site use in the context of transaction payment schedules, linking payment schedules to specific bill-to sites. |
| InstallmentId [KEY] | Long | The unique identifier for the installment of a transaction in the payment schedule, used to track individual installment payments. |
| InstallmentNumber | Long | The sequential number assigned to each installment in the payment schedule. |
| TotalOriginalAmount | Decimal | The original total amount for the transaction installment before any adjustments or payments are applied. |
| TotalBalanceAmount | Decimal | The remaining balance amount for the transaction installment, after applying any payments or adjustments. |
| PaymentDaysLate | Int | The number of days the payment is overdue for the transaction installment, helping to track delinquency. |
| InstallmentStatus | String | The status of the installment, which indicates whether it is pending, paid, or partially paid. |
| TransactionNumber | String | The unique identifier for the transaction associated with the payment schedule. |
| TransactionId | Long | The unique ID of the transaction, used for linking the payment schedule to a specific transaction. |
| TransactionDate | Date | The date when the transaction associated with the payment schedule was created. |
| TransactionClass | String | The classification of the transaction, providing context for categorizing the type of payment. |
| PaymentScheduleDueDate | Date | The due date for the payment schedule, indicating when payment is expected. |
| AccountingDate | Date | The accounting date associated with the payment schedule, representing the date on which the payment is recorded in the accounting system. |
| PurchaseOrder | String | The purchase order number associated with the transaction, providing additional context for the payment schedule. |
| TransactionType | String | The type of transaction related to the payment schedule, such as sale, refund, etc. |
| ReceiptMethod | String | The method used to make the payment for the transaction installment, such as cash, check, or bank transfer. |
| EnteredCurrency | String | The currency in which the transaction installment is entered, particularly relevant for multi-currency transactions. |
| TransactionSourceName | String | The name of the source system or process that generated the transaction, helping to trace the origin of the payment schedule. |
| StructuredPaymentReference | String | A unique identifier used to structure and track the payment reference for this transaction installment. |
| CreatedBy | String | The user or system responsible for creating the payment schedule record. |
| CreationDate | Datetime | The date and time when the payment schedule was first created. |
| LastUpdateDate | Datetime | The date and time when the payment schedule record was last updated. |
| LastUpdatedBy | String | The user or system responsible for the last update to the payment schedule. |
| BillToSiteNumber | String | The number identifying the bill-to site associated with the payment schedule, providing a link to the specific location. |
| AccountNumber | String | The account number for the customer associated with the payment schedule. |
| BillToSiteUseId | Long | The unique identifier for the use of the bill-to site in relation to the payment schedule. |
| CustomerName | String | The name of the customer for whom the payment schedule is created. |
| Finder | String | A search term or identifier used to locate and retrieve payment schedule records based on specific search criteria. |
| TaxpayerIdentificationNumber | String | The Tax Indentification Number (TIN) of the customer, relevant for tax reporting and compliance. |
| TaxRegistrationNumber | String | The tax registration number of the customer, required for tax reporting and compliance. |
| TransactionLimitByDays | Int | The maximum number of days allowed for the transaction payment, after which the payment may be considered overdue. |
| TransactionStatus | String | The status of the transaction related to the payment schedule, such as pending, completed, or overdue. |
Identifies cross-customer payments applied to site-related transactions, aiding reconciliation when a third party settles balances.
| Name | Type | Description |
| ReceivablesCustomerAccountSiteActivitiesBillToSiteUseId [KEY] | Long | The unique identifier linking the bill-to site use to the transaction paid by other customers, helping to associate the payment schedule with a specific site. |
| ApplicationId [KEY] | Long | The identifier for the payment application in the context of transactions paid by other customers. |
| ApplicationDate | Date | The date when the payment was applied to the transaction, marking the payment processing date. |
| ApplicationAmount | Decimal | The amount applied from the payment to the transaction, indicating how much was paid against the outstanding balance. |
| ApplicationStatus | String | The status of the payment application, such as 'completed', 'pending', or 'failed', reflecting the current state of the payment. |
| AccountingDate | Date | The accounting date when the transaction related to the payment is recognized in the financial system, often used for period-end reporting. |
| ReferenceInstallmentId | Long | The installment ID that links the payment to a specific installment of the transaction being paid. |
| ReferenceTransactionNumber | String | The reference number for the transaction being paid by another customer, used to trace the payment application back to its original transaction. |
| ReferenceTransactionId | Long | The unique identifier for the transaction that is being paid, allowing easy identification of the specific transaction. |
| StandardReceiptId | Long | The identifier of the standard receipt associated with the payment, useful for tracking and managing receipts in the system. |
| ReceiptNumber | String | The receipt number assigned to the payment transaction, providing a unique reference for the receipt in the accounting system. |
| EnteredCurrency | String | The currency in which the payment was entered, important for multi-currency transactions and conversions. |
| ReceiptMethod | String | The method used to make the payment, such as 'wire transfer', 'check', or 'credit card', indicating how the payment was made. |
| ProcessStatus | String | The current status of the payment processing, such as 'pending', 'processed', or 'failed', to track the lifecycle of the payment. |
| IsLatestApplication | String | Indicates whether this application is the most recent payment applied to the transaction, helping to identify the current state of the payment. |
| CreatedBy | String | The user or system that created the payment application, typically the responsible party or system generating the transaction. |
| CreationDate | Datetime | The date and time when the payment application was created, providing a timestamp for audit and tracking purposes. |
| LastUpdateDate | Datetime | The date and time when the payment application record was last updated, reflecting the most recent changes or actions taken. |
| LastUpdatedBy | String | The user or system responsible for the most recent update to the payment application, allowing for accountability in changes. |
| ReferenceTransactionStatus | String | The status of the reference transaction, such as 'open', 'paid', or 'closed', showing the payment's effect on the underlying transaction. |
| AccountNumber | String | The account number associated with the payment, helping to link the payment to the customer account. |
| BillToSiteNumber | String | The bill-to site number for the customer, specifying the site where the payment is applied and helping to track transactions at multiple customer locations. |
| BillToSiteUseId | Long | The identifier for the specific use of the bill-to site in the transaction, ensuring the payment is applied to the correct site. |
| CustomerName | String | The name of the customer whose transaction is being paid, useful for identifying the paying party. |
| Finder | String | A search term or keyword used to help locate the payment application in the system, aiding in quick retrieval of transaction details. |
| TaxpayerIdentificationNumber | String | The Tax Indentification Number (TIN) for the customer, necessary for tax reporting and compliance purposes. |
| TaxRegistrationNumber | String | The tax registration number for the customer, required for tax purposes and necessary in international transactions. |
| TransactionLimitByDays | Int | The maximum number of days allowed for the payment application to be processed, helping to track the timeliness of payments. |
| TransactionStatus | String | The status of the transaction being paid, such as 'pending', 'paid', or 'closed', indicating the state of the underlying transaction. |
Manages the supporting documents attached to a receivables invoice, ensuring compliance and clarity for invoice recipients.
| Name | Type | Description |
| ReceivablesInvoicesCustomerTransactionId [KEY] | Long | The unique identifier of the customer transaction associated with the invoice attachment. |
| AttachedDocumentId [KEY] | Long | A unique identifier assigned to a document that is attached to the invoice, allowing for easier reference and retrieval. |
| LastUpdateDate | Datetime | The most recent date and time when the invoice attachment was updated. This is useful for tracking changes over time. |
| LastUpdatedBy | String | The username of the person who last updated the invoice attachment, helping to identify who made recent changes. |
| DatatypeCode | String | A code representing the data type of the attachment. It indicates the format or structure of the file (for example, PDF, Word, etc.). |
| FileName | String | The name of the attachment file, typically reflecting the contents or purpose of the document. |
| DmFolderPath | String | The path where the attachment is stored within the document management system. This provides information on its location in the file system. |
| DmDocumentId | String | The unique identifier for the attachment within the document management system, ensuring proper linkage to the document. |
| DmVersionNumber | String | The version number of the document attached to the invoice, allowing for version control and ensuring the most recent version is accessed. |
| Url | String | The URL to access the attachment, typically used for online viewing or retrieval from an external system. |
| CategoryName | String | The category or type of the attachment (for example, 'Invoice', 'Contract', 'Payment Proof'), used for organizing documents. |
| UserName | String | The username of the person who uploaded or is associated with the attachment, useful for tracking ownership. |
| Uri | String | The Uniform Resource Identifier (URI) that uniquely identifies the attachment within the document management system. |
| FileUrl | String | The direct URL to the attachment file itself, used for downloading or viewing the file in its original format. |
| UploadedText | String | The text content of a newly uploaded attachment, useful for text-based attachments such as notes or messages. |
| UploadedFileContentType | String | The content type of the uploaded attachment, specifying its format. |
| UploadedFileLength | Long | The file size of the uploaded attachment, typically measured in bytes, helping to assess the file's impact on storage. |
| UploadedFileName | String | The name assigned to the uploaded attachment file, which can be different from the original file name. |
| ContentRepositoryFileShared | Bool | Indicates whether the attachment is shared within the document repository. A 'true' value means it is accessible by others. |
| Title | String | The title of the attachment, which is typically a brief description or label used to summarize the document's content. |
| Description | String | A more detailed description of the attachment, explaining its purpose, contents, or relevance to the invoice. |
| ErrorStatusCode | String | A code indicating the error, if any, associated with the attachment. This is used for error tracking and resolution. |
| ErrorStatusMessage | String | A message describing the error, providing more detail on why the attachment could not be processed or uploaded. |
| CreatedBy | String | The username of the individual who created or uploaded the attachment, important for tracking the source of the document. |
| CreationDate | Datetime | The date and time when the attachment was created or uploaded to the system, marking the beginning of its existence in the repository. |
| FileContents | String | The actual contents of the file, typically represented as text or encoded data. This is important for text-based attachments. |
| ExpirationDate | Datetime | The date when the contents of the attachment are set to expire, after which the attachment may no longer be accessible or valid. |
| LastUpdatedByUserName | String | The username of the individual who last updated the attachment details, helping to track updates over time. |
| CreatedByUserName | String | The username of the person who initially created the attachment, used for historical reference. |
| AsyncTrackerId | String | An identifier used by the Attachment UI components to track the asynchronous upload process, ensuring uploads complete successfully. |
| FileWebImage | String | An image representation of the attachment (if applicable), used for visual previews of the file within the web interface. |
| DownloadInfo | String | A JSON object that contains information used to programmatically retrieve the file attachment, such as file location and access details. |
| PostProcessingAction | String | The name of the action to be performed after the attachment is uploaded, such as indexing, validation, or notifying other systems. |
| AccountingDate | Date | The date used for accounting purposes, typically indicating when the attachment (invoice) was recorded in the system. |
| AllowCompletion | String | A flag indicating whether the attachment can be completed or finalized, useful for workflows requiring approval or review. |
| BillingDate | Date | The date when the billing information related to the attachment was generated, typically matching the invoice date. |
| BillToCustomerName | String | The name of the customer to whom the invoice (and associated attachment) is billed. |
| BillToCustomerNumber | String | The customer number assigned to the bill-to customer, used for identifying the customer in the system. |
| BillToSite | String | The site identifier for the bill-to customer, indicating the specific location or address where the invoice is being sent. |
| BusinessUnit | String | The business unit associated with the attachment, typically representing the department or division handling the transaction. |
| CrossReference | String | A reference identifier for tracking purposes, often used to link the attachment to another related document or system. |
| CustomerTransactionId | Long | The identifier of the customer transaction associated with the attachment, used to track the specific transaction. |
| DocumentNumber | Long | The document number assigned to the attachment, ensuring it is uniquely identified within the system. |
| DueDate | Date | The date by which the payment or action related to the attachment is due, important for managing payment deadlines. |
| Finder | String | A field used for searching and locating the attachment based on specific criteria or keywords. |
| FirstPartyTaxRegistration | String | The tax registration number of the deploying company, used for tax reporting and compliance. |
| InvoiceCurrencyCode | String | The currency code used for the invoice associated with the attachment, ensuring proper handling of currency conversions. |
| InvoiceStatus | String | The status of the invoice, indicating whether it is 'Complete', 'Pending', or 'Overdue'. This field tracks the progress of invoice processing. |
| LegalEntityIdentifier | String | The identifier for the legal entity under which the invoice and attachment were created, used for legal and tax purposes. |
| PaymentTerms | String | The payment terms associated with the invoice, specifying the due date and conditions under which payment is expected. |
| PurchaseOrder | String | The purchase order number linked to the invoice, used for reference and to ensure the invoice matches the original order. |
| ShipToCustomerName | String | The name of the customer receiving the goods or services, which may differ from the bill-to customer. |
| ShipToSite | String | The site number where the goods or services were delivered, indicating the shipping location of the invoice items. |
| ThirdPartyTaxRegistration | String | The tax registration number of a third-party entity, often used for transactions involving external parties or resellers. |
| TransactionDate | Date | The date the transaction associated with the attachment took place, marking when the goods or services were provided. |
| TransactionNumber | String | The unique number assigned to the transaction associated with the attachment, used for identification and reference. |
| TransactionSource | String | The source from which the transaction originated, such as a sales order, contract, or other business transaction. |
| TransactionType | String | The type of transaction (for example, sale, return, adjustment) associated with the attachment, important for classification and reporting purposes. |
Captures notes or comments linked to an invoice, adding contextual information for collectors, auditors, or customers.
| Name | Type | Description |
| ReceivablesInvoicesCustomerTransactionId [KEY] | Long | The unique identifier associated with the customer transaction for the invoice, used to link the note to a specific invoice. |
| NoteId [KEY] | Long | A unique identifier for the note related to the invoice, enabling easy retrieval and reference. |
| SourceObjectCode | String | A code representing the source object, as defined in the OBJECTS Metadata. Examples of valid values are 'Activities', 'Opportunities', and 'Sales Business Plan'. This helps classify the source of the note. |
| SourceObjectId | String | The unique identifier for the source object (for example, Activity or Opportunity) linked to the note, helping to trace its origin. |
| PartyName | String | The name of the party associated with the note, which could be a person, company, or other entity. |
| NoteTxt | String | The full text content of the note, providing important context or details about the transaction or invoice. |
| NoteTypeCode | String | A code used to categorize the type of note. The valid values for this field are defined in the lookup 'NoteSourceTypeVA'. |
| VisibilityCode | String | Defines the visibility level of the note. It indicates whether the note is visible internally, externally, or remains private. Valid values are defined in the NoteVisibilityLookupVA table. |
| CreatorPartyId | Long | The unique identifier for the party that created the note, useful for tracking the source of the note. |
| CreatedBy | String | The username of the person who created the note, helping to identify its origin. |
| CreationDate | Datetime | The date and time when the note was created, providing context on when the note was entered into the system. |
| LastUpdateDate | Datetime | The most recent date and time the note was updated, reflecting the last modification made to the note. |
| PartyId | Long | The unique identifier of the party associated with the note, useful for linking the note to a specific entity. |
| CorpCurrencyCode | String | The corporate currency code used for the note, indicating the currency in which the note-related transactions are handled. |
| CurcyConvRateType | String | The currency conversion rate type used when converting between different currencies for the note. Examples include 'Spot', 'Corporate', and 'User'. |
| CurrencyCode | String | The currency code of the note, specifying the currency used in the transaction or referenced in the note. |
| ContactRelationshipId | Long | The identifier linking the note to a specific contact relationship, facilitating better contact and note management. |
| ParentNoteId | Long | The unique identifier of the parent note, if this note is a child or part of a chain of related notes. |
| LastUpdatedBy | String | The username of the person who last updated the note, helping to track changes over time. |
| LastUpdateLogin | String | The login ID of the user who last updated the note, aiding in user tracking. |
| EmailAddress | String | The email address of the contact person associated with the note, useful for communication. |
| FormattedAddress | String | The formatted address of the contact associated with the note, used for shipping or billing purposes. |
| FormattedPhoneNumber | String | The formatted phone number of the contact, providing an easy-to-use contact point. |
| UpdateFlag | Bool | Indicates whether the note has been updated. A 'true' value signals that changes have occurred. |
| DeleteFlag | Bool | Indicates whether the note has been flagged for deletion. A 'true' value indicates the note is marked for removal. |
| NoteNumber | String | An alternate unique identifier for the note, which could be system-generated or sourced from an external system. |
| NoteTitle | String | A brief title or heading entered by the user to summarize the note's content. |
| AccountingDate | Date | The accounting date associated with the note, often reflecting when the transaction or note was recognized in the system. |
| AllowCompletion | String | Indicates whether the note is ready to be marked as complete. A value of 'Y' allows the completion of associated transactions. |
| BillingDate | Date | The date associated with the billing cycle, useful for tracking the invoicing timeline. |
| BillToCustomerName | String | The name of the customer being billed, used to identify the party responsible for the invoice. |
| BillToCustomerNumber | String | The customer number assigned to the bill-to customer, facilitating accurate identification. |
| BillToSite | String | The identifier for the site where the bill-to customer resides or is serviced. |
| BusinessUnit | String | The business unit under which the invoice or note was created, helping to categorize and track transactions by department. |
| CrossReference | String | A reference used to link the note to related documents or transactions, aiding in the tracking of interconnected records. |
| CustomerTransactionId | Long | The unique identifier of the customer transaction associated with the note, linking the note to a specific transaction. |
| DocumentNumber | Long | The number assigned to the document related to the note, ensuring that it is easily referenced. |
| DueDate | Date | The due date for the note-related payment or action, indicating when the obligations associated with the note should be fulfilled. |
| Finder | String | A field used for searching and locating the note based on specific criteria, such as keywords or document identifiers. |
| FirstPartyTaxRegistration | String | The tax registration number of the first party involved in the transaction, typically the deploying company or seller. |
| InvoiceCurrencyCode | String | The currency code of the invoice associated with the note, ensuring proper handling of currency conversions. |
| InvoiceStatus | String | The current status of the invoice, indicating whether it is 'Paid', 'Unpaid', 'Pending', etc. |
| LegalEntityIdentifier | String | The identifier of the legal entity under which the invoice or note was issued, important for legal and tax purposes. |
| PaymentTerms | String | The terms of payment for the invoice or transaction, specifying the conditions under which payment should be made. |
| PurchaseOrder | String | The purchase order number associated with the invoice or transaction, ensuring the transaction matches the original order. |
| ShipToCustomerName | String | The name of the customer receiving the goods or services related to the note or invoice. |
| ShipToSite | String | The site identifier for the ship-to customer, used to track where the goods or services were delivered. |
| ThirdPartyTaxRegistration | String | The tax registration number of a third-party involved in the transaction, such as a reseller or logistics provider. |
| TransactionDate | Date | The date when the transaction associated with the note took place, marking the actual occurrence of the event. |
| TransactionNumber | String | The unique number assigned to the transaction related to the note, ensuring it can be easily identified and referenced. |
| TransactionSource | String | The source of the transaction, such as 'Sales Order', 'Purchase Order', or 'Return', used for categorization. |
| TransactionType | String | The type of transaction associated with the note, such as 'Sale', 'Return', 'Credit', or 'Debit', used for classification. |
Enables descriptive flexfields for receivables invoices, storing additional details aligned to business processes.
| Name | Type | Description |
| ReceivablesInvoicesCustomerTransactionId [KEY] | Long | The unique identifier associated with the customer transaction for the invoice, linking the descriptive flexfield to a specific transaction. |
| CustomerTrxId [KEY] | Long | The unique identifier of the invoice within the descriptive flexfield, allowing for specific tracking and reference of the invoice's data. |
| _FLEX_Context | String | The context segment of the invoice's descriptive flexfield, used to categorize or segment the data according to business logic or reporting needs. |
| _FLEX_Context_DisplayValue | String | The display value of the descriptive flexfield context, which provides a user-friendly label for the context segment in reports or UI elements. |
| AccountingDate | Date | The accounting date associated with the invoice, representing the date on which the invoice was recognized for financial reporting. |
| AllowCompletion | String | Indicates whether the transaction related to the invoice is ready to be completed. A value of 'Y' allows the transaction to be finalized. |
| BillingDate | Date | The date on which the invoice was generated for billing purposes, marking the start of the payment period. |
| BillToCustomerName | String | The name of the customer responsible for the payment of the invoice, identifying the party being billed. |
| BillToCustomerNumber | String | The unique number assigned to the bill-to customer, used for customer identification within the system. |
| BillToSite | String | The identifier for the specific site or location of the bill-to customer, used for regional or logistical categorization of invoices. |
| BusinessUnit | String | The business unit under which the invoice is issued, typically used for organizational purposes or for tracking different lines of business. |
| CrossReference | String | A reference field used to link the invoice to other related records or systems, providing a cross-reference point for tracking and reconciliation. |
| CustomerTransactionId | Long | The unique identifier of the customer transaction, linking the invoice to the specific customer transaction record for further tracking. |
| DocumentNumber | Long | The document number assigned to the invoice, providing a reference for the invoice document in the system. |
| DueDate | Date | The due date for the invoice payment, representing when payment for the invoice is expected. |
| Finder | String | A field used to help locate the invoice record based on various criteria or search terms. |
| FirstPartyTaxRegistration | String | The tax registration number of the first party, typically the deploying company or seller, used for tax reporting and legal purposes. |
| InvoiceCurrencyCode | String | The currency code used for the invoice, indicating the currency in which the invoice is issued and payment is expected. |
| InvoiceStatus | String | The current status of the invoice, indicating whether it is 'Paid', 'Unpaid', 'Pending', etc., providing insight into the invoice's payment progress. |
| LegalEntityIdentifier | String | The identifier of the legal entity under which the invoice was issued, important for financial reporting and legal compliance. |
| PaymentTerms | String | The payment terms associated with the invoice, specifying the conditions under which payment is due, such as net 30 days or cash on delivery. |
| PurchaseOrder | String | The purchase order number associated with the invoice, providing a link to the original purchase request or agreement. |
| ShipToCustomerName | String | The name of the customer receiving the goods or services billed on the invoice, important for logistics and delivery purposes. |
| ShipToSite | String | The site identifier for the ship-to customer, helping to track the location where the goods or services are delivered. |
| ThirdPartyTaxRegistration | String | The tax registration number of a third party involved in the transaction, such as a reseller or logistics provider, used for tax reporting. |
| TransactionDate | Date | The date when the transaction associated with the invoice was created, marking the actual occurrence of the invoiceable event. |
| TransactionNumber | String | The unique transaction number associated with the invoice, helping to identify and track the specific transaction in records. |
| TransactionSource | String | The source of the transaction that created the invoice, such as 'Sales Order' or 'Return', used for categorization and reporting. |
| TransactionType | String | The type of transaction associated with the invoice, such as 'Sale', 'Return', 'Credit', or 'Debit', used to classify the invoice. |
Allocates invoice lines to accounting segments, creating detailed distribution records for financial analysis.
| Name | Type | Description |
| ReceivablesInvoicesCustomerTransactionId [KEY] | Long | The unique identifier of the customer transaction for the invoice distribution, linking the distribution to the main customer transaction. |
| DistributionId [KEY] | Long | The unique identifier for the invoice distribution, used to track the specific allocation of invoice amounts to different accounts. |
| InvoiceLineNumber | Long | The number of the invoice line to which this distribution is associated, providing a reference for how the amount is split across the invoice. |
| DetailedTaxLineNumber | Long | The tax line number associated with the invoice line, used to track the tax distribution for the specific invoice line. |
| AccountClass | String | The classification of the account for the distribution. Valid values include 'Revenue', 'Receivable', 'Freight', and 'Tax', which help categorize the type of transaction. |
| AccountCombination | String | The code combination representing the specific account for the distribution. This could include various financial dimensions, such as cost center and department. |
| Amount | Decimal | The amount of the distribution in the invoice's currency, indicating the monetary value allocated to the account specified in the distribution. |
| AccountedAmount | Decimal | The amount of the distribution in the ledger currency, representing the value after conversion from the invoice currency. |
| Percent | Decimal | The percentage of the invoice line amount that is allocated to this distribution, allowing for proportional splits of the invoice total. |
| Comments | String | User-defined comments regarding the distribution, providing additional context or explanations about the allocation. |
| CreatedBy | String | The user who created the distribution record, helping track the origin of the distribution. |
| CreationDate | Datetime | The date and time when the distribution record was created, used for tracking the creation history. |
| LastUpdateDate | Datetime | The date and time when the distribution record was last updated, allowing for tracking of modifications. |
| LastUpdatedBy | String | The user who last updated the distribution record, helping to identify who made the most recent changes. |
| AccountingDate | Date | The accounting date of the distribution, which determines when the transaction is recognized in the accounting period. |
| AllowCompletion | String | Indicates whether the distribution can be completed. A value of 'Y' means the distribution is ready to be finalized. |
| BillingDate | Date | The date when the billing was done for the invoice, marking when the invoice charge is officially recognized. |
| BillToCustomerName | String | The name of the customer being billed for the invoice distribution, helping to identify the payer. |
| BillToCustomerNumber | String | The unique number assigned to the bill-to customer, which helps identify the customer in the system. |
| BillToSite | String | The identifier of the site where the bill-to customer is located, used for geographic or logistical purposes. |
| BusinessUnit | String | The business unit under which the invoice distribution was created, used for organizational and financial reporting. |
| CrossReference | String | A reference field used to link the distribution to other records or systems, enabling cross-referencing across different transaction types. |
| CustomerTransactionId | Long | The unique identifier of the customer transaction associated with the distribution, helping to link the distribution back to the original customer transaction. |
| DocumentNumber | Long | The document number of the invoice distribution, which helps track and identify the specific document in the system. |
| DueDate | Date | The due date for the distribution's payment, indicating when the amount should be paid by the customer. |
| Finder | String | A field used for searching and locating the distribution based on various criteria, facilitating easier retrieval of records. |
| FirstPartyTaxRegistration | String | The tax registration number of the first party involved in the distribution, typically the seller or service provider. |
| InvoiceCurrencyCode | String | The currency code used for the invoice distribution, indicating the currency in which the invoice was issued. |
| InvoiceStatus | String | The current status of the invoice distribution, which could include values such as 'Paid', 'Unpaid', or 'Pending'. |
| LegalEntityIdentifier | String | The identifier of the legal entity under which the invoice distribution was created, important for legal and regulatory compliance. |
| PaymentTerms | String | The payment terms associated with the invoice distribution, outlining the payment schedule or conditions for settling the invoice. |
| PurchaseOrder | String | The purchase order number linked to the invoice distribution, referencing the original order that led to the creation of the invoice. |
| ShipToCustomerName | String | The name of the customer receiving the goods or services billed on the distribution, used for delivery tracking. |
| ShipToSite | String | The identifier of the site where the goods or services are delivered, helping to track the location of the shipment. |
| ThirdPartyTaxRegistration | String | The tax registration number of a third-party entity involved in the transaction, such as a logistics provider or intermediary. |
| TransactionDate | Date | The date on which the transaction related to the distribution was created, marking the occurrence of the financial event. |
| TransactionNumber | String | The transaction number assigned to the invoice distribution, providing a unique identifier for the distribution in transaction records. |
| TransactionSource | String | The source of the transaction that generated the invoice distribution, such as 'Sales Order' or 'Return'. |
| TransactionType | String | The type of transaction associated with the distribution, such as 'Sale', 'Refund', or 'Credit', helping classify the distribution. |
Holds custom descriptive flexfields for invoice distributions, aiding specialized reporting or data capture.
| Name | Type | Description |
| ReceivablesInvoicesCustomerTransactionId [KEY] | Long | The unique identifier of the customer transaction for the invoice distribution descriptive flexfield, linking the distribution to the main customer transaction. |
| ReceivablesinvoicedistributionsDistributionId [KEY] | Long | The unique identifier for the invoice distribution in the descriptive flexfield, used to track the specific allocation of the invoice amount to different accounts. |
| CustTrxLineGlDistId [KEY] | Long | The unique identifier of the invoice distribution, linking it to the general ledger distribution for proper accounting and financial reporting. |
| _FLEX_Context | String | The context segment of the invoice distribution descriptive flexfield, indicating the specific context or category of the distribution. |
| _FLEX_Context_DisplayValue | String | The displayed value for the context segment of the invoice distribution descriptive flexfield, providing a user-friendly display for the context information. |
| AccountingDate | Date | The accounting date for the invoice distribution, determining when the financial transaction is recognized in the accounting period. |
| AllowCompletion | String | Indicates whether the invoice distribution can be completed. A value of 'Y' means that the distribution is eligible for finalization in the system. |
| BillingDate | Date | The billing date of the invoice distribution, which marks when the charges for the distribution are recognized and billed to the customer. |
| BillToCustomerName | String | The name of the bill-to customer associated with the invoice distribution, identifying the entity being billed. |
| BillToCustomerNumber | String | The unique identifier for the bill-to customer, which links the distribution to the specific customer in the system. |
| BillToSite | String | The identifier of the bill-to site associated with the invoice distribution, specifying the location or site of the bill-to customer. |
| BusinessUnit | String | The business unit under which the invoice distribution was created, categorizing the distribution within a specific organizational division. |
| CrossReference | String | A reference field used to link the distribution to other related records or systems, enabling cross-referencing across different transaction types. |
| CustomerTransactionId | Long | The unique identifier of the customer transaction associated with the invoice distribution, helping to link the distribution back to the original customer transaction. |
| DocumentNumber | Long | The document number assigned to the invoice distribution, which helps track and identify the specific document in the system. |
| DueDate | Date | The due date for the invoice distribution's payment, indicating when the amount should be paid by the customer. |
| Finder | String | A field used for searching and locating the distribution based on various criteria, facilitating easier retrieval of records. |
| FirstPartyTaxRegistration | String | The tax registration number of the first party involved in the distribution, typically the seller or service provider, for tax and regulatory purposes. |
| InvoiceCurrencyCode | String | The currency code used for the invoice distribution, indicating the currency in which the invoice was issued. |
| InvoiceStatus | String | The current status of the invoice distribution, indicating whether the distribution is 'Paid', 'Unpaid', or 'Pending'. |
| LegalEntityIdentifier | String | The identifier of the legal entity under which the invoice distribution was created, which is necessary for legal and regulatory compliance. |
| PaymentTerms | String | The payment terms for the invoice distribution, specifying the conditions under which the invoice is to be paid, such as 'Net 30' or 'Due on receipt'. |
| PurchaseOrder | String | The purchase order number associated with the invoice distribution, linking the distribution to the original purchase order. |
| ShipToCustomerName | String | The name of the customer receiving the goods or services billed on the distribution, used for delivery and shipping purposes. |
| ShipToSite | String | The identifier of the site where the goods or services are delivered, helping to track the location of the shipment. |
| ThirdPartyTaxRegistration | String | The tax registration number of a third-party entity involved in the transaction, such as a logistics provider or intermediary, for tax reporting. |
| TransactionDate | Date | The date when the transaction related to the invoice distribution occurred, marking the occurrence of the financial event. |
| TransactionNumber | String | The transaction number associated with the invoice distribution, providing a unique identifier for the distribution within transaction records. |
| TransactionSource | String | The source of the transaction that generated the invoice distribution, such as 'Sales Order' or 'Return', helping to classify the origin of the transaction. |
| TransactionType | String | The type of transaction associated with the distribution, such as 'Sale', 'Refund', or 'Credit', which helps categorize the nature of the distribution. |
Contains global descriptive flexfields at the invoice level, supporting multi-regional billing and compliance requirements.
| Name | Type | Description |
| ReceivablesInvoicesCustomerTransactionId [KEY] | Long | The unique identifier for the customer transaction in the invoice General Data flexfield, linking the invoice to the associated transaction. |
| CustomerTrxId [KEY] | Long | The unique identifier for the customer transaction in the invoice, enabling precise tracking and management of transaction details. |
| ExcludeFromNetting | String | A flag indicating whether the invoice is excluded from netting, typically used in multi-party transactions where some amounts are excluded from netting calculations. |
| DeliveryDateforTaxPointDate | Date | The date used to determine the tax point for the invoice, which is important for tax calculations and reporting. |
| _FLEX_Context | String | The context segment of the invoice General Data flexfield, which categorizes the invoice distribution or other related financial data. |
| _FLEX_Context_DisplayValue | String | The human-readable display value for the context segment, making it easier for users to understand the context of the invoice data. |
| AccountingDate | Date | The date when the financial transaction for the invoice is recognized in the accounting system, which can differ from the transaction date. |
| AllowCompletion | String | Indicates whether the invoice is ready to be completed in the system. A value of 'Y' allows the invoice to be finalized, while 'N' indicates pending actions. |
| BillingDate | Date | The date when the invoice is officially issued or billed to the customer, marking the beginning of the payment term. |
| BillToCustomerName | String | The name of the customer being billed, which is necessary for identifying the recipient of the invoice. |
| BillToCustomerNumber | String | The unique identifier for the bill-to customer, which helps link the invoice to the specific customer account. |
| BillToSite | String | The identifier for the bill-to customer site, which helps specify the physical or virtual location where the billing occurs. |
| BusinessUnit | String | The business unit under which the invoice is generated, typically used for organizational purposes and to track business divisions. |
| CrossReference | String | A reference used to link the invoice to other related records, such as sales orders or contracts, facilitating easy cross-referencing. |
| CustomerTransactionId | Long | The unique identifier for the customer transaction, linking the invoice to the original transaction in the customer account system. |
| DocumentNumber | Long | The unique document number assigned to the invoice, helping to identify and track the specific invoice in records. |
| DueDate | Date | The due date for the payment of the invoice, indicating when the payment is expected from the customer. |
| Finder | String | A field used for searching and locating the invoice based on various criteria, facilitating quicker retrieval of records. |
| FirstPartyTaxRegistration | String | The tax registration number of the first party involved in the transaction, typically the seller or service provider, for tax reporting purposes. |
| InvoiceCurrencyCode | String | The currency code used for the invoice, indicating the currency in which the amount is denominated. |
| InvoiceStatus | String | The status of the invoice, such as 'Paid', 'Unpaid', or 'Pending', which helps track the invoice's processing state. |
| LegalEntityIdentifier | String | The identifier of the legal entity under which the invoice is created, necessary for compliance with legal and tax regulations. |
| PaymentTerms | String | The payment terms for the invoice, specifying the conditions under which the customer must pay, such as 'Net 30' or 'Due on receipt'. |
| PurchaseOrder | String | The purchase order number associated with the invoice, linking the invoice to the original purchase order for tracking and reconciliation. |
| ShipToCustomerName | String | The name of the customer receiving the goods or services, which can differ from the bill-to customer in some cases. |
| ShipToSite | String | The identifier of the site to which goods or services are shipped, ensuring accurate delivery tracking. |
| ThirdPartyTaxRegistration | String | The tax registration number of a third-party entity involved in the transaction, such as a shipping or logistics provider, required for tax reporting. |
| TransactionDate | Date | The date when the transaction related to the invoice occurred, which can differ from the invoice creation date. |
| TransactionNumber | String | The transaction number assigned to the invoice, providing a unique identifier for tracking and referencing the transaction. |
| TransactionSource | String | The source of the transaction that generated the invoice, such as 'Sales Order' or 'Return', indicating the origin of the invoice data. |
| TransactionType | String | The type of transaction associated with the invoice, such as 'Sale', 'Refund', or 'Credit', which helps categorize the nature of the invoice. |
Details installment-based billing within an invoice, reflecting the portion due amounts and their corresponding dates.
| Name | Type | Description |
| ReceivablesInvoicesCustomerTransactionId [KEY] | Long | The unique identifier of the customer transaction associated with the invoice installment, helping to track the installment within the context of the broader transaction. |
| InstallmentId [KEY] | Long | The unique identifier for the invoice installment, used to distinguish and track individual installments associated with the invoice. |
| InstallmentSequenceNumber | Long | The sequence number of the installment, which helps order and identify multiple installments within a series. |
| InstallmentDueDate | Date | The due date by which the installment payment must be made, indicating when the customer is expected to pay for the installment. |
| OriginalAmount | Decimal | The original amount of the installment before any adjustments, credits, or payments have been applied. |
| PaymentDaysLate | Int | The number of days the payment is overdue for the installment, used to calculate late fees or interest if applicable. |
| InstallmentBalanceDue | Decimal | The remaining balance due for the installment, which may have decreased due to partial payments or adjustments. |
| InstallmentStatus | String | The status of the installment, such as 'Paid', 'Unpaid', or 'Partially Paid', providing an indication of the installment's current payment state. |
| DisputeAmount | Decimal | The amount of the installment under dispute, often withheld or temporarily held due to disagreements with the billed charges. |
| DisputeDate | Date | The date when the dispute over the installment amount was raised, helping track the timing of the dispute. |
| InstallmentClosedDate | Date | The date when the installment is considered closed, typically after it is fully paid or written off. |
| InstallmentGLClosedDate | Date | The date when the installment was closed in the general ledger, signifying the completion of all financial transactions related to the installment. |
| AccountedBalanceDue | Decimal | The balance that has been accounted for in the general ledger, reflecting adjustments, credits, or payments applied to the installment. |
| InstallmentAmountAdjusted | Decimal | The amount by which the installment has been adjusted, typically due to billing errors, discounts, or other modifications. |
| InstallmentAmountCredited | Decimal | The amount credited back to the installment, often due to returns, adjustments, or other changes. |
| AmountPaid | Decimal | The total amount that has been paid toward the installment, reducing the outstanding balance. |
| PendingAdjustmentAmount | Decimal | The amount pending adjustment, often representing changes that are not yet reflected in the final balance due. |
| InstallmentLineAmountOriginal | Decimal | The original amount of the invoice line associated with the installment, before any adjustments or credits. |
| InstallmentLineAmountDue | Decimal | The amount due for the invoice line associated with the installment, potentially adjusted for partial payments or credits. |
| InstallmentFreightAmountOriginal | Decimal | The original freight charge associated with the installment, typically representing delivery or handling fees. |
| InstallmentFreightAmountDue | Decimal | The amount due for freight charges associated with the installment, potentially modified by adjustments or credits. |
| InstallmentTaxAmountOriginal | Decimal | The original tax amount applied to the installment, reflecting the taxes owed for the billed items. |
| InstallmentTaxAmountDue | Decimal | The amount of tax still due for the installment, potentially adjusted by partial payments or tax-related adjustments. |
| CreationDate | Datetime | The date and time when the invoice installment record was created, used for tracking and auditing purposes. |
| CreatedBy | String | The user who created the invoice installment record, providing accountability for the creation of financial data. |
| LastUpdateDate | Datetime | The date and time when the invoice installment record was last updated, ensuring that changes to financial data are logged. |
| LastUpdatedBy | String | The user who last updated the invoice installment record, allowing for tracking of updates and revisions. |
| ExcludeFromCollections | String | A flag indicating whether the installment should be excluded from collections activities, typically used for installment plans or disputes. |
| AccountingDate | Date | The date when the installment transaction was posted to the accounting system, affecting financial reporting and closing. |
| AllowCompletion | String | A flag that determines whether the installment is allowed to complete. Typically, this flag is used to control whether further actions can be taken on the installment. |
| BillingDate | Date | The date when the installment was billed to the customer, which may differ from the transaction date and is used to calculate payment terms. |
| BillToCustomerName | String | The name of the customer who is responsible for the installment payment. |
| BillToCustomerNumber | String | The customer account number for the entity billed for the installment, facilitating identification and reconciliation. |
| BillToSite | String | The specific billing site associated with the customer for this installment, helping to identify the location tied to the transaction. |
| BusinessUnit | String | The business unit under which the invoice installment was issued, used for tracking and reporting by organizational division. |
| CrossReference | String | A reference used to cross-check or link the installment to another related transaction or system, often used for reconciliation. |
| CustomerTransactionId | Long | The unique identifier for the customer transaction related to the installment, ensuring it is correctly linked to the broader transaction data. |
| DocumentNumber | Long | The document number associated with the installment, used to uniquely identify and track the installment in records. |
| DueDate | Date | The due date by which payment for the installment is expected, which drives collections and payment reminder activities. |
| Finder | String | A field used for searching and locating the installment based on different criteria, improving data retrieval efficiency. |
| FirstPartyTaxRegistration | String | The tax registration number of the first party involved in the installment, typically the seller or service provider. |
| InvoiceCurrencyCode | String | The currency code used for the installment, which helps identify the currency of the amount due. |
| InvoiceStatus | String | The status of the invoice to which the installment belongs, such as 'Open', 'Paid', or 'Cancelled', indicating the current state of the invoice. |
| LegalEntityIdentifier | String | The identifier of the legal entity responsible for the installment, used for financial and legal reporting. |
| PaymentTerms | String | The terms under which the installment payment is made, such as 'Net 30' or 'Due on receipt'. |
| PurchaseOrder | String | The purchase order number associated with the installment, used for linking the installment to the original purchase agreement. |
| ShipToCustomerName | String | The name of the customer receiving the goods or services billed for the installment. |
| ShipToSite | String | The site where the goods or services related to the installment are shipped, facilitating delivery tracking. |
| ThirdPartyTaxRegistration | String | The tax registration number of any third-party entity involved in the transaction, such as a logistics or service provider. |
| TransactionDate | Date | The date on which the transaction generating the installment was completed, impacting financial reporting. |
| TransactionNumber | String | The transaction number assigned to the installment, providing a unique reference for tracking purposes. |
| TransactionSource | String | The source of the transaction generating the installment, such as 'Sales Order' or 'Credit Memo', linking it to the origin. |
| TransactionType | String | The type of transaction that created the installment, such as 'Sale', 'Refund', or 'Credit', helping categorize the nature of the installment. |
Leverages global descriptive flexfields for invoice installments, handling cross-border or specialized business needs.
| Name | Type | Description |
| ReceivablesInvoicesCustomerTransactionId [KEY] | Long | The unique identifier of the customer transaction associated with the installment in the ReceivablesInvoices system, linking the installment to the broader transaction context. |
| ReceivablesinvoiceinstallmentsInstallmentId [KEY] | Long | The unique identifier for the specific installment, enabling tracking and management of individual payments or balances due on an invoice. |
| PaymentScheduleId [KEY] | Long | The unique identifier for the payment schedule tied to the installment, used to track and manage the timing and structure of installment payments. |
| _FLEX_Context | String | The context segment for the invoice installment's descriptive flexfield, providing additional customizable information specific to the business or accounting needs. |
| _FLEX_Context_DisplayValue | String | The displayed value of the flexfield context segment for the installment, providing a human-readable representation of the context used for customization. |
| AccountingDate | Date | The date when the installment transaction was posted to the accounting system, influencing the financial reporting period for the installment. |
| AllowCompletion | String | A flag that determines whether the installment is eligible for completion, used to control whether further actions such as payment processing can occur. |
| BillingDate | Date | The date when the installment was billed to the customer, impacting the payment due date and financial reporting for the installment. |
| BillToCustomerName | String | The name of the customer responsible for paying the installment, identifying the customer associated with the billing. |
| BillToCustomerNumber | String | The customer number assigned to the billing customer, facilitating identification and reconciliation of billing records. |
| BillToSite | String | The site associated with the bill-to customer, identifying the location linked to the billing address for the installment. |
| BusinessUnit | String | The business unit under which the invoice installment was issued, helping to classify and report the installment by organizational division. |
| CrossReference | String | A reference field used to link the installment to related transactions or records, such as sales orders or credit memos, for reconciliation and auditing. |
| CustomerTransactionId | Long | The unique identifier for the transaction tied to the installment, ensuring the installment is linked to the broader customer transaction. |
| DocumentNumber | Long | The unique document number associated with the installment, used to track and manage invoice-related documents. |
| DueDate | Date | The date by which the installment payment is due, determining when the customer is expected to pay. |
| Finder | String | A search field used for locating specific installments based on various attributes, improving the efficiency of retrieving installment data. |
| FirstPartyTaxRegistration | String | The tax registration number of the first party involved in the installment transaction, typically the seller or service provider, for tax reporting purposes. |
| InvoiceCurrencyCode | String | The currency code used for the installment amount, indicating the currency in which the installment payment should be made. |
| InvoiceStatus | String | The status of the invoice associated with the installment, indicating whether the invoice is 'Paid', 'Open', 'Partially Paid', etc. |
| LegalEntityIdentifier | String | The unique identifier of the legal entity responsible for managing the invoice installment, providing clarity on which business unit or entity the installment belongs to. |
| PaymentTerms | String | The payment terms associated with the installment, defining the payment schedule and conditions, such as 'Net 30' or 'Due on Receipt'. |
| PurchaseOrder | String | The purchase order number linked to the installment, associating it with a specific purchase agreement and tracking the goods or services ordered. |
| ShipToCustomerName | String | The name of the customer receiving the goods or services billed for the installment, typically used in shipping and delivery documentation. |
| ShipToSite | String | The site where the goods or services related to the installment are delivered, helping track the destination of the shipped items. |
| ThirdPartyTaxRegistration | String | The tax registration number of any third-party entity involved in the transaction, such as a logistics or external service provider, for tax reporting purposes. |
| TransactionDate | Date | The date on which the transaction that generated the installment was completed, marking when the financial event was officially recorded. |
| TransactionNumber | String | The transaction number assigned to the installment, serving as a unique identifier for tracking the financial transaction. |
| TransactionSource | String | The source of the transaction generating the installment, such as 'Sales Order', 'Credit Memo', or 'Refund', helping categorize the nature of the installment. |
| TransactionType | String | The type of transaction that created the installment, such as 'Sale', 'Refund', or 'Credit', assisting in classification and reporting. |
Stores notes or instructions for specific invoice installments, ensuring clarity around partial payment obligations.
| Name | Type | Description |
| ReceivablesInvoicesCustomerTransactionId [KEY] | Long | The unique identifier of the customer transaction related to the invoice installment, allowing the attachment of notes to specific invoice transactions. |
| ReceivablesinvoiceinstallmentsInstallmentId [KEY] | Long | The unique identifier of the specific installment within the invoice, allowing notes to be tied to individual installments for better tracking. |
| NoteId [KEY] | Long | The unique identifier of the note, used to track and manage individual notes associated with an invoice installment. |
| SourceObjectCode | String | The code identifying the source object that generated the note, such as Activities, Opportunities, or Sales Business Plan, for easier categorization of notes. |
| SourceObjectId | String | The unique identifier of the source object, such as Activities or Opportunities, linked to the note for contextual reference. |
| PartyName | String | The name of the party that is associated with the note, often used to identify the customer or entity related to the note. |
| NoteTxt | String | The full text of the note associated with the invoice installment, allowing users to add detailed comments or information about the transaction. |
| NoteTypeCode | String | The code used to categorize the type of note. Examples might include different types of notes like 'Payment Information', 'Customer Request', etc. |
| VisibilityCode | String | The visibility level of the note, such as Private, Internal, or External, controlling who can see the note within the system. |
| CreatorPartyId | Long | The unique identifier of the party who created the note, allowing traceability of note creation. |
| CreatedBy | String | The name of the user who created the note, for accountability and auditing purposes. |
| CreationDate | Datetime | The timestamp indicating when the note was created, helping track the note's lifecycle. |
| LastUpdateDate | Datetime | The timestamp of the last update to the note, useful for understanding when the note was last modified. |
| PartyId | Long | The unique identifier of the party involved with the note, which could be the customer or another party associated with the note. |
| CorpCurrencyCode | String | The corporate currency code associated with the note, reflecting the currency used for the note's financial context. |
| CurcyConvRateType | String | The currency conversion rate type used for any currency conversions applied to the note, such as 'Spot', 'Corporate', or 'User'. |
| CurrencyCode | String | The currency code associated with the note, indicating the currency used for the note's transaction or information. |
| ContactRelationshipId | Long | The unique identifier for the relationship between the note and a contact, facilitating the association of notes to specific contacts. |
| ParentNoteId | Long | The unique identifier of the parent note, allowing for the creation of note hierarchies when a note is linked to another. |
| LastUpdatedBy | String | The name of the user who last updated the note, for tracking updates and changes made to the note. |
| LastUpdateLogin | String | The user login associated with the last update made to the note, providing a traceable log of system interactions. |
| EmailAddress | String | The email address associated with the note, particularly useful for notes related to communications. |
| FormattedAddress | String | The formatted address related to the note, which could be useful in shipping or billing contexts. |
| FormattedPhoneNumber | String | The formatted phone number related to the note, providing easy access to contact information. |
| UpdateFlag | Bool | A flag indicating whether the note is marked for update, used to track whether the note is undergoing changes. |
| DeleteFlag | Bool | A flag indicating whether the note is marked for deletion, allowing the system to track deletions of notes. |
| NoteNumber | String | The alternate unique identifier of the note, either system-generated or from an external system, providing an alternative reference for the note. |
| NoteTitle | String | The title or summary of the note, providing a brief description of the note's content or purpose. |
| AccountingDate | Date | The date when the note's related financial transaction is accounted for, influencing the financial records for the installment. |
| AllowCompletion | String | A flag that determines whether the note can be completed or finalized, typically used for workflow management. |
| BillingDate | Date | The date when billing related to the note was processed, impacting when payments are due. |
| BillToCustomerName | String | The name of the customer being billed for the invoice installment, helping to identify the customer associated with the note. |
| BillToCustomerNumber | String | The account number of the customer billed for the installment, enabling easy cross-referencing of billing information. |
| BillToSite | String | The site or location associated with the billing address of the customer, used for accurate shipping and billing. |
| BusinessUnit | String | The business unit within the organization that generated the note, useful for reporting and financial categorization. |
| CrossReference | String | A reference field used to link the note to related transactions or documents, improving the traceability of the note. |
| CustomerTransactionId | Long | The unique identifier of the customer transaction tied to the note, linking it to the specific transaction it relates to. |
| DocumentNumber | Long | The unique document number tied to the note, aiding in the identification of related documents and transactions. |
| DueDate | Date | The due date for any actions or payments related to the note, setting expectations for follow-up actions. |
| Finder | String | A field used for searching and locating specific notes within the system based on certain attributes or keywords. |
| FirstPartyTaxRegistration | String | The tax registration number of the first party involved in the transaction, typically the seller or service provider, for tax compliance. |
| InvoiceCurrencyCode | String | The currency code associated with the invoice linked to the note, indicating the payment currency for the invoice. |
| InvoiceStatus | String | The status of the invoice linked to the note, such as 'Paid', 'Unpaid', 'Overdue', or 'Partial', affecting payment and collection processes. |
| LegalEntityIdentifier | String | The unique identifier of the legal entity managing the invoice, used for distinguishing between different business entities within the organization. |
| PaymentTerms | String | The payment terms for the invoice linked to the note, such as 'Net 30' or 'Due on Receipt', defining the payment schedule. |
| PurchaseOrder | String | The purchase order number related to the invoice, linking the note to the original purchase agreement. |
| ShipToCustomerName | String | The name of the customer receiving the shipment linked to the note, relevant in shipping and delivery contexts. |
| ShipToSite | String | The site or location where the goods or services linked to the note are shipped, helping to track delivery destinations. |
| ThirdPartyTaxRegistration | String | The tax registration number of any third-party entity involved in the transaction, often used in international or multi-party transactions for tax purposes. |
| TransactionDate | Date | The date when the transaction generating the note occurred, helping to track and report financial activities. |
| TransactionNumber | String | The transaction number linked to the note, providing a unique reference for the transaction associated with the note. |
| TransactionSource | String | The source of the transaction that generated the note, such as 'Sales Order' or 'Credit Memo', providing context for the origin of the note. |
| TransactionType | String | The type of transaction generating the note, such as 'Sale', 'Refund', or 'Adjustment', classifying the nature of the financial event. |
Outlines each item or service included in a receivables invoice, capturing unit price, quantity, and tax details.
| Name | Type | Description |
| ReceivablesInvoicesCustomerTransactionId [KEY] | Long | The unique identifier of the customer transaction associated with the invoice line, used to link the line to a specific customer invoice. |
| CustomerTransactionLineId [KEY] | Long | The unique identifier of an individual invoice line, allowing for detailed tracking and reference of each product or service on the invoice. |
| LineNumber | Decimal | The sequential number of the invoice line, providing order to the items listed on the invoice. |
| Description | String | A textual description of the product or service being invoiced, offering a clear explanation of what is being billed. |
| Quantity | Decimal | The number of units for the product or service being billed on the invoice line. |
| UnitSellingPrice | Decimal | The price of a single unit of the product or service on the invoice line. |
| TaxClassificationCode | String | The code that helps in determining the tax treatment of the product or service, impacting the tax calculations. |
| SalesOrder | String | The sales order number associated with the invoice line, linking the invoice to the original sales order. |
| AccountingRuleDuration | Long | The number of accounting periods over which revenue is to be recognized for this invoice line, applying to rules that require deferred revenue recognition. |
| RuleEndDate | Date | The date when the revenue scheduling rule concludes for this invoice line, impacting revenue recognition schedules. |
| RuleStartDate | Date | The date when the revenue scheduling rule begins for the invoice line, marking the start of the revenue recognition process. |
| AccountingRule | String | The specific revenue scheduling rule applied to the invoice line, determining how revenue is recognized over time. |
| Warehouse | String | The location from which inventory items on the invoice line are shipped, important for inventory tracking and logistics. |
| MemoLine | String | A memo line that provides additional context or explanation for the item on the invoice line. |
| UnitOfMeasure | String | The unit of measure used for the product or service on the invoice line, such as 'each', 'box', or 'kilogram'. |
| ItemNumber | String | The identifier of the inventory item listed on the invoice line, linking it to a specific product in the inventory system. |
| AllocatedFreightAmount | Decimal | The freight charge allocated to this specific invoice line, reflecting the transportation cost for the item. |
| AssessableValue | Decimal | The base value used to calculate tax on the product or service, influencing tax rates and amounts. |
| SalesOrderDate | Date | The date when the sales order was created, helping link the invoice line to the sales process. |
| LineAmount | Decimal | The total monetary value of the invoice line, calculated as the quantity multiplied by the unit selling price. |
| CreatedBy | String | The name of the user who created the invoice line, for tracking purposes. |
| CreationDate | Datetime | The date and time when the invoice line was created in the system. |
| LastUpdatedBy | String | The name of the user who last updated the invoice line, providing audit trail information. |
| TransacationBusinessCategory | String | The classification for tax purposes of the business nature of a transaction, as designated by a tax authority. |
| UserDefinedFiscalClassification | String | A custom classification used for tax purposes, allowing businesses to apply additional tax rules to specific invoice lines. |
| ProductFiscalClassification | String | The tax classification of the product sold on the invoice line, as determined by tax regulations. |
| ProductCategory | String | The tax category of a non-inventory-based product on the invoice line, used to apply specific tax rules. |
| ProductType | String | The type of product sold (for example, Goods or Services), influencing how tax is calculated and reported for this invoice line. |
| LineIntendedUse | String | The intended use of the product on the invoice line as classified for tax purposes, affecting how taxes are applied. |
| LineAmountIncludesTax | String | Indicates whether the amount for the invoice line includes tax, is exclusive of tax, or is determined by tax settings. |
| TaxInvoiceDate | Date | The date the tax invoice document was generated, marking the official date for tax reporting purposes. |
| TaxInvoiceNumber | String | The unique number assigned to the tax invoice, which is used for tax reporting and legal compliance. |
| TaxExemptionCertificateNumber | String | The identification number for the certificate that exempts a party or product from tax, used for tax compliance purposes. |
| TaxExemptionHandling | String | Indicates how tax exemption should be handled for the invoice line. Valid options are Standard, Require, or Exempt. |
| TaxExemptionReason | String | The reason for granting tax exemption to a product or party on the invoice line, such as 'Non-profit' or 'Government Exemption'. |
| AccountingDate | Date | The date that the invoice line’s financial transactions are accounted for, affecting financial reporting and journal entries. |
| AllowCompletion | String | Indicates whether the invoice line can be marked as completed and finalized, ensuring all necessary processes are completed. |
| BillingDate | Date | The date when the invoice line was billed, which may differ from the transaction date and affects payment schedules. |
| BillToCustomerName | String | The name of the customer being billed for the goods or services listed on the invoice line. |
| BillToCustomerNumber | String | The account number of the customer being billed, used for customer identification and tracking. |
| BillToSite | String | The address or location where the bill is sent, helping with accurate invoicing and shipping. |
| BusinessUnit | String | The business unit responsible for the transaction, important for internal reporting and financial management. |
| CrossReference | String | A reference code used to link the invoice line to related documents or transactions, facilitating tracking and auditing. |
| CustomerTransactionId | Long | The unique identifier for the customer transaction tied to the invoice line, enabling the connection of multiple lines to a single transaction. |
| DocumentNumber | Long | The document number for the invoice, used for identification and referencing the invoice line within the system. |
| DueDate | Date | The due date for payment of the invoice line, helping to manage accounts receivable and payment schedules. |
| Finder | String | A searchable identifier that helps users quickly locate specific invoice lines within the system. |
| FirstPartyTaxRegistration | String | The tax registration number for the seller or service provider, used for tax reporting and compliance. |
| InvoiceCurrencyCode | String | The currency code of the invoice, indicating the currency in which the goods or services are billed. |
| InvoiceStatus | String | The current status of the invoice line, such as 'Paid', 'Unpaid', or 'Pending', to track the invoice’s payment state. |
| LegalEntityIdentifier | String | The identifier of the legal entity responsible for the invoice, used for compliance and financial reporting. |
| PaymentTerms | String | The terms under which the invoice is to be paid, such as 'Net 30' or 'Due on Receipt'. |
| PurchaseOrder | String | The purchase order number associated with the invoice line, linking the invoice to the original order. |
| ShipToCustomerName | String | The name of the customer receiving the goods or services, useful for shipping and delivery purposes. |
| ShipToSite | String | The location where the goods or services are shipped, critical for logistics and fulfillment. |
| ThirdPartyTaxRegistration | String | The tax registration number for a third party involved in the transaction, necessary for tax reporting and compliance. |
| TransactionDate | Date | The date when the transaction generating the invoice line occurred, impacting the financial reporting period. |
| TransactionNumber | String | The number assigned to the transaction that generated the invoice line, used for traceability. |
| TransactionSource | String | The origin of the transaction, such as 'Sales Order' or 'Credit Memo', providing context for the invoice. |
| TransactionType | String | The type of transaction linked to the invoice line, such as 'Sale', 'Refund', or 'Adjustment', influencing tax and financial reporting. |
Facilitates attaching supporting files at the line level, clarifying charges or providing proof of delivery.
| Name | Type | Description |
| ReceivablesInvoicesCustomerTransactionId [KEY] | Long | The unique identifier of the customer transaction associated with the invoice line attachment, linking the attachment to a specific invoice. |
| ReceivablesinvoicelinesCustomerTransactionLineId [KEY] | Long | The unique identifier of the invoice line related to the attachment, connecting the file to a particular line item. |
| AttachedDocumentId [KEY] | Long | The unique identifier of the document attached to the invoice line, used to track the attachment's metadata. |
| LastUpdateDate | Datetime | The date and time when the attachment was last updated, helping with audit tracking and version control. |
| LastUpdatedBy | String | The user who last updated the attachment details, ensuring accountability for changes. |
| DatatypeCode | String | The data type code that indicates the format of the attachment, such as PDF, Word, or Image. |
| FileName | String | The name of the attached file, useful for identification and retrieval purposes. |
| DmFolderPath | String | The folder path within the document management system where the attachment is stored, enabling easy file location. |
| DmDocumentId | String | The unique identifier assigned to the attachment within the document management system, helping to manage and retrieve the document. |
| DmVersionNumber | String | The version number of the attachment, allowing for version control and tracking of document revisions. |
| Url | String | The URL link to access the attachment online, enabling easy sharing and access. |
| CategoryName | String | The category of the attachment, such as 'Invoice', 'Contract', or 'Shipping Documents', for organization. |
| UserName | String | The user name associated with the attachment, typically the user who uploaded the file. |
| Uri | String | The URI (Uniform Resource Identifier) for accessing the attachment, often used in programmatic access. |
| FileUrl | String | The full URL where the attachment file is hosted, allowing for direct access to the file. |
| UploadedText | String | The text content of the attachment, stored for reference or search purposes. |
| UploadedFileContentType | String | The content type of the uploaded file. |
| UploadedFileLength | Long | The size of the attachment file in bytes, used to manage file storage and bandwidth. |
| UploadedFileName | String | The name of the uploaded attachment file, which may differ from the original file name. |
| ContentRepositoryFileShared | Bool | Indicates whether the attachment is shared with other users or systems, facilitating collaborative access. |
| Title | String | The title of the attachment, providing a brief description of the document's content. |
| Description | String | A more detailed description of the attachment, offering context for its content and purpose. |
| ErrorStatusCode | String | The error code associated with the attachment, if any, used for troubleshooting issues during upload or retrieval. |
| ErrorStatusMessage | String | The error message associated with the attachment, providing more detail on the nature of any issues encountered. |
| CreatedBy | String | The user who created the attachment record in the system, providing a traceable point of origin. |
| CreationDate | Datetime | The date and time when the attachment was first created in the system. |
| FileContents | String | The contents of the attachment file, stored as text for quick access or reference. |
| ExpirationDate | Datetime | The expiration date of the attachment content, after which the attachment may no longer be accessible. |
| LastUpdatedByUserName | String | The username of the person who last updated the attachment's details, providing accountability. |
| CreatedByUserName | String | The username of the person who initially created the attachment record in the system. |
| AsyncTrackerId | String | A tracking identifier used by the Attachment UI components during the upload process, useful for monitoring asynchronous operations. |
| FileWebImage | String | A web image representation of the file, typically used for visual previews of the attachment. |
| DownloadInfo | String | A JSON object containing information needed to programmatically retrieve the attachment file, used by API calls. |
| PostProcessingAction | String | The name of an action to be performed after the attachment is uploaded, such as 'Generate PDF' or 'Send Notification'. |
| AccountingDate | Date | The accounting date related to the attachment, ensuring that the document is tied to the correct financial period. |
| AllowCompletion | String | Indicates whether the attachment process can be completed, ensuring that all necessary steps are performed before finalizing. |
| BillingDate | Date | The date when the billing related to the attachment occurred, relevant for financial reporting. |
| BillToCustomerName | String | The name of the customer being billed, helping to identify the recipient of the invoice or associated document. |
| BillToCustomerNumber | String | The customer number assigned to the bill-to customer, used for tracking and customer relationship management. |
| BillToSite | String | The physical site or address of the bill-to customer, important for shipping and invoicing purposes. |
| BusinessUnit | String | The business unit associated with the invoice line and attachment, ensuring accurate financial reporting within an organization. |
| CrossReference | String | A reference code used to link the attachment to other documents or transactions, helping with document relationships. |
| CustomerTransactionId | Long | The customer transaction ID associated with the attachment, allowing for traceability and linkage to a specific customer transaction. |
| DocumentNumber | Long | The document number of the invoice line or associated transaction, facilitating identification and retrieval. |
| DueDate | Date | The due date for the payment or action associated with the attachment, important for managing deadlines. |
| Finder | String | A reference field for quickly searching and locating the attachment within the system. |
| FirstPartyTaxRegistration | String | The tax registration number of the first party involved in the transaction, required for tax compliance. |
| InvoiceCurrencyCode | String | The currency code used for the invoice associated with the attachment, ensuring correct financial reporting. |
| InvoiceStatus | String | The current status of the invoice related to the attachment, such as 'Paid', 'Unpaid', or 'Pending'. |
| LegalEntityIdentifier | String | The unique identifier for the legal entity responsible for the transaction, ensuring proper accounting and compliance. |
| PaymentTerms | String | The agreed payment terms for the invoice associated with the attachment, such as 'Net 30' or 'Due on Receipt'. |
| PurchaseOrder | String | The purchase order number linked to the invoice line, used for matching invoices to purchase orders. |
| ShipToCustomerName | String | The name of the customer receiving the goods or services, relevant for shipping purposes. |
| ShipToSite | String | The address or location where the goods or services are being shipped, ensuring accurate delivery. |
| ThirdPartyTaxRegistration | String | The tax registration number of a third-party involved in the transaction, needed for third-party tax compliance. |
| TransactionDate | Date | The date when the transaction generating the invoice line and attachment occurred. |
| TransactionNumber | String | The unique transaction number associated with the invoice line, used to track the transaction across systems. |
| TransactionSource | String | The origin or source of the transaction, such as 'Sales Order' or 'Credit Memo', helping to classify the attachment. |
| TransactionType | String | The type of transaction linked to the attachment, such as 'Sale', 'Refund', or 'Adjustment', which helps categorize the document. |
Adds descriptive flexfields at the line item level, extending invoice functionality with custom fields.
| Name | Type | Description |
| ReceivablesInvoicesCustomerTransactionId [KEY] | Long | The unique identifier of the customer transaction associated with the invoice line descriptive flexfield, linking it to a specific invoice. |
| ReceivablesinvoicelinesCustomerTransactionLineId [KEY] | Long | The unique identifier for the invoice line associated with the descriptive flexfield, enabling accurate tracking of line-level details. |
| CustomerTrxLineId [KEY] | Long | The unique identifier of the invoice line descriptive flexfield, helping to differentiate between different lines within a single invoice. |
| _FLEX_Context | String | The context segment of the descriptive flexfield that provides additional business-specific classification or categorization for the invoice line. |
| _FLEX_Context_DisplayValue | String | The displayed value of the descriptive flexfield context, providing a human-readable format for understanding the context of the invoice line. |
| AccountingDate | Date | The accounting date associated with the invoice line, specifying the date for financial reporting and revenue recognition. |
| AllowCompletion | String | Indicates whether the invoice line's processing can be completed, helping to manage the status of line-level operations. |
| BillingDate | Date | The date when the invoice line was billed, important for managing billing schedules and cash flow projections. |
| BillToCustomerName | String | The name of the bill-to customer associated with the invoice line, identifying the customer responsible for the payment. |
| BillToCustomerNumber | String | The customer number of the bill-to customer, linking the invoice line to the specific customer record. |
| BillToSite | String | The bill-to site identifier associated with the invoice line, detailing the address or location where the invoice is sent. |
| BusinessUnit | String | The business unit under which the invoice line was created, useful for organizational reporting and managing financial transactions across business units. |
| CrossReference | String | A reference field used to link the invoice line with other transactions, providing a cross-reference to related business activities. |
| CustomerTransactionId | Long | The unique identifier of the customer transaction tied to the invoice line, allowing for traceability and reporting of customer-specific transactions. |
| DocumentNumber | Long | The document number for the invoice line, ensuring that each transaction line has a unique identifier for tracking and auditing purposes. |
| DueDate | Date | The due date for the payment of the invoice line, helping to track payment schedules and ensuring timely collections. |
| Finder | String | A reference field used to quickly locate the invoice line within the system, typically used for searching or filtering related records. |
| FirstPartyTaxRegistration | String | The tax registration number of the first party involved in the transaction, essential for tax reporting and compliance. |
| InvoiceCurrencyCode | String | The currency code associated with the invoice line, ensuring accurate reporting and conversion when processing international transactions. |
| InvoiceStatus | String | The status of the invoice line, such as 'Pending', 'Paid', or 'Partially Paid', helping to track the progress of payment. |
| LegalEntityIdentifier | String | The unique identifier of the legal entity responsible for the invoice line, ensuring proper financial and legal tracking for reporting. |
| PaymentTerms | String | The payment terms for the invoice line, detailing when the payment is due and any applicable discounts or penalties. |
| PurchaseOrder | String | The purchase order number associated with the invoice line, linking the transaction to a specific procurement order. |
| ShipToCustomerName | String | The name of the customer receiving the goods or services for the invoice line, relevant for shipping and delivery processes. |
| ShipToSite | String | The identifier of the ship-to site associated with the invoice line, specifying where the goods or services are being delivered. |
| ThirdPartyTaxRegistration | String | The tax registration number of a third party involved in the transaction, needed for tax compliance when a third party is responsible for taxes. |
| TransactionDate | Date | The date when the transaction related to the invoice line occurred, used for tracking and reporting purposes. |
| TransactionNumber | String | The transaction number assigned to the invoice line, serving as a unique identifier for each transaction within the invoicing system. |
| TransactionSource | String | The source of the transaction that generated the invoice line, such as 'Sales Order' or 'Credit Memo', helping to categorize the invoice line. |
| TransactionType | String | The type of transaction that generated the invoice line, such as 'Sale', 'Refund', or 'Adjustment', classifying the nature of the business activity. |
Employs global descriptive flexfields for invoice lines, supporting globalized business scenarios and complex data requirements.
| Name | Type | Description |
| ReceivablesInvoicesCustomerTransactionId [KEY] | Long | The unique identifier of the customer transaction associated with the invoice line, linking the invoice line to a specific customer transaction. |
| ReceivablesinvoicelinesCustomerTransactionLineId [KEY] | Long | The unique identifier for the invoice line associated with the general ledger distribution flexfield, enabling precise tracking of line-level details. |
| CustomerTrxLineId [KEY] | Long | The identifier of the invoice line within the descriptive flexfield structure, used to uniquely identify and manage line items. |
| _FLEX_Context | String | The context segment of the descriptive flexfield, providing additional classifications or categorization for the invoice line as per business requirements. |
| _FLEX_Context_DisplayValue | String | The human-readable value representing the descriptive flexfield context, displaying the context segment's information for easier interpretation. |
| AccountingDate | Date | The date for accounting purposes associated with the invoice line, used to determine when the revenue or expense is recognized. |
| AllowCompletion | String | Indicates whether the processing of the invoice line can be completed, providing control over line status and workflow progression. |
| BillingDate | Date | The date the invoice line was billed, important for scheduling and tracking billing cycles, especially for periodic invoicing. |
| BillToCustomerName | String | The name of the bill-to customer associated with the invoice line, specifying the party responsible for payment of the invoice. |
| BillToCustomerNumber | String | The customer number of the bill-to customer, uniquely identifying the customer in the system for billing and reporting purposes. |
| BillToSite | String | The site identifier of the bill-to customer, linking the invoice line to a specific location or address for shipping or billing purposes. |
| BusinessUnit | String | The business unit under which the invoice line is created, used for financial reporting and managing transactions across various parts of the organization. |
| CrossReference | String | A cross-reference code used to link the invoice line to related transactions or systems, providing a reference for audit and reconciliation purposes. |
| CustomerTransactionId | Long | The unique identifier for the customer transaction associated with the invoice line, enabling full traceability of the transaction in the system. |
| DocumentNumber | Long | The unique document number associated with the invoice line, used for tracking and managing invoices within the accounting system. |
| DueDate | Date | The due date for payment of the invoice line, helping to track outstanding amounts and ensure timely payments. |
| Finder | String | A field used to facilitate quick searches or filtering of invoice lines, aiding in locating specific lines within the invoicing system. |
| FirstPartyTaxRegistration | String | The tax registration number of the first party involved in the transaction, used for tax compliance and reporting. |
| InvoiceCurrencyCode | String | The currency code associated with the invoice line, ensuring that the correct currency is applied to the invoicing process. |
| InvoiceStatus | String | The status of the invoice line, such as 'Pending', 'Paid', or 'Partially Paid', indicating the current processing stage of the invoice line. |
| LegalEntityIdentifier | String | The unique identifier of the legal entity responsible for the invoice line, used for legal and financial reporting purposes. |
| PaymentTerms | String | The payment terms for the invoice line, specifying when payment is due and any applicable discounts or penalties for early or late payment. |
| PurchaseOrder | String | The purchase order number linked to the invoice line, connecting the invoice to the corresponding procurement or sales order. |
| ShipToCustomerName | String | The name of the customer receiving the goods or services for the invoice line, specifying the end recipient of the transaction. |
| ShipToSite | String | The site identifier where the goods or services for the invoice line are being delivered, ensuring proper logistics and tracking. |
| ThirdPartyTaxRegistration | String | The tax registration number of any third party involved in the transaction, relevant for tax calculations and compliance when applicable. |
| TransactionDate | Date | The date on which the transaction related to the invoice line occurred, helping to track and report transaction timings. |
| TransactionNumber | String | The unique transaction number assigned to the invoice line, serving as an identifier for the transaction in the system. |
| TransactionSource | String | The source of the transaction that generated the invoice line, such as 'Sales Order' or 'Credit Memo', helping to categorize the invoice line. |
| TransactionType | String | The type of transaction associated with the invoice line, such as 'Sale', 'Refund', or 'Adjustment', categorizing the invoice line's business activity. |
Captures tax calculations and jurisdictions for each invoice line, facilitating accurate compliance and tax reporting.
| Name | Type | Description |
| ReceivablesInvoicesCustomerTransactionId [KEY] | Long | The unique identifier of the customer transaction associated with the tax line of the invoice, linking the tax line to the corresponding transaction. |
| ReceivablesinvoicelinesCustomerTransactionLineId [KEY] | Long | The unique identifier of the invoice line associated with the tax line, linking tax details to the specific invoice line. |
| CustomerTransactionLineId [KEY] | Long | The unique identifier for each individual tax line of the invoice, providing a distinct reference for managing tax-related information. |
| CreatedBy | String | The name or identifier of the user who created the tax line entry, allowing traceability for auditing purposes. |
| CreationDate | Datetime | The date and time when the tax line was created, helping to track the creation history of the invoice tax details. |
| LastUpdatedBy | String | The name or identifier of the user who last updated the tax line entry, ensuring accountability in the modification process. |
| LastUpdateDate | Datetime | The date and time when the tax line was last updated, allowing tracking of changes made to the tax details over time. |
| TaxJurisdictionCode | String | The tax jurisdiction code associated with the tax line, defining the geographical area or tax authority under which the tax is applicable. |
| TaxRate | Decimal | The tax rate applied to the invoice line for this particular tax line, determining the percentage of tax to be applied based on the taxable amount. |
| TaxRateCode | String | The code associated with the tax rate applied, which can be used for referencing the specific tax rate for calculations and reporting. |
| TaxRegimeCode | String | The tax regime code assigned to the tax line, representing the set of rules and laws governing tax calculations for the transaction. |
| TaxStatusCode | String | The code that represents the tax status for the tax line, such as whether the tax is exempt, standard, or has special handling. |
| Tax | String | The code for the type of tax applied to the invoice line, indicating the specific tax being calculated, like VAT or sales tax. |
| TaxAmount | Decimal | The total amount of tax applied to the invoice line in the entered currency, reflecting the tax calculated based on the taxable amount. |
| TaxableAmount | Decimal | The amount on which tax is calculated for the invoice line, providing the base value before applying the tax rate. |
| TaxPointBasis | String | The basis on which tax point is determined, such as delivery or invoice date, which impacts when the tax is applied and reported. |
| TaxPointDate | Date | The date when the tax point is recognized, which determines the tax reporting period for the invoice line. |
| TaxLineNumber | Int | The unique number assigned to each tax line within the invoice line, ensuring accurate identification and tracking of tax details. |
| PlaceOfSupply | Int | The place of supply for the goods or services related to the tax line, determining the jurisdiction in which the tax is applied. |
| TaxInclusiveIndicator | String | An indicator specifying whether the amount on the invoice line includes the tax (yes/no), affecting the calculation of tax-inclusive or exclusive pricing. |
| AccountingDate | Date | The date when the transaction related to the tax line is accounted for, impacting when the tax is recognized in the accounting system. |
| AllowCompletion | String | Indicates whether the tax line entry is eligible for completion in the workflow, providing control over the tax line processing status. |
| BillingDate | Date | The billing date of the invoice line, which may affect tax calculation if tax is based on invoice or delivery dates. |
| BillToCustomerName | String | The name of the customer responsible for paying the tax on the invoice line, essential for tax reporting and compliance. |
| BillToCustomerNumber | String | The unique identifier of the bill-to customer for the tax line, used to manage customer-specific tax obligations. |
| BillToSite | String | The site associated with the bill-to customer, identifying the location for which tax is applied or where services/goods are delivered. |
| BusinessUnit | String | The business unit under which the tax line is created, used to manage and categorize tax transactions across different departments or segments. |
| CrossReference | String | A reference field used to link the tax line to related transactions or documents, enhancing traceability for audits and reporting. |
| CustomerTransactionId | Long | The unique identifier for the customer transaction associated with the tax line, ensuring complete traceability of tax information within the transaction. |
| DocumentNumber | Long | The unique document number assigned to the invoice line, used for tracking and referencing the specific document in the system. |
| DueDate | Date | The date by which payment is due for the tax portion of the invoice line, helping in managing tax-related cash flows. |
| Finder | String | A field used for searching or filtering tax lines, aiding in the management and retrieval of tax-related information. |
| FirstPartyTaxRegistration | String | The tax registration number of the first party involved in the transaction, used for tax compliance and reporting purposes. |
| InvoiceCurrencyCode | String | The currency code associated with the invoice line, indicating the currency in which the tax is calculated and applied. |
| InvoiceStatus | String | The status of the invoice line in relation to its tax details, indicating whether it is open, paid, or under review. |
| LegalEntityIdentifier | String | The identifier for the legal entity responsible for the tax on the invoice line, ensuring proper tax compliance at the legal entity level. |
| PaymentTerms | String | The payment terms for the invoice line, specifying when payment for the tax is due and any applicable discounts or penalties. |
| PurchaseOrder | String | The purchase order number associated with the invoice line, linking the invoice to the procurement transaction that triggered it. |
| ShipToCustomerName | String | The name of the customer receiving the goods or services for the tax-applied invoice line, useful for shipping and compliance purposes. |
| ShipToSite | String | The site where the goods or services related to the tax line are shipped or delivered, impacting tax calculation based on location. |
| ThirdPartyTaxRegistration | String | The tax registration number of a third party, if involved, used to manage any applicable third-party tax obligations or exemptions. |
| TransactionDate | Date | The date on which the transaction related to the tax line occurred, affecting when tax is reported and due. |
| TransactionNumber | String | The transaction number assigned to the tax line, serving as a unique reference for tax reporting and auditing purposes. |
| TransactionSource | String | The source of the transaction that generated the tax line, indicating whether it is from a sales order, return, or another source. |
| TransactionType | String | The type of transaction associated with the tax line, such as sale, return, or adjustment, affecting how tax is applied. |
Allows custom descriptive flexfields for transaction-level data on invoice lines, providing extended tracking and analysis.
| Name | Type | Description |
| ReceivablesInvoicesCustomerTransactionId [KEY] | Long | The unique identifier of the customer transaction associated with the transaction details of the invoice line. |
| ReceivablesinvoicelinesCustomerTransactionLineId [KEY] | Long | The unique identifier of the invoice line associated with the transaction details, helping to link tax, payment, and other transaction details. |
| CustomerTrxLineId [KEY] | Long | The unique identifier for each separate transaction line related to the invoice, ensuring precise tracking and management of individual transactions. |
| _FLEX_Context | String | The context segment of the descriptive flexfield for the transaction line, providing additional business-specific information for the transaction. |
| _FLEX_Context_DisplayValue | String | The displayed value of the descriptive flexfield context, offering a more readable format for the flexfield context. |
| AccountingDate | Date | The date when the transaction for this invoice line is accounted for in the system, affecting financial reporting and reconciliation. |
| AllowCompletion | String | Indicates whether the transaction line entry is eligible for completion within the workflow, allowing control over whether it can be processed further. |
| BillingDate | Date | The date when the invoice for this line is billed to the customer, which may impact the timing of tax reporting and payment due dates. |
| BillToCustomerName | String | The name of the customer being billed for this transaction line, used for customer-specific processing and reporting. |
| BillToCustomerNumber | String | The account number of the customer being billed for this transaction line, linking the line to the customer's financial record. |
| BillToSite | String | The site associated with the customer for billing, helping in geographic or organizational tracking for tax or delivery purposes. |
| BusinessUnit | String | The business unit under which this transaction line is created, allowing categorization for reporting and business segment tracking. |
| CrossReference | String | A reference field used for linking this transaction line to related documents or transactions, facilitating cross-document and cross-transaction traceability. |
| CustomerTransactionId | Long | The identifier of the customer transaction associated with this line, ensuring consistency and traceability across multiple invoice and payment records. |
| DocumentNumber | Long | The document number associated with this transaction line, offering a unique reference to identify the transaction in the system. |
| DueDate | Date | The date by which payment for this transaction line is due, assisting in managing the customer's accounts receivable and collections. |
| Finder | String | A search identifier used to locate or filter the transaction line within the system for easier navigation and data retrieval. |
| FirstPartyTaxRegistration | String | The tax registration number of the first party involved in the transaction, used for compliance with tax authorities. |
| InvoiceCurrencyCode | String | The currency code used for the invoice line, indicating the currency in which the transaction is billed and taxed. |
| InvoiceStatus | String | The status of the invoice line, such as 'Paid', 'Unpaid', or 'Pending', indicating the transaction’s current state in the invoicing process. |
| LegalEntityIdentifier | String | The identifier of the legal entity responsible for the transaction line, ensuring proper allocation for tax, accounting, and legal purposes. |
| PaymentTerms | String | The payment terms assigned to the invoice line, determining the schedule and conditions under which payment is expected. |
| PurchaseOrder | String | The purchase order number associated with this transaction line, linking the transaction to the procurement process and ensuring compliance with purchase terms. |
| ShipToCustomerName | String | The name of the customer to whom the goods or services associated with this transaction line are being shipped. |
| ShipToSite | String | The site where the goods or services associated with the transaction line are delivered, aiding in logistics and geographic tax applications. |
| ThirdPartyTaxRegistration | String | The tax registration number of a third party involved in the transaction, useful for compliance if a third-party is handling tax or payment. |
| TransactionDate | Date | The date the transaction for the invoice line was made, affecting tax reporting and financial statement entries. |
| TransactionNumber | String | A unique identifier for the transaction, used to track the specific entry across systems and reports. |
| TransactionSource | String | The source of the transaction, such as an order, return, or credit, providing context on the origin of the invoice line. |
| TransactionType | String | The type of transaction related to the invoice line, such as 'Sale', 'Adjustment', or 'Refund', defining the nature of the financial event. |
Adds descriptive flexfields for the entire invoice transaction, enabling more detailed recordkeeping of billing activities.
| Name | Type | Description |
| ReceivablesInvoicesCustomerTransactionId [KEY] | Long | The unique identifier for the customer transaction related to the invoice, ensuring proper linkage across various transaction records. |
| CustomerTrxId [KEY] | Long | The unique identifier for the specific customer transaction associated with the invoice, used for tracking and reporting purposes. |
| _FLEX_Context | String | The context segment of the descriptive flexfield, capturing additional business-specific details related to the invoice transaction. |
| _FLEX_Context_DisplayValue | String | The displayed value of the descriptive flexfield context, offering a user-friendly version of the business-specific context segment. |
| AccountingDate | Date | The date on which the transaction is accounted for in the financial system, impacting the period in which the transaction is recorded. |
| AllowCompletion | String | Indicates whether the invoice transaction is allowed to be marked as completed within the processing workflow, determining if it can be finalized. |
| BillingDate | Date | The date when the invoice transaction is officially billed to the customer, marking the start of the payment cycle. |
| BillToCustomerName | String | The name of the customer who is being billed for the transaction, helping to identify the payer for this specific invoice. |
| BillToCustomerNumber | String | The account number of the customer being billed, linking the transaction to the customer's financial records. |
| BillToSite | String | The site where the bill-to customer is located, used for geographic or operational purposes in billing and tax calculations. |
| BusinessUnit | String | The business unit responsible for generating the invoice transaction, enabling categorization and reporting by business division. |
| CrossReference | String | A reference used for linking this transaction to related documents or transactions, enhancing traceability across systems. |
| CustomerTransactionId | Long | The identifier for the customer transaction tied to this invoice, ensuring the consistency and integrity of the transaction within the system. |
| DocumentNumber | Long | The unique document number assigned to the invoice transaction, acting as a reference for identifying and retrieving the transaction. |
| DueDate | Date | The date by which the invoice transaction is due for payment, impacting cash flow management and collections processes. |
| Finder | String | A search key or identifier used to easily locate or filter the transaction within the system for quick access and analysis. |
| FirstPartyTaxRegistration | String | The tax registration number for the first party involved in the transaction, used for tax compliance and reporting purposes. |
| InvoiceCurrencyCode | String | The currency code associated with the invoice transaction, indicating the currency in which the transaction is billed and paid. |
| InvoiceStatus | String | The status of the invoice transaction, such as 'Open', 'Paid', or 'Void', indicating the current state of the transaction in the invoicing process. |
| LegalEntityIdentifier | String | The identifier for the legal entity responsible for the invoice, ensuring accurate allocation for tax, accounting, and legal purposes. |
| PaymentTerms | String | The terms agreed upon for payment of the invoice, including details such as the due date, discounts, or payment schedules. |
| PurchaseOrder | String | The purchase order number linked to the invoice transaction, providing a reference to the procurement process for the goods or services billed. |
| ShipToCustomerName | String | The name of the customer to whom goods or services are shipped, used for shipping and delivery documentation. |
| ShipToSite | String | The site or location where goods or services are delivered, allowing tracking and operational alignment with delivery processes. |
| ThirdPartyTaxRegistration | String | The tax registration number of a third party involved in the transaction, used for tax compliance when applicable. |
| TransactionDate | Date | The date when the invoice transaction is recorded or processed, affecting accounting periods and reporting cycles. |
| TransactionNumber | String | A unique number assigned to the invoice transaction, serving as a primary reference for tracking and retrieving the transaction. |
| TransactionSource | String | The source or origin of the transaction, such as an order or adjustment, providing insight into how the transaction was initiated. |
| TransactionType | String | The type of transaction, such as 'Sale', 'Refund', or 'Credit', helping to categorize the nature of the financial event for reporting and analysis. |
Manages attached documentation (for example, bank slips) for each standard receipt, ensuring proof of payment and audit trails.
| Name | Type | Description |
| StandardReceiptsStandardReceiptId [KEY] | Long | The unique identifier of the standard receipt to which the attachment is linked. |
| AttachedDocumentId [KEY] | Long | The unique identifier of the attached document, used to track and reference the specific attachment. |
| LastUpdateDate | Datetime | The date and time when the attachment was last updated in the system. |
| LastUpdatedBy | String | The user who last updated the attachment record. |
| DatatypeCode | String | A code representing the type of data contained in the attachment (for example, PDF, Word document, etc.). |
| FileName | String | The name of the file associated with the attachment. |
| DmFolderPath | String | The path within the document management system where the attachment file is stored. |
| DmDocumentId | String | The unique identifier of the document within the document management system. |
| DmVersionNumber | String | The version number of the document, indicating whether the file has been revised or updated. |
| Url | String | The web URL where the attachment can be accessed or downloaded. |
| CategoryName | String | The category under which the attachment is classified (for example, invoice, receipt, contract). |
| UserName | String | The username of the person who uploaded or interacted with the attachment. |
| Uri | String | The Uniform Resource Identifier (URI) pointing to the attachment for access or integration. |
| FileUrl | String | The direct URL to the attachment file itself for download or access. |
| UploadedText | String | Text content or description embedded in the attachment, if applicable. |
| UploadedFileContentType | String | The content type that describes the format of the uploaded attachment. |
| UploadedFileLength | Long | The size of the uploaded attachment file in bytes. |
| UploadedFileName | String | The actual name of the file as it was uploaded. |
| ContentRepositoryFileShared | Bool | Indicates whether the attachment is shared with others (true) or kept private (false). |
| Title | String | The title or label given to the attachment, which could describe its purpose or content. |
| Description | String | A detailed description or context for the attachment, typically explaining its relevance to the associated receipt. |
| ErrorStatusCode | String | An error code generated if there were any issues with processing the attachment. |
| ErrorStatusMessage | String | A message providing further details about any error encountered during attachment processing. |
| CreatedBy | String | The user who initially created or uploaded the attachment record. |
| CreationDate | Datetime | The date and time when the attachment was first created in the system. |
| FileContents | String | The contents of the attachment in textual form (if the file is not binary). |
| ExpirationDate | Datetime | The date and time when the attachment is set to expire or become invalid. |
| LastUpdatedByUserName | String | The username of the individual who last updated the attachment record. |
| CreatedByUserName | String | The username of the individual who created the attachment record. |
| AsyncTrackerId | String | An identifier used to track asynchronous file upload operations, particularly when the upload process is performed in the background. |
| FileWebImage | String | A web image representation of the attachment, typically used for previews or visual identification in the interface. |
| DownloadInfo | String | A JSON object containing structured data to help programmatically retrieve the file attachment. |
| PostProcessingAction | String | The name of the action to be performed on the attachment after it has been uploaded (for example, indexing, categorization). |
| BusinessUnit | String | The business unit associated with the standard receipt and its attachment, helping categorize receipts for management. |
| CustomerAccountNumber | String | The account number of the customer associated with the receipt, which is linked to the attachment. |
| CustomerName | String | The name of the customer associated with the standard receipt and its attached document. |
| CustomerSite | String | The specific site or location of the customer tied to the standard receipt and its attached document. |
| Finder | String | An identifier used for searching and locating the attachment in queries or reports. |
| ReceiptDate | Date | The date when the standard receipt, to which the attachment is linked, was created. |
| ReceiptNumber | String | The receipt number of the standard receipt, which is associated with this attachment. |
| StandardReceiptId | Long | The unique identifier of the standard receipt, used to link the attachment to its corresponding receipt. |
Enables adding references for payments, such as remittance advice numbers, assisting bank reconciliation and inquiries.
| Name | Type | Description |
| StandardReceiptsStandardReceiptId [KEY] | Long | The unique identifier of the standard receipt to which the remittance reference is linked. |
| RemittanceReferenceId [KEY] | Long | The unique identifier of the remittance reference, used to track the link between the payment and the corresponding transaction. |
| ReceiptMatchBy | String | The method or document type used to match the standard receipt with a specific transaction, such as invoice or credit memo. |
| ReferenceNumber | String | The unique identifier of the selected document type used for matching the standard receipt to the transaction (for example, invoice number). |
| ReferenceAmount | Decimal | The amount applied to the reference document during the receipt process. |
| CreatedBy | String | The user who created the remittance reference entry in the system. |
| CreationDate | Datetime | The date and time when the remittance reference was created. |
| LastUpdatedBy | String | The user who last updated the remittance reference record. |
| LastUpdateDate | Datetime | The date and time when the remittance reference was last updated. |
| CustomerReason | String | The customer’s reason for any deductions or overpayments related to the standard receipt, typically used for Channel Revenue Management claims. |
| CustomerReference | String | The reference number provided by the customer for tracking or identifying claims related to Channel Revenue Management. |
| BusinessUnit | String | The business unit responsible for the standard receipt, helping categorize and manage transactions across different operational units. |
| CustomerAccountNumber | String | The account number of the customer associated with the remittance reference, used for payment matching and reconciliation. |
| CustomerName | String | The name of the customer to whom the standard receipt is linked. |
| CustomerSite | String | The site or location of the customer, which is linked to the standard receipt and remittance reference. |
| Finder | String | A field used for searching and locating the remittance reference in queries or reports, typically linked to the remittance reference record. |
| ReceiptDate | Date | The date when the standard receipt was created and the remittance reference was associated with it. |
| ReceiptNumber | String | The receipt number associated with the remittance reference, which uniquely identifies the payment. |
| StandardReceiptId | Long | The unique identifier of the standard receipt to which the remittance reference is linked, providing a direct connection between the payment and the reference. |
Hosts descriptive flexfields on standard receipts, allowing extra details or tracking codes for internal processes.
| Name | Type | Description |
| StandardReceiptsStandardReceiptId [KEY] | Long | The unique identifier of the standard receipt, linking it to the corresponding receipt entry in the system. |
| CashReceiptId [KEY] | Long | The unique identifier of the cash receipt, which is associated with the standard receipt and used for tracking cash transactions. |
| _FLEX_Context | String | The context segment of the descriptive flexfield for the standard receipt, used to capture additional attributes or dimensions for reporting and processing. |
| _FLEX_Context_DisplayValue | String | The display value of the descriptive flexfield context segment for the standard receipt, offering a human-readable description of the context. |
| BusinessUnit | String | The business unit associated with the standard receipt, representing the organizational unit responsible for processing the transaction. |
| CustomerAccountNumber | String | The account number of the customer linked to the standard receipt, used for payment processing and reconciliation. |
| CustomerName | String | The name of the customer associated with the standard receipt, identifying the entity making the payment. |
| CustomerSite | String | The site or location associated with the customer, used for delivering goods or services and for accounting purposes. |
| Finder | String | A field used to search or locate specific standard receipt records, typically used for reporting or querying the data. |
| ReceiptDate | Date | The date when the standard receipt was created or recorded in the system. |
| ReceiptNumber | String | The unique identifier or number assigned to the standard receipt, used for reference and tracking within the system. |
| StandardReceiptId | Long | The unique identifier of the standard receipt, which is linked to other related transaction records in the system. |
Employs global descriptive flexfields for receipts, meeting international or business-specific data requirements.
| Name | Type | Description |
| StandardReceiptsStandardReceiptId [KEY] | Long | The unique identifier of the standard receipt, linking it to the associated receipt entry in the system for tracking and reference purposes. |
| CashReceiptId [KEY] | Long | The unique identifier of the cash receipt associated with the standard receipt, used to track cash transactions and apply payments. |
| _FLEX_Context | String | The context segment of the descriptive flexfield for the standard receipt, providing additional metadata or classification for reporting and processing. |
| _FLEX_Context_DisplayValue | String | The display value of the descriptive flexfield context segment for the standard receipt, which presents the context in a human-readable format. |
| BusinessUnit | String | The business unit associated with the standard receipt, representing the department or organizational unit responsible for processing the receipt. |
| CustomerAccountNumber | String | The account number of the customer linked to the standard receipt, used to identify the customer for payment processing and account management. |
| CustomerName | String | The name of the customer associated with the standard receipt, identifying the entity making the payment. |
| CustomerSite | String | The site or location of the customer, typically used for delivery purposes and for linking customer transactions. |
| Finder | String | A searchable field used to help locate specific standard receipt records in the system, often utilized for query operations. |
| ReceiptDate | Date | The date when the standard receipt was created or recorded in the system, indicating when the payment was processed. |
| ReceiptNumber | String | The unique identifier or number assigned to the standard receipt, which is used for tracking and referencing the receipt in the system. |
| StandardReceiptId | Long | The unique identifier of the standard receipt, which is used to link the receipt with related transaction records in the system. |
Provides a lookup of tax authority profiles, outlining configuration for various tax authorities and compliance rules.
| Name | Type | Description |
| PartyTaxProfileId [KEY] | Long | The unique identifier for the tax profile associated with a party, used to track tax-related information for a specific entity. |
| PartyTypeCode | String | The code that identifies the type of party in the tax authority profile, such as individual, business, or other classifications. |
| AuthorityType | String | The type of authority associated with the party in the tax profile, which could refer to government, regulatory, or financial institutions. |
| PartyName | String | The name of the party as registered in the tax authority profile, which could be an individual, business, or organization. |
| Finder | String | A reference field used to help locate or filter tax authority profiles within the system based on specific search criteria. |
Lists tax classification attributes used for calculating and reporting tax obligations, enabling precise categorization.
| Name | Type | Description |
| LookupType [KEY] | String | The type of lookup used to categorize tax classifications, providing a context or grouping for the classification. |
| LookupCode [KEY] | String | The unique code associated with the lookup type, identifying the specific classification within that type. |
| Meaning [KEY] | String | The textual description or definition of the tax classification, explaining its significance or application. |
| StartDateActive | Date | The date when the tax classification becomes active and applicable for use in the system. |
| EndDateActive | Date | The date when the tax classification is no longer active or valid, marking the end of its applicability. |
| SetId [KEY] | Long | The unique identifier of the set to which the tax classification belongs, often used to group related classifications. |
| BLookupCode | String | An additional lookup code used in conjunction with the main classification code to further categorize the classification. |
| BLookupType | String | An additional lookup type that categorizes the classification with further specification or granularity. |
| BOrgId | Long | The organization identifier associated with the tax classification, indicating the business or legal entity linked to it. |
| BTrxDate | Date | The transaction date when the tax classification was used or updated in the system. |
| ClassificationCode | String | The unique identifier code for the tax classification, used to reference it within the system. |
| ClassificationName | String | The name or title of the tax classification, used for easier identification and search. |
| Finder | String | A reference field used to assist in searching and filtering tax classifications based on specific criteria. |
| SearchTerm | String | A term used to search for or identify tax classifications within the system, allowing for more refined querying. |
Manages records of exempted transactions or entities, allowing authorized users to view, add, or modify tax exemption details.
| Name | Type | Description |
| PartyTypeCode | String | The code indicating the type of party associated with the tax exemption, such as supplier or customer. |
| PartyName | String | The name of the party granted the tax exemption. |
| PartyNumber | String | The unique identifier number associated with the party receiving the tax exemption. |
| PartySiteNumber | String | The site number of the party related to the tax exemption, used to identify the specific location of the party. |
| PartyType | String | The type of party (for example, Customer or Supplier) associated with the tax exemption. |
| ExemptionUsageCode | String | The code used to define the specific activity or purpose for which a tax exemption is granted. |
| TaxRegimeCode | String | The tax regime under which the tax exemption is applied, helping to determine its applicability and calculation. |
| ContentOwner | String | The owner responsible for configuring or managing the tax exemption, such as a legal entity or department. |
| Tax | String | The specific tax or category of tax for which the exemption is applicable. |
| TaxStatusCode | String | The status of the tax exemption, indicating its validity or any special conditions like 'approved', 'rejected', etc. |
| TaxRateCode | String | The tax rate code associated with the tax exemption, defining the rate at which tax is applied to transactions. |
| TaxJurisdictionCode | String | The code identifying the geographic jurisdiction for which the tax exemption is granted. |
| ItemNumber | String | The item number for which the tax exemption applies, especially relevant for product-specific exemptions. |
| Organization | String | The name of the inventory organization associated with the exempted item, relevant for inventory-based tax exemptions. |
| EffectiveFrom | Date | The start date from which the tax exemption is effective and valid. |
| EffectiveTo | Date | The date when the tax exemption expires or stops being valid. |
| ExemptCertificateNumber | String | The unique certificate number identifying the tax exemption, typically issued by the tax authority. |
| RecordingDate | Date | The date when the tax exemption was recorded in the system. |
| IssueDate | Date | The date when the tax exemption was officially issued by the relevant tax authority. |
| ExemptionTypeCode | String | The type of exemption granted, such as DISCOUNT, SURCHARGE, or SPECIAL RATE, indicating how the exemption is applied. |
| RateModifier | Decimal | The percentage rate or modification applied to the tax exemption, such as the exemption percentage. |
| ExemptionStatusCode | String | The status of the exemption, such as PRIMARY, MANUAL, DISCONTINUED, REJECTED, or UNAPPROVED. |
| IssuingTaxAuthority | String | The tax authority that granted the exemption, indicating where the exemption was issued. |
| ApplyToLowerLevelsFlag | Bool | A flag indicating whether the exemption applies to lower tax levels in the tax hierarchy (for example, state, county). |
| SuspendFromDate | Date | The date from which the exemption status is suspended, often due to non-compliance or changes in tax laws. |
| SuspendToDate | Date | The date until which the exemption is suspended, after which the exemption may be reinstated or discontinued. |
| LimitAmount | Decimal | The dollar amount limit associated with the tax exemption, above which the exemption no longer applies. |
| ExemptReasonCode | String | The reason code explaining why the exemption was granted, such as for a particular activity or condition. |
| ClauseReference | String | A reference to the legal clause that justifies or mandates the tax exemption under specific regulations. |
| IssueFlag | Bool | Indicates whether the Letter of Intent for the tax exemption is created and ready for issuance. |
| PartyTypeFlag | Bool | Indicates whether the exemption is applicable to a customer or a supplier, with the default typically set to CUSTOMER. |
| PrintFlag | Bool | A flag that marks whether the tax exemption letter is ready for printing, used for compliance documentation. |
| PartyUsage | String | The intended use of the party (for example, 'Retail', 'Wholesale') related to the tax exemption. |
| Country | String | The country where the tax exemption applies, typically corresponding to national tax regulations. |
| ContentOwnerId | Long | The unique identifier of the content owner responsible for the tax exemption configuration. |
| CustomerAccountId | Long | The unique identifier of the customer account associated with the tax exemption. |
| CustomChargeFlag | Bool | Indicates whether the exemption should apply to custom charges or if it applies to standard tax amounts. |
| DetFactorTemplCode | String | The determining factor template code linked to the tax exemption, helping to define how the exemption is applied. |
| InventoryOrgId | Long | The unique identifier of the inventory organization associated with an item that benefits from the tax exemption. |
| IssuingTaxAuthorityId | Long | The unique identifier of the tax authority that issued the exemption. |
| PartyTaxProfileId | Long | The unique identifier of the party tax profile, providing detailed tax settings for the exemption. |
| ProductId | Long | The unique identifier of the product that the tax exemption applies to, if the exemption is product-specific. |
| RecordTypeCode | String | The code indicating the record type of the tax exemption, used to categorize different exemption types. |
| SiteUseId | Long | The unique identifier of the site use associated with the tax exemption, relevant for location-based exemptions. |
| TaxJurisdictionId | Long | The unique identifier of the tax jurisdiction where the exemption is applicable. |
| TaxExemptionId [KEY] | Long | The unique identifier of the tax exemption record, typically generated by the system. |
| ReportingTypeId | Long | The unique identifier of the reporting type associated with the tax exemption, used for reporting purposes. |
| ReportingCodeId | Long | The unique identifier of the reporting code associated with the tax exemption. |
| ReportingTypeName | String | The name of the reporting type linked to the tax exemption, used for classification in reports. |
| ReportingCodeName | String | The name of the reporting code linked to the tax exemption. |
| ReportingCodeChar | String | The value of the reporting code used for reporting tax exemption details. |
| PartyTaxAllowOffsetTaxFlag | Bool | Indicates whether the party's tax profile allows the use of offset tax calculations for transactions. |
| PartyTaxRoundingLevelCode | String | The rounding level to be applied to the party tax amounts, ensuring compliance with local tax rounding rules. |
| PartyTaxInclusiveTaxFlag | Bool | Indicates whether the party's tax profile has been configured for inclusive tax calculations. |
| PartyTaxClassificationCode | String | The classification code indicating the specific tax treatment for the party's tax profile. |
| PartyTaxRoundingRuleCode | String | The rounding rule applied to party tax amounts, ensuring that tax amounts are rounded correctly. |
| PartyTaxProcessForApplicabilityFlag | Bool | Indicates whether the party's tax profile is part of the tax determination process for transactions. |
| Finder | String | A search helper field to assist with querying tax exemptions based on specific criteria. |
Stores taxpayer identification data (for example, TIN, VAT ID), facilitating correct tax reporting for businesses or individuals.
| Name | Type | Description |
| PartyTypeCode | String | The code indicating the type of party (for example, 'Supplier', 'Customer') for which the tax profile is defined. |
| PartyName | String | The name of the party (for example, organization or individual) associated with the tax profile. |
| PartyNumber | String | The unique number assigned to the party for tax purposes. |
| PartySiteNumber | String | The site number associated with the party, identifying a specific location for tax registration. |
| ValidationType | String | The type of validation applied to ensure the correctness of the taxpayer identifier. |
| TaxPayerNumber | String | The tax identification number assigned to the party for tax reporting and compliance. |
| ValidationDigit | String | A validation digit used as part of the Tax Indentification Number (TIN) to confirm its validity. |
| EffectiveFrom | Date | The start date when the taxpayer identifier becomes valid for the specified period. |
| EffectiveTo | Date | The end date when the taxpayer identifier is no longer valid. |
| ReportingTypeCode | String | The code indicating the reporting type for the taxpayer identifier, used in tax filings. |
| CountryCode | String | The country code for the country where the tax registration number is issued or applicable. |
| ValidationLevel | String | The level at which validations are applied to avoid duplicates in registration numbers. |
| UniquenessValidationLevel | String | The specific level at which the system performs checks to identify duplicate tax registration numbers. |
| RegistrationTypeCode | String | The classification of the tax registration specified by the tax authority for reporting purposes. |
| CountryName | String | The name of the country where the taxpayer is registered for tax purposes. |
| EntityId | Long | The unique identifier for the entity linked to the taxpayer identifier. |
| PartyTaxpayerIdntfsId [KEY] | Long | The system-generated primary key identifier for the taxpayer record. |
| TaxpayerCountry | String | The country where the taxpayer is registered for tax purposes. |
| PartyTaxAllowOffsetTaxFlag | Bool | Indicates whether the party's tax profile allows for offset tax calculation. Default is NO. |
| PartyTaxRoundingLevelCode | String | Specifies the rounding rules applied to party tax amounts during transactions. |
| PartyTaxInclusiveTaxFlag | Bool | Indicates whether the party's tax profile allows for inclusive tax calculation. Default is NO. |
| PartyTaxClassificationCode | String | The tax classification code used for the party's tax profile associated with the taxpayer identifier. |
| PartyTaxRoundingRuleCode | String | The rounding rule applied to the party's tax profile associated with the taxpayer identifier. |
| PartyTaxProcessForApplicabilityFlag | Bool | Indicates whether the party tax profile is used in the tax determination process for transactions. |
| Country | String | The country associated with the taxpayer identifier. |
| Finder | String | A helper field used for searching and filtering taxpayer identifiers. |
Associates suppliers or customers with fiscal classifications, determining how transactions are taxed or reported.
| Name | Type | Description |
| CodeAssignmentId [KEY] | Long | The unique identifier for the code assignment related to third-party fiscal classifications. |
| PartyNumber | String | The identification number of the third-party entity linked to the fiscal classification. |
| ClassTypeCode | String | The code representing the type of fiscal classification (for example, tax-exempt, VAT, etc.). |
| ClassCode | String | The specific fiscal classification code assigned to the third party for tax purposes. |
| StartDateActive | Date | The date when the third party's fiscal classification becomes effective. |
| EndDateActive | Date | The date when the third party's fiscal classification stops being effective. |
| PartyName | String | The name of the third party associated with the fiscal classification. |
| BindPartyNumber | String | The identification number of the party to which the fiscal classification is bound. |
| BindPartyTaxProfileId | Long | The unique identifier of the tax profile for the party bound to the fiscal classification. |
| Finder | String | A search field used to locate third-party fiscal classification records. |
Manages fiscal classifications at the site level (for example, supplier site), defining local tax or regulatory requirements.
| Name | Type | Description |
| CodeAssignmentId [KEY] | Long | The unique identifier for the code assignment related to third-party site fiscal classifications. |
| ClassTypeCode | String | The code representing the type of fiscal classification (for example, tax-exempt, VAT, etc.) applied to a third-party site. |
| ClassCode | String | The specific fiscal classification code assigned to the third-party site for tax purposes. |
| StartDateActive | Date | The date when the fiscal classification for the third-party site becomes effective. |
| EndDateActive | Date | The date when the fiscal classification for the third-party site stops being effective. |
| PartySiteNumber | String | The identification number of the third-party site linked to the fiscal classification. |
| PartyNumber | String | The identification number of the third party associated with the fiscal classification. |
| PartyName | String | The name of the third party associated with the fiscal classification of the third-party site. |
| PartySiteName | String | The name of the third-party site associated with the fiscal classification. |
| BPartyNumber | String | The identification number of the bound third party for fiscal classification. |
| BPartySiteNumber | String | The identification number of the bound third-party site for fiscal classification. |
| BPartyTaxProfileId | Long | The unique identifier of the bound party's tax profile associated with the third-party site fiscal classification. |
| Finder | String | A search field used to locate third-party site fiscal classification records. |
Links site-level entities to tax reporting codes, ensuring accurate data capture for compliance and audit needs.
| Name | Type | Description |
| ReportingCodeAssocId [KEY] | Long | The unique identifier for the association between the third-party site and the reporting code, linking them in the tax reporting process. |
| PartyNumber | String | The unique identification number assigned to the third party associated with the tax reporting code. |
| PartySiteNumber | String | The unique identification number assigned to the third-party site involved in the tax reporting code association. |
| TaxReportingTypeCode | String | The code representing the type of tax reporting being applied, such as VAT or Sales Tax. |
| ReportingCodeCharValue | String | The alphanumeric value of the reporting code, representing specific tax details or classification. |
| ReportingCodeDateValue | Date | The date value of the reporting code, which could correspond to a relevant tax event or transaction date. |
| ReportingCodeNumericValue | Long | The numeric value of the reporting code, often used for financial calculations or reporting purposes. |
| EffectiveFrom | Date | The start date when the association between the third-party site and the reporting code becomes effective. |
| EffectiveTo | Date | The end date when the association between the third-party site and the reporting code stops being valid. |
| PartyName | String | The name of the third party associated with the tax reporting code. |
| PartySiteName | String | The name of the third-party site associated with the tax reporting code. |
| PartyTaxProfileId | Long | The unique identifier of the party's tax profile, linking the third-party site to tax-related information. |
| BPartyNumber | String | The identification number of the bound third party for the tax reporting code association. |
| BPartySiteNumber | String | The identification number of the bound third-party site for the tax reporting code association. |
| BPartyTaxProfileId | Long | The unique identifier of the bound party's tax profile, which links the third-party site to tax reporting codes. |
| Finder | String | A search field used to locate third-party site tax reporting code associations in the system. |
Establishes tax reporting code relationships for third parties, enabling efficient retrieval of tax data across transactions.
| Name | Type | Description |
| ReportingCodeAssocId [KEY] | Long | The unique identifier for the association between the third party and the reporting code, linking them for tax reporting purposes. |
| PartyNumber | String | The unique identification number of the third party involved in the tax reporting code association. |
| TaxReportingTypeCode | String | The code used to categorize the type of tax reporting, such as VAT or Sales Tax, applicable to the third-party. |
| ReportingCodeCharValue | String | The alphanumeric value representing the specific reporting code assigned to the third party for tax purposes. |
| ReportingCodeDateValue | Date | The date value associated with the reporting code, typically reflecting the date the tax reporting event occurred. |
| ReportingCodeNumericValue | Long | The numeric value associated with the reporting code, often used for financial calculations in tax reporting. |
| EffectiveFrom | Date | The start date from which the association of the third party with the reporting code is valid and effective. |
| EffectiveTo | Date | The end date up to which the third-party and reporting code association is valid. |
| PartyName | String | The name of the third party associated with the reporting code for tax reporting purposes. |
| PartyTaxProfileId | Long | The unique identifier of the third party's tax profile that is linked to the tax reporting code association. |
| BPartyNumber | String | The identification number of the bound third party for the tax reporting code association, if applicable. |
| BPartyTaxProfileId | Long | The unique identifier of the bound third party's tax profile, if relevant for the tax reporting code association. |
| Finder | String | A search field used to locate third-party tax reporting code associations in the system. |
Displays recognized Receivables transaction sources (for example, manual, import), guiding consistent transaction entry practices.
| Name | Type | Description |
| TransactionSourceId [KEY] | Long | The unique identifier for the transaction source, used to distinguish between different transaction sources in the system. |
| Description | String | A textual description that provides details or context about the transaction source, helping users understand its purpose. |
| Name | String | The name of the transaction source, used as a label or reference for identifying the source in the system. |
| SetName | String | The name of the set to which the transaction source belongs, used for grouping related transaction sources together. |
| Finder | String | A search field used to locate specific transaction sources in the system based on predefined criteria. |
Allows the creation, retrieval, and modification of manual tax lines for a transaction, ensuring accurate tax posting.
| Name | Type | Description |
| TaxLineId [KEY] | Long | The unique identifier of the tax line in a transaction. |
| TrxId | Long | The identifier of the transaction to which the tax line is associated. |
| TrxLineId | Long | The identifier of the transaction line associated with this tax line. |
| TrxLineNumber | Long | The number of the transaction line that corresponds to the tax line. |
| TaxLineNumber | Int | The unique number assigned to the tax line for identification. |
| TaxRateName | String | The name of the tax rate applied to the transaction line. |
| TaxRateId | Long | The identifier of the tax rate applied to the transaction line. |
| TaxRateCode | String | The code for the tax rate applied to the transaction line. |
| TaxRate | Decimal | The percentage or amount of the tax rate applied. |
| TaxAmount | Decimal | The total tax amount applied to the transaction line. |
| TaxableAmount | Decimal | The amount on which the tax is calculated (i.e., the taxable base). |
| UnroundedTaxAmount | Decimal | The tax amount before rounding adjustments are made. |
| UnroundedTaxableAmount | Decimal | The taxable amount before rounding adjustments are made. |
| Cancelled | String | Indicates whether the tax line has been cancelled (for example, 'Y' for yes, 'N' for no). |
| TaxAmountIncluded | String | Indicates whether the tax amount is included in the price (for example, 'Y' or 'N'). |
| SelfAssessed | String | Indicates whether the tax was self-assessed (for example, 'Y' or 'N'). |
| TaxOnlyLine | String | Indicates whether the line is for tax only (for example, 'Y' or 'N'). |
| TaxRegimeCode | String | The code identifying the tax regime applicable to the transaction line. |
| TaxRegimeId | Long | The identifier of the tax regime applicable to the transaction. |
| Tax | String | The tax code applied to the transaction line. |
| TaxId | Long | The unique identifier for the specific tax applied. |
| TaxJurisdictionCode | String | The code of the jurisdiction where the tax is applicable. |
| TaxJurisdictionId | Long | The unique identifier of the tax jurisdiction. |
| TaxStatusCode | String | The code representing the status of the tax line (for example, 'COMPLETED', 'PENDING'). |
| TaxStatusId | Long | The unique identifier of the tax status applied to the line. |
| WhtTaxClassificationCode | String | The withholding tax classification code for the tax line. |
| ExemptCertificateNumber | String | The certificate number indicating an exemption from tax. |
| TaxPointBasis | String | The basis for determining the tax point, such as 'Invoice' or 'Delivery'. |
| TaxPointDate | Date | The date when the tax point occurs, which may differ from the transaction date. |
| PlaceOfSupplyTypeCode | String | The type code for the place of supply (for example, 'DOMESTIC', 'EXPORT'). |
| TrxLevelType | String | The level at which the tax line is applied (for example, 'LINE', 'HEADER'). |
| InternalOrganizationId | Long | The unique identifier of the internal organization within the system. |
| ApplicationId | Long | The identifier of the application under which the tax line is processed. |
| EntityCode | String | The entity code that is related to the tax line. |
| EventClassCode | String | The event class code associated with the transaction tax line. |
| WhtGroupId | Long | The group identifier for withholding tax related to the tax line. |
| TrxNumber | String | The transaction number associated with the tax line. |
| TaxJurisdictionName | String | The name of the tax jurisdiction where the tax is applied. |
| TaxRegimeName | String | The name of the tax regime applicable to the transaction. |
| TaxStatusName | String | The name of the status associated with the tax line. |
| SummaryTaxLineId | Long | The identifier of the summary tax line, if applicable. |
| LineAmount | Decimal | The amount of the transaction line to which the tax is applied. |
| TaxDetermineDate | Date | The date when the tax was determined, which may differ from the transaction date. |
| TaxDate | Date | The date when the tax is due for payment or reporting. |
| TaxRateType | String | The type of tax rate applied (for example, 'STANDARD', 'REDUCED'). |
| ContentOwnerId | Long | The unique identifier of the content owner associated with the tax line. |
| Finder | String | A search field for locating specific tax lines within the system. |
Presents valid Receivables transaction types (for example, invoice, debit memo) for referencing in billing and revenue processes.
| Name | Type | Description |
| TransactionTypeId [KEY] | Long | The unique identifier of the transaction type. |
| Name | String | The name of the transaction type. |
| Description | String | A brief description of the transaction type. |
| SetName | String | The set name to which the transaction type belongs. |
| Finder | String | A search field to locate specific transaction types within the system. |
Holds value set definitions, ensuring controlled vocabularies and standardized validation for various fields.
| Name | Type | Description |
| ValueSetId [KEY] | Long | The unique identifier assigned to the value set, distinguishing it from other value sets. |
| ModuleId | String | The identifier of the module associated with the value set, which helps in linking the value set to a specific module. |
| ValueSetCode | String | The code used to identify the value set, which is typically used in system references. |
| Description | String | A brief description of the value set, explaining its purpose or content. |
| ValidationType | String | The type of validation applied to the values within the set, which could be a range, list, or custom validation rule. |
| ValueDataType | String | The data type associated with the values in the set, such as string, number, or date. |
| ValueSubtype | String | An optional subtype for further categorizing values in the set. |
| ProtectedFlag | String | Indicates whether the value set is protected against modifications or updates (for example, 'Y' or 'N'). |
| MaximumLength | Int | The maximum length (in characters) allowed for a value in the set. |
| Precision | Int | The maximum number of digits allowed for a value in the set, particularly relevant for numeric values. |
| Scale | Int | The maximum number of digits allowed to the right of the decimal point for numeric values. |
| UppercaseOnlyFlag | String | Indicates whether values in the set must be uppercase (for example, 'Y' or 'N'). |
| ZeroFillFlag | String | Indicates whether values should be zero-padded to meet the required length (for example, 'Y' or 'N'). |
| SecurityEnabledFlag | String | Indicates whether data security is enabled for the value set (for example, 'Y' or 'N'). |
| DataSecurityObjectName | String | The name of the data security object, if any, that is used to secure access to the value set. |
| MinimumValue | String | The minimum allowed value for the set, which can be a string, number, or date. |
| MinimumValueNumber | Decimal | The minimum permitted numerical value in the set. |
| MinimumValueDate | Date | The minimum permitted date value for the set. |
| MinimumValueTimestamp | Datetime | The minimum permitted timestamp for the value set. |
| MaximumValue | String | The maximum allowed value for the set, which can be a string, number, or date. |
| MaximumValueNumber | Decimal | The maximum permitted numerical value in the set. |
| MaximumValueDate | Date | The maximum permitted date value for the set. |
| MaximumValueTimestamp | Datetime | The maximum permitted timestamp for the value set. |
| IndependentValueSetId | Long | The ID of the independent value set, if this set is associated with one. |
| IndependentValueSetCode | String | The code of the independent value set, if applicable. |
| CreationDate | Datetime | The date when the value set record was created. |
| CreatedBy | String | The user who created the value set record. |
| LastUpdateDate | Datetime | The date when the value set record was last updated. |
| LastUpdatedBy | String | The user who last updated the value set record. |
| Finder | String | A general-purpose field used for searching or filtering value sets. |
Specifies the underlying validation table for value sets, directing how lookups and data checks occur.
| Name | Type | Description |
| ValueSetsValueSetId [KEY] | Long | The unique identifier assigned to the value set, used to distinguish it from other value sets. |
| ValueSetId [KEY] | Long | The unique identifier of the validation table, representing the table used for validation. |
| FromClause | String | The FROM clause in the SQL query, defining the source tables for the data retrieval. |
| WhereClause | String | The WHERE clause in the SQL query, used to filter the data based on specified conditions. |
| OrderByClause | String | The ORDER BY clause in the SQL query, which determines how the resulting data is sorted, if applicable. |
| ValueColumnName | String | The name of the column in the validation table that stores the actual value for the value set. |
| ValueColumnLength | Int | The length (in characters) of the value column, indicating the maximum allowable size for the values. |
| ValueColumnType | String | The data type of the value column, which defines the kind of data it can store (for example, string, integer, date). |
| IdColumnName | String | The name of the column that holds the ID, if applicable, for identifying rows uniquely. |
| IdColumnLength | Int | The length (in characters) of the ID column, indicating the maximum allowable size for the ID. |
| IdColumnType | String | The data type of the ID column, which defines the kind of data it can store (for example, string, integer). |
| DescriptionColumnName | String | The name of the column that stores descriptions related to the values, if applicable. |
| DescriptionColumnLength | Int | The length (in characters) of the description column, indicating the maximum allowable size for descriptions. |
| DescriptionColumnType | String | The data type of the description column, which defines the kind of data it can store (for example, string, text). |
| EnabledFlagColumnName | String | The name of the column that indicates whether a value is enabled or not, typically represented as a Boolean flag. |
| StartDateColumnName | String | The name of the column that stores the start date for the validity of the value set, if applicable. |
| EndDateColumnName | String | The name of the column that stores the end date for the validity of the value set, if applicable. |
| ValueAttributesTableAlias | String | The alias for the table containing the value attribute columns, if any, used for referencing in the query. |
| CreationDate | Datetime | The date and time when the record was created in the system. |
| CreatedBy | String | The user who created the record in the system. |
| LastUpdateDate | Datetime | The date and time when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| Finder | String | A general-purpose field used for searching or filtering records in the system. |
| ValueSetCode | String | The code used to identify the value set, typically a short string that references the set in the system. |
Lists permissible values in a specific value set, enforcing consistency in data entry across modules.
| Name | Type | Description |
| ValueSetsValueSetId [KEY] | Long | The unique identifier of the value set, used to distinguish one value set from another. This ID helps in referencing and associating values with their corresponding set. |
| ValueId [KEY] | Long | The unique identifier of a value within a specific value set. This allows each value in a set to be uniquely tracked and referenced. |
| IndependentValue | String | The independent value that stands alone without any dependencies on other values within the set, typically used for values that are self-explanatory or constants. |
| IndependentValueNumber | Decimal | The numeric representation of the independent value, which is used when the value can be represented as a number (for calculations or processing). |
| IndependentValueDate | Date | The date representation of the independent value, useful when the value pertains to a specific date, such as due dates or deadlines. |
| IndependentValueTimestamp | Datetime | The timestamp representation of the independent value, used when the value is associated with a specific moment in time, including both date and time. |
| Value | String | The actual value stored within the value set. This could be any business-relevant data like a code, name, or other identifier. |
| ValueNumber | Decimal | The numeric representation of the value, used for numeric-based values that require arithmetic or financial calculations. |
| ValueDate | Date | The date representation of the value, applicable for values that are time-bound or depend on specific dates. |
| ValueTimestamp | Datetime | The timestamp representation of the value, which includes both date and time components for precise records. |
| TranslatedValue | String | The translated version of the value, typically used in multi-language environments where the value needs to be represented in different languages. |
| Description | String | A textual description of the value, providing context or additional details about what the value represents or how it is used. |
| EnabledFlag | String | Indicates whether the value is enabled ('Y' for Yes, 'N' for No). This flag determines if the value is active and can be used within the system. |
| StartDateActive | Date | The start date from which the value becomes active and valid for use in the system or business processes. |
| EndDateActive | Date | The end date until which the value remains active and valid. After this date, the value may no longer be usable. |
| SortOrder | Long | The order in which the value should appear when listed among other values in a set. Used for organizing values in a meaningful sequence. |
| SummaryFlag | String | A flag indicating whether the value is a summary value ('Y' for Yes, 'N' for No). Summary values are typically used for grouping or aggregating data. |
| DetailPostingAllowed | String | Indicates whether posting transactions using this value is permitted ('Y' for Yes, 'N' for No). This flag ensures that only valid values are used for accounting purposes. |
| DetailBudgetingAllowed | String | Indicates whether budgeting with this value is allowed ('Y' for Yes, 'N' for No). This determines if the value can be used in budget-related processes. |
| AccountType | String | The account type associated with the value (for example, asset, liability, expense). It defines the nature of the account that the value belongs to. |
| ControlAccount | String | The control account associated with the value, used for managing financial transactions and ensuring the proper allocation of entries in accounting systems. |
| ReconciliationFlag | String | Indicates whether reconciliation is required for this value ('Y' for Yes, 'N' for No). This ensures that the value is included in the reconciliation process to maintain data integrity. |
| FinancialCategory | String | The financial category under which the value falls (for example, income, expense, asset). It helps in categorizing financial entries for easier reporting and analysis. |
| ExternalDataSource | String | The location of the external data source if the value is maintained externally, indicating where the value data is sourced from outside the system. |
| CreationDate | Datetime | The date and time when the record was created in the system. This helps in tracking when the value was added. |
| CreatedBy | String | The user who created the record in the system, providing accountability for record creation. |
| LastUpdateDate | Datetime | The date and time when the record was last updated in the system. This helps track the most recent changes made to the value. |
| LastUpdatedBy | String | The user who last updated the record. This allows tracking of who made the most recent changes to the value. |
| Finder | String | A general-purpose field used for searching or filtering records in the system, aiding users in quickly locating specific values. |
| ValueSetCode | String | The code identifying the value set to which the value belongs, enabling easy reference and organization of values within sets. |
| ValueSetId | Long | The identifier of the value set associated with this value. It helps link values to their respective sets for structured management. |
Maintains entries for withholding tax computations, supporting creation, retrieval, and updates to withholdings on transactions.
| Name | Type | Description |
| TaxLineId [KEY] | Long | The unique identifier for a tax line, used to track and reference individual tax records in the system. |
| TrxId | Long | The unique identifier of the transaction to which the tax line is associated, linking the tax line to the specific transaction. |
| TrxLineId | Long | The unique identifier of the transaction line, connecting the tax line to a specific item or service in the transaction. |
| TrxLineNumber | String | The number of the transaction line, used to identify the order or sequence of transaction lines within a transaction. |
| TaxLineNumber | Long | The unique number assigned to the tax line, indicating its position in the list of tax lines for a given transaction. |
| TaxRateName | String | The name of the tax rate applied to the transaction, providing a descriptive label for the tax type used (for example, VAT, sales tax). |
| TaxRateCode | String | The code representing the tax rate applied, used for referencing specific tax rates in the system. |
| TaxRateId | Long | The unique identifier of the tax rate, linking the tax line to a particular rate definition in the system. |
| TaxRate | Long | The percentage rate applied to the transaction to calculate the tax amount. This could be a flat rate or variable depending on jurisdiction. |
| UnroundedTaxAmount | Long | The calculated tax amount before any rounding is applied, often used for reporting purposes or to adjust for precise tax calculations. |
| TaxAmount | Decimal | The final amount of tax calculated for the transaction, taking into account the tax rate and any adjustments or rounding. |
| Cancelled | String | Indicates whether the tax line has been cancelled ('Y' for Yes, 'N' for No). This field tracks whether the tax has been voided or reversed. |
| CalculationPoint | String | The point in the transaction process at which tax is calculated (for example, invoice date, shipment date). Determines when the tax obligation is recognized. |
| TaxRegimeCode | String | The code identifying the tax regime that governs the tax rate applied, such as VAT, sales tax, or other jurisdiction-specific tax rules. |
| TaxRegimeId | Long | The unique identifier of the tax regime that applies to the transaction, allowing system users to link tax lines to specific tax policies. |
| Tax | String | The specific tax applied to the transaction, such as VAT, sales tax, or excise duty, defining the type of tax being levied. |
| TaxId | Long | The unique identifier of the tax associated with the tax line, allowing the system to link the tax line to specific tax rules and calculations. |
| TaxStatusCode | String | The status code of the tax line, indicating its current state (for example, applied, unapplied, pending). |
| TaxStatusId | Long | The unique identifier of the tax status, used to track the progress of the tax line in the tax processing cycle. |
| TaxJurisdictionCode | String | The code identifying the tax jurisdiction, such as the country or region, where the tax is applied, ensuring compliance with local tax laws. |
| TaxJurisdictionId | Long | The unique identifier of the tax jurisdiction, which is used to link the tax line to specific geographic tax rules and authorities. |
| TrxLevelType | String | The level at which the tax is applied (for example, line level or transaction level). This helps in determining whether tax is calculated for individual items or the whole transaction. |
| InternalOrganizationId | Long | The unique identifier of the internal organization responsible for processing the tax line, allowing for the management of tax liabilities by organizational units. |
| ApplicationId | Long | The unique identifier of the application that processed the tax line, helping track which module or system component generated the tax entry. |
| EntityCode | String | The code representing the entity that owns the tax line, which could refer to different business units, departments, or legal entities. |
| EventClassCode | String | The code for the event class associated with the tax line, identifying the type of event (for example, sale, purchase) that triggered the tax calculation. |
| TaxApportionmentLineNumber | Long | The line number used for tax apportionment when the tax is shared across multiple transactions or parties. |
| TaxJurisdictionName | String | The name of the tax jurisdiction, such as the country or region where the tax is being levied. |
| TaxRegimeName | String | The name of the tax regime that governs the tax, such as VAT, which dictates the rules under which the tax is applied. |
| TaxStatusName | String | The name of the tax status, indicating the current state of the tax line (for example, applied, unapplied, pending). |
| SummaryTaxLineId | Long | The unique identifier of the summary tax line, used when the tax line is part of a summarized or aggregated tax amount. |
| Finder | String | A general-purpose field used for searching or filtering tax lines in the system, making it easier for users to find relevant records. |
Records details of workflow participants, mapping users to roles or steps in financial approvals and notifications.
| Name | Type | Description |
| Username | String | The unique username assigned to the workflow user, used for logging into the system and performing workflow-related tasks. |
| FirstName | String | The first name of the workflow user, used for identification and communication purposes. |
| LastName | String | The last name of the workflow user, used in conjunction with the first name for full identification. |
| EmailAddress | String | The email address associated with the workflow user, used for sending notifications and communications related to the workflow. |
| ManagerName | String | The name of the manager associated with the workflow user, indicating the user's supervisor or responsible authority within the organization. |
| WorkflowName | String | The name of the workflow that the user is associated with, identifying the specific workflow process they are part of. |
| TransactionIdentifier | String | A unique identifier for the transaction that the workflow user is handling or associated with, helping track specific tasks within workflows. |
| LoggedInUser | String | Indicates whether the user is currently logged into the system, reflecting the user's active status. |
| PersonId [KEY] | String | A unique identifier assigned to the person linked with the workflow user, typically used to match system records with a specific individual. |
| String | The primary email address of the workflow user, used for communication and notifications regarding workflow activities. | |
| Finder | String | A general-purpose field designed for searching or filtering workflow users based on certain criteria. |
| SearchString | String | A text string used to perform searches for workflow users, facilitating quick lookups and filtering within the system. |
| UserID | String | A unique identifier for the workflow user, ensuring proper assignment of tasks, responsibilities, and permissions within the workflow system. |
In the Procurement Data Model schema, the Sync App models information such as suppliers, purchase orders, and shopping lists associated with the authenticated account as an easy-to-use SQL database. Live connectivity to these objects means that any changes to your Oracle Fusion Cloud Financials account are immediately reflected in the Sync App.
The Tables section, which details standard SQL tables, and the Views section, which lists read-only SQL tables, contain samples of what you might have access to in your Oracle Fusion Cloud Financials account.
Common tables include:
| Table | Description |
| PurchaseOrders | Represents finalized purchase orders for goods or services from external suppliers, capturing key terms and statuses. |
| PurchaseOrderslines | Lists line-level details within a purchase order, specifying items, quantities, unit prices, and related buying terms. |
| PurchaseOrderslinesschedules | Defines the planned shipment dates and delivery details for each line item in a purchase order. |
| PurchaseOrderslinesschedulesdistributions | Allocates purchase order schedule costs to particular accounts or projects, ensuring accurate financial tracking. |
| PurchaseRequisitions | Handles internal purchase requests for items or services, capturing details for eventual PO creation or approval. |
| PurchaseRequisitionslines | Displays item-level details (part, quantity, pricing) for each line in the requisition, forming the basis for purchasing decisions. |
| PurchaseAgreementLines | Describes goods or services in a purchase agreement, excluding delivery or fulfillment specifics, to outline negotiated items. |
| PurchaseAgreements | Holds purchase agreement headers (quantity- or value-based) with negotiated terms, used by subsequent POs or contracts. |
| Suppliers | Manages core supplier records, including contact details, addresses, business classifications, and attachments. |
| Suppliersaddresses | Captures location data for suppliers, such as physical or mailing addresses, to support invoicing and shipping. |
| Supplierscontacts | Maintains supplier contact records, including names, emails, and roles for consistent communication and procurement updates. |
| ProcurementApprovedSupplierListEntries | Tracks relationships between suppliers and the items or categories they’re approved to supply, ensuring compliance and vendor checks. |
| PurchaseOrdersattachments | Stores documents (for example, contracts, specifications) linked to a purchase order, enhancing detail for audits or approvals. |
| PurchaseRequisitionsattachments | Maintains documents attached to purchase requisitions, such as quotes, justifications, or requirement definitions. |
| PurchaseOrdersDFF | Captures additional descriptive flexfield data at the purchase order header level, allowing custom fields. |
| PurchaseRequisitionslinesdistributions ; | Splits the requisition line cost across multiple accounts or projects, aiding correct budget and financial reporting. |
| RequisitionProcessingRequests | Handles the conversion of approved requisition lines into purchase documents (for example, purchase orders), orchestrating the procurement flow. |
| WorkConfirmations | Handles confirmations of completed work for complex service or construction purchase orders, aiding accurate billing and progress tracking. |
| SupplierNegotiationResponses | Retrieves supplier-submitted responses to sourcing negotiations (for example, RFI, RFQ), offering visibility into proposed terms and pricing. |
| PublicShoppingLists | Defines public shopping list headers, grouping related items for streamlined requisition or bulk purchasing. |
Stored Procedures are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, including modifying agreements and uploading attachments.
The Sync App models the data in Oracle Fusion Cloud Financials as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| ApprovedSupplierListSourceDocuments | Links source documents (like contracts or quotes) to approved supplier list entries, ensuring that procurement references are accurate and accessible. |
| ApprovedSupplierListSourceDocumentsDFF | Holds descriptive flexfields related to source documents on the approved supplier list, capturing extra procurement details. |
| DraftPurchaseOrders | Maintains partially completed purchase orders not yet communicated to suppliers, tracking preliminary details for further updates. |
| DraftPurchaseOrderslinesschedules | Manages shipping schedules, delivery dates, and receiving locations for each line in a draft purchase order. |
| PurchaseRequisitions | Handles internal purchase requests for items or services, capturing details for eventual PO creation or approval. |
| PurchaseRequisitionslines | Displays item-level details (part, quantity, pricing) for each line in the requisition, forming the basis for purchasing decisions. |
| Suppliers | Manages core supplier records, including contact details, addresses, business classifications, and attachments. |
| Suppliersaddresses | Captures location data for suppliers, such as physical or mailing addresses, to support invoicing and shipping. |
| Supplierscontacts | Maintains supplier contact records, including names, emails, and roles for consistent communication and procurement updates. |
Links source documents (like contracts or quotes) to approved supplier list entries, ensuring that procurement references are accurate and accessible.
The Sync App uses the Oracle Fusion Cloud Financials API to process some of the filters having queryable=true in metadata. The Sync App processes other filters within the Sync App.
For example, the following query is processed server side:
SELECT * FROM [Cdata].[Procurement].[ApprovedSupplierListSourceDocuments] WHERE AslSourceDocumentsId = 10003
Create an ApprovedSupplierListSourceDocument.
INSERT into ApprovedSupplierListSourceDocuments(ProcurementBU,Supplier,SupplierSite,Item,AgreementType,Agreement,AgreementLine) values ('UK Business Unit','Edison Co','Edison UK','WT800127','Blanket Purchase Agreement','6247',1)
The Oracle Fusion Cloud Financials API uses AslSourceDocumentsUniqId instead of AslSourceDocumentsId as a path parameter in the URL to update the record.
If you want to update a record directly using the id (without any other filter), you can update the record in the following way:
Update [Cdata].[Procurement].[ApprovedSupplierListSourceDocuments] set Item='RCV-100' where AslSourceDocumentsUniqId=454545454;
Note: This does not require any extra GET request to retrieve the UniqId.
Alternatively, if you want to apply any other filter. Please use AslSourceDocumentsId instead of AslSourceDocumentsUniqId. You can update the record in the following way:
Update [Cdata].[Procurement].[ApprovedSupplierListSourceDocuments] set Item='RCV-100' where AslSourceDocumentsId=454545454 and Item='RCV-14';
Note : Update on aggregates are not allowed by API, use the child tables to add/update/delete aggregates.
The Oracle Fusion Cloud Financials API uses AslSourceDocumentsUniqId instead of AslSourceDocumentsId as a path parameter in the URL to delete the record.
If you want to delete a record directly using the id (without any other filter), you can delete the record in the following way:
Delete from [Cdata].[Procurement].[ApprovedSupplierListSourceDocuments] where AslSourceDocumentsUniqId=454545454;
Note: This does not require any extra GET request to retrieve the UniqId.
Alternatively, if you want to apply any other filter. Please use AslSourceDocumentsId instead of AslSourceDocumentsUniqId. You can delete the record in the following way:
Delete from [Cdata].[Procurement].[ApprovedSupplierListSourceDocuments] where AslSourceDocumentsId=454545454 and Item='RCV-14';
| Name | Type | ReadOnly | Description |
| AslSourceDocumentsId [KEY] | Long | False |
Unique identifier for the source document related to the approved supplier list entry. This ID is used to link a specific supplier list entry to the corresponding document in the system. |
| AslSourceDocumentsUniqId [KEY] | String | True |
A unique identifier for the source document. This value should be used for insert, update, and delete operations, replacing the use of `AslSourceDocumentsId` to ensure proper management of operations related to the source document. |
| AslId | Long | False |
A unique identifier for each entry in the approved supplier list. This ID is essential for distinguishing individual supplier list entries and is used to link to other related data. |
| AslAttributesId | Long | False |
Identifier for the specific supplier item attribute related to the approved supplier list entry. It connects the supplier list entry to its corresponding supplier attributes such as pricing, delivery terms, or product specifications. |
| ProcurementBUId | Long | False |
Unique identifier for the business unit responsible for managing and owning the approved supplier list entry. This value helps to define the ownership of the list and its operations within the procurement process. |
| ProcurementBU | String | False |
The name of the business unit that manages the purchasing document associated with the approved supplier list entry. This field helps identify the responsible unit within the organization. |
| ScopeCode | String | True |
A code that indicates whether the approved supplier list entry is specific to a ship-to organization or applies to all organizations serviced by the procurement business unit. This helps define the scope of use for the supplier list. |
| Scope | String | True |
Indicates whether the approved supplier list entry applies to a specific ship-to organization or all organizations within the procurement business unit. This field is important for determining the reach of the list. |
| ShipToOrganizationId | Long | False |
Unique identifier for the inventory organization that receives the item from the supplier. This value is used to track the organization receiving and managing the goods supplied. |
| ShipToOrganization | String | False |
The name of the inventory organization to which the supplier should deliver the goods. This helps specify where the goods are to be shipped within the organization. |
| ItemId | Long | False |
Unique identifier for the item associated with the approved supplier list entry. This ID is used to track and identify individual products or services related to the supplier list. |
| Item | String | False |
Refers to any goods or services that a business purchases, sells, or manufactures, including parts, components, subassemblies, finished products, or supplies. |
| SupplierId | Long | False |
Unique identifier for the supplier responsible for fulfilling the order. This field is used to track and identify the specific supplier providing goods or services. |
| Supplier | String | False |
The organization or individual that provides goods or services to the buying organization in exchange for payment, bound by a contractual agreement. |
| SupplierSiteId | Long | False |
Unique identifier for the location where the supplier fulfills the order. This field helps track the supplier’s location used to complete the delivery or service. |
| SupplierSite | String | False |
The name or identifier of the location that the supplier uses to fulfill the order. This may include a warehouse, shipping facility, or other operational site. |
| AgreementTypeCode | String | False |
A code that identifies the type of agreement associated with the requested item. This helps to categorize the agreement, such as a blanket purchase agreement or a contract purchase agreement. |
| AgreementType | String | False |
Describes the type of agreement associated with the approved supplier list entry. This can include a blanket purchase agreement (for ongoing purchases) or a contract purchase agreement (for specific purchases). |
| AgreementId | Long | False |
Unique identifier for the header of the purchasing document associated with the approved supplier list entry. This field links the supplier list entry to the overarching purchase agreement. |
| Agreement | String | False |
The formal contract that outlines the terms and conditions of a purchase. This document governs the business relationship between the buyer and supplier. |
| AgreementLineId | Long | False |
Unique identifier for the line item in the purchasing document related to the approved supplier list entry. This value helps to associate each entry with a specific line in the purchase agreement. |
| AgreementLine | Decimal | False |
The line number within the purchasing document that corresponds to the approved supplier list entry. This value is used to identify which line in the agreement the item is associated with. |
| AgreementStatus | String | True |
Indicates the current status of the agreement, such as 'Incomplete', 'Open', or 'Closed'. This field tracks the lifecycle stage of the purchasing document. |
| AgreementStartDate | Date | True |
The date when the terms of the agreement become effective and applicable. This marks the start of the agreement’s validity period. |
| AgreementEndDate | Date | True |
The date after which the agreement is no longer valid. This field helps to define the expiration of the agreement and when it should no longer be used. |
| DFF | String | False |
This column is used only for insert operations. For updates and deletions, the child table's operations should be used, ensuring that changes are applied in a consistent and reliable manner. |
| Finder | String | True |
A field used to locate specific records in the system. It can contain search criteria or keywords to help users quickly find relevant supplier list entries. |
| EffectiveDate | Date | True |
A query parameter used to fetch resources that are effective as of the specified start date. This helps to ensure that only records that are valid as of the given date are returned. |
Holds descriptive flexfields related to source documents on the approved supplier list, capturing extra procurement details.
The Sync App uses the Oracle Fusion Cloud Financials API to process some of the filters having queryable=true in metadata. The Sync App processes other filters within the Sync App.
For example, the following query is processed server side:
SELECT * FROM [Cdata].[Procurement].[ApprovedSupplierListSourceDocumentsDFF] WHERE AslSourceDocumentsId = 10003
You need to provide ApprovedSupplierListSourceDocumentsUniqId, instead of ApprovedSupplierListSourceDocumentsAslSourceDocumentsId , to insert the record.
Create an ApprovedSupplierListSourceDocumentsDFF.
INSERT into [Cdata].[Procurement].[ApprovedSupplierListSourceDocumentsDFF](ApprovedSupplierListSourceDocumentsUniqId ,[__FLEX_Context_DisplayValue],[__FLEX_Context]) values (45,'My Group 2','My Group 2')
The Oracle Fusion Cloud Financials API uses ApprovedSupplierListSourceDocumentsUniqId instead of ApprovedSupplierListSourceDocumentsAslSourceDocumentsId and AslSourceDocumentsUniqId instead of AslSourceDocumentsId as a path parameter in the URL to update the record.
If you want to update a record directly using the id (without any other filter), you can update the record in the following way:
Update [Cdata].[Procurement].[ApprovedSupplierListSourceDocumentsDFF] set [__FLEX_Context]='asdw' where ApprovedSupplierListSourceDocumentsUniqId=300000249243496 and AslSourceDocumentsUniqId=300000249243496
Note: This does not require any extra GET request to retrieve the UniqId.
Alternatively, if you want to apply any other filter. Please use AslSourceDocumentsId instead of AslSourceDocumentsUniqId and ApprovedSupplierListSourceDocumentsAslSourceDocumentsId instead of ApprovedSupplierListSourceDocumentsUniqId. You can update the record in the following way:
Update [Cdata].[Procurement].[ApprovedSupplierListSourceDocumentsDFF] set [__FLEX_Context]='asdw' where ApprovedSupplierListSourceDocumentsAslSourceDocumentsId=300000249243496
Note : Update on aggregates are not allowed by API, use the child tables to add/update/delete aggregates.
The Oracle Fusion Cloud Financials API uses ApprovedSupplierListSourceDocumentsUniqId instead of ApprovedSupplierListSourceDocumentsAslSourceDocumentsId and AslSourceDocumentsUniqId instead of AslSourceDocumentsId as a path parameter in the URL to delete the record.
If you want to delete a record directly using the id (without any other filter), you can delete the record in the following way:
Delete from [Cdata].[Procurement].[ApprovedSupplierListSourceDocumentsDFF] where ApprovedSupplierListSourceDocumentsUniqId=300000249243496 and AslSourceDocumentsUniqId=300000249243496
Note: This does not require any extra GET request to retrieve the UniqId.
Alternatively, if you want to apply any other filter. Please use AslSourceDocumentsId instead of AslSourceDocumentsUniqId and ApprovedSupplierListSourceDocumentsAslSourceDocumentsId instead of ApprovedSupplierListSourceDocumentsUniqId. You can delete the record in the following way:
Delete from [Cdata].[Procurement].[ApprovedSupplierListSourceDocumentsDFF] where ApprovedSupplierListSourceDocumentsAslSourceDocumentsId=300000249243496
| Name | Type | ReadOnly | Description |
| ApprovedSupplierListSourceDocumentsAslSourceDocumentsId [KEY] | Long | True |
Finds and retrieves approved supplier list source documents based on the primary key of the source document. This field is used to search for specific source documents in the system based on their unique identifier. |
| ApprovedSupplierListSourceDocumentsUniqId [KEY] | String | True |
Serves as an alternative unique identifier for finding approved supplier list source documents. This value should be used for insert, update, and delete operations instead of 'ApprovedSupplierListSourceDocumentsAslSourceDocumentsId' to ensure proper data manipulation. |
| AslSourceDocumentsId [KEY] | Long | False |
The identifier for the approved supplier list source document in the 'ApprovedSupplierListSourceDocumentsDFF' context. This is used to link data in this specific table to the related source document. |
| AslSourceDocumentsUniqId [KEY] | String | True |
This column holds a unique identifier for the approved supplier list source document and should be used for insert, update, and delete operations instead of the 'AslSourceDocumentsId'. It provides an alternative means for managing the data. |
| _FLEX_Context | String | False |
Represents the context within which the 'ApprovedSupplierListSourceDocumentsDFF' operates. It provides metadata to identify the specific business context or process associated with the data stored in this table. |
| _FLEX_Context_DisplayValue | String | False |
Displays a user-friendly prompt or description associated with the '_FLEX_Context' value. This is useful for providing additional context or labels when displaying the context to end users in the system interface. |
| Finder | String | True |
A field used for searching or locating specific records in the system. It may contain query parameters or other search criteria to help users find relevant supplier documents or entries. |
| CUReferenceNumber | Int | False |
Maps child aggregates to their parent tables in the database schema. This number helps to maintain the relationship between aggregate data in child tables and the parent records, ensuring proper data linkage and integrity. |
| EffectiveDate | Date | True |
This query parameter is used to retrieve resources or records that were effective as of the specified start date. It ensures that only valid and active data is fetched, based on the date the query is executed. |
Maintains partially completed purchase orders not yet communicated to suppliers, tracking preliminary details for further updates.
The Sync App uses the Oracle Fusion Cloud Financials API to process some of the filters having queryable=true in metadata. The Sync App processes other filters within the Sync App.
For example, the following query is processed server side:
SELECT * FROM [Cdata].[Procurement].[DraftPurchaseOrders] WHERE POHeaderId = 10003
Create an DraftPurchaseOrder.
INSERT into DraftPurchaseOrders(Currency,ProcurementBU,RequisitioningBUId,Buyer,Supplier,SupplierSite,BillToLocation,PayOnReceiptFlag,BuyerManagedTransportFlag,RequiredAcknowledgment,SupplierCommunicationMethod) values ('US Dollar','US1 Business Unit',300000046987012,'Roth, Calvin','EIP Inc','EIP Inc','Seattle',false,true,'None','NONE')
You can also add aggregates with the parent table, using TEMP table and aggregates. Please refer to Invoices.
The Oracle Fusion Cloud Financials API uses POHeaderUniqId instead of POHeaderId as a path parameter in the URL to update the record.
If you want to update a record directly using the id (without any other filter), you can update the record in the following way:
Update [Cdata].[Procurement].[DraftPurchaseOrders] set Description='abcd' where POHeaderUniqId=454545454;
Note: This does not require any extra GET request to retrieve the UniqId.
Alternatively, if you want to apply any other filter. Please use POHeaderId instead of POHeaderUniqId. You can update the record in the following way:
Update [Cdata].[Procurement].[DraftPurchaseOrders] set Description='abcd' where POHeaderUniqId=454545454 and BuyerId=445128;
Note : Update on aggregates are not allowed by API, use the child tables to add/update/delete aggregates.
The Oracle Fusion Cloud Financials API uses POHeaderUniqId instead of POHeaderId as a path parameter in the URL to delete the record.
If you want to delete a record directly using the id (without any other filter), you can delete the record in the following way:
Delete from [Cdata].[Procurement].[DraftPurchaseOrders] where POHeaderUniqId=454545454;
Note: This does not require any extra GET request to retrieve the UniqId.
Alternatively, if you want to apply any other filter. Please use POHeaderId instead of POHeaderUniqId. You can delete the record in the following way:
Delete from [Cdata].[Procurement].[DraftPurchaseOrders] where POHeaderId=454545454 and BuyerId=445128;
| Name | Type | ReadOnly | Description |
| POHeaderId [KEY] | Long | True |
The unique identifier for the header of a draft purchase order, used to reference the overall purchase order document. |
| POHeaderUniqId [KEY] | String | True |
A unique identifier for the draft purchase order header that should be used for insert, update, and delete operations, instead of using the POHeaderId. |
| OrderNumber | String | False |
The number that uniquely identifies a purchase order within the sold-to legal entity, typically used for tracking and referencing the order. |
| Description | String | False |
A text description of the purchase order, providing more context about the order's purpose or content. |
| DocumentStyleId | Long | False |
The unique identifier for the style of the purchasing document, helping to distinguish between different document formats or layouts. |
| DocumentStyle | String | False |
The name of the purchasing document style, used to control the parameters and values displayed on the application to match the document’s intended use. |
| StatusCode | String | False |
An abbreviation identifying the status of the purchase order within its lifecycle, which helps categorize its current state. |
| Status | String | True |
The current status of the draft purchase order, indicating whether it is in a draft, pending, or finalized state. |
| ProcurementBUId | Long | False |
The unique identifier for the business unit responsible for managing and owning the purchase order. |
| ProcurementBU | String | False |
The name of the business unit that is responsible for managing and owning the purchase order. |
| RequisitioningBUId | Long | False |
The unique identifier for the business unit that is responsible for creating the requisition linked to the purchase order. |
| RequisitioningBU | String | False |
The name of the business unit that is responsible for creating the requisition from which the purchase order is derived. |
| BuyerId | Long | False |
The unique identifier for the buyer who is responsible for managing the purchase order. |
| Buyer | String | False |
The name of the person who is responsible for managing the purchase order, typically overseeing its creation and processing. |
| BuyerEmail | String | False |
The email address of the buyer, allowing communication and notifications regarding the purchase order. |
| CurrencyCode | String | False |
The abbreviation for the currency used in the purchase order, typically using ISO 4217 codes. |
| Currency | String | False |
The currency used for the purchase order, which determines how amounts are calculated and paid. |
| ConversionRateTypeCode | String | False |
An abbreviation identifying the type of conversion rate applied when converting currencies in the purchase order. |
| ConversionRateType | String | False |
The type of conversion rate used by the application to determine the exchange rate for converting one currency into another. |
| ConversionRateDate | Date | False |
The specific date used for determining the conversion rate, as exchange rates may vary by date. |
| ConversionRate | Decimal | False |
The actual conversion rate used to convert between currencies for the purchase order. |
| SupplierId | Long | False |
The unique identifier for the supplier fulfilling the items or services listed on the purchase order. |
| Supplier | String | False |
The name of the supplier responsible for delivering the items or services listed on the purchase order. |
| SupplierSiteId | Long | False |
The unique identifier for the supplier's site, which represents the location from where the supplier will fulfill the order. |
| SupplierSite | String | False |
The name of the supplier's site, indicating the location from where the supplier will ship the goods. |
| SupplierCommunicationMethod | String | False |
The method used to communicate the purchase order to the supplier, such as email, fax, or other communication channels. |
| SupplierFax | String | False |
The fax number used to communicate the purchase order to the supplier, in case fax is the preferred communication method. |
| SupplierOrder | String | True |
The supplier-specific order number, which links to the purchase order for tracking or reference purposes. |
| SupplierEmailAddress | String | False |
The email address of the supplier for communication related to the purchase order. |
| SoldToLegalEntityId | Long | False |
The unique identifier for the legal entity that is financially responsible for the purchase order, used for invoicing and legal purposes. |
| SoldToLegalEntity | String | False |
The name of the legal entity that is financially responsible for the purchase order, typically the entity making the purchase. |
| BillToBUId | Long | False |
The unique identifier for the business unit responsible for processing supplier invoices related to the purchase order. |
| BillToBU | String | False |
The name of the business unit responsible for processing supplier invoices for the purchase order. |
| BillToLocationId | Long | False |
The unique identifier for the location where the supplier sends the invoice, which can be different from the physical shipping address. |
| BillToLocation | String | False |
The location where the supplier is instructed to send invoices for payment. |
| BillToLocationInternalCode | String | False |
An internal abbreviation or code used to identify the bill-to location, typically for internal reference. |
| DefaultShipToLocationId | Long | False |
The unique identifier for the default location where goods should be shipped. |
| DefaultShipToLocation | String | False |
The name of the location where the supplier is expected to ship the items or goods. |
| DefaultShipToLocationInternalCode | String | False |
Abbreviation that internally identifies the default value of the ship-to location where the supplier should ship the goods. |
| MasterContractId | Long | False |
Value that uniquely identifies the contract from enterprise contracts. This attribute allows a direct connection between execution documents in Oracle Purchasing Cloud and high-level contracts in Oracle Enterprise Contracts Cloud. |
| MasterContractNumber | String | False |
Number that identifies the contract from enterprise contracts. This attribute allows a direct connection between execution documents in Oracle Purchasing Cloud and high-level contracts in Oracle Enterprise Contracts Cloud. |
| MasterContractTypeId | Long | False |
Value that uniquely identifies the contract type. This attribute specifies the nature of the enterprise contract. The contract type specifies what kind of information you can enter, including the presence of lines and contract terms. |
| MasterContractType | String | False |
Type of contract. This attribute specifies the nature of the enterprise contract. The contract type specifies what kind of information you can enter, including the presence of lines and contract terms. |
| RequiredAcknowledgmentCode | String | False |
Abbreviation that identifies the acknowledgment that the purchase order requires from the supplier. Values include Y for document and schedule, D for document, or N for none. |
| RequiredAcknowledgment | String | False |
Acknowledgment that the application requires from the supplier. Values include 'Document and Schedule' (supplier must acknowledge the header and schedule of the purchase order), 'Document' (supplier must acknowledge the header of the purchase order), or 'None' (the purchase order does not require acknowledgment). |
| AcknowledgmentDueDate | Date | False |
Date when the application requests the supplier to acknowledge the purchase order. |
| AcknowledgmentWithinDays | Decimal | False |
Number of days for the supplier to decide to accept or reject the purchase order. |
| BuyerManagedTransportFlag | Bool | False |
Contains one of the following values: true or false. If true, then the buyer or an agent that the buyer designates must arrange transportation from picking up the requested item to delivering it to the ship-to location that the purchase order specifies. If false, then the supplier must arrange transportation. This attribute does not have a default value. |
| RequiresSignatureFlag | Bool | False |
Contains one of the following values: true or false. If true, then the purchase order requires signatures to meet legal requirements. If false, then the purchase order does not require signatures. This attribute does not have a default value. |
| PendingSignatureFlag | Bool | True |
Indicates whether the purchase order is awaiting a signature, used for tracking purposes. |
| PaymentTermsId | Long | False |
The unique identifier for the payment terms that define when and how the supplier will be paid. |
| PaymentTerms | String | False |
The payment terms for the purchase order, which govern when payments are made, including discount dates and due dates. |
| FOBCode | String | False |
An abbreviation identifying the type of freight on board term applied to the order, such as 'CIF' or 'FOB'. |
| FOB | String | False |
The location where the ownership of goods transfers from the supplier to the buyer during shipping. |
| FreightTermsCode | String | False |
An abbreviation identifying the freight terms for the purchase order, which determine who bears the cost of shipping. |
| FreightTerms | String | False |
The terms that define who is responsible for paying the freight charges associated with the shipment. |
| SupplierContactId | Long | False |
The unique identifier for the supplier contact, who is responsible for managing communications regarding the purchase order. |
| SupplierContact | String | False |
The name of the contact person representing the supplier, who communicates with the buyer. |
| NoteToSupplier | String | False |
A note directed to the supplier providing instructions or additional details on how to process the purchase order. |
| NoteToReceiver | String | False |
A note directed to the receiver providing instructions or additional details on how to process the items upon arrival. |
| CarrierId | Long | False |
The unique identifier for the carrier company that transports the items by land, sea, or air. |
| Carrier | String | False |
The name of the carrier company responsible for transporting the items. |
| ModeOfTransportCode | String | False |
An abbreviation identifying the mode of transport used by the carrier, such as 'Air' or 'Sea'. |
| ModeOfTransport | String | False |
The mode of transport used by the carrier, such as air, sea, or land. |
| ServiceLevelCode | String | False |
An abbreviation identifying the service level for the shipping method, such as 'Overnight' or 'Standard'. |
| ServiceLevel | String | False |
The service level describing how quickly the items need to be shipped, such as 'Express' or 'Economy'. |
| ConfirmingOrderFlag | Bool | False |
Contains one of the following values: true or false. If true, then the purchase order is communicated verbally before the supplier receives the purchase order. If false, then there is no verbal communication before sending the purchase order. This attribute does not have a default value. |
| PayOnReceiptFlag | Bool | False |
Contains one of the following values: true or false. If true, then the application creates an invoice that requests payment for the item according to the receipt transaction. If false, then the application does not require the supplier to create this invoice and instead requests payment according to the receipt of the shipped item. This attribute does not have a default value. |
| DocumentCreationMethod | String | False |
The method by which the purchase order document was created, such as manually, automatically, or by using a template. |
| ShippingMethod | String | False |
The method of transportation chosen for the order, detailing the carrier and service level, such as 'Air - Express'. |
| DefaultTaxationCountryCode | String | False |
The abbreviation identifying the country used for taxation purposes for the purchase order. |
| DefaultTaxationCountry | String | False |
The country in which the transaction is subject to tax, used for calculating tax liabilities. |
| FirstPartyRegistrationId | Long | False |
The unique identifier for the first party registration number, used for tax reporting. |
| FirstPartyRegistrationNumber | String | False |
Value that is a unique sequence of letters or numbers assigned to a first party by a tax authority when it is registered. This attribute is used to identify the first party registration. |
| ThirdPartyRegistrationId | Long | False |
Value that uniquely identifies the third party registration. |
| ThirdPartyRegistrationNumber | String | False |
Value that is a unique sequence of letters or numbers assigned to a third party or third-party site by a tax authority. This attribute is used to identify the party or party-site level tax registration. |
| DocumentFiscalClassificationId | Long | False |
The unique identifier for the fiscal classification of the document, which affects tax categorization. |
| DocumentFiscalClassificationCode | String | False |
An abbreviation identifying the fiscal classification applied to the document for tax purposes. |
| DocumentFiscalClassification | String | False |
The classification of the document as per the tax authority's rules, affecting its taxation. |
| BudgetaryControlEnabledFlag | Bool | True |
Indicates whether budgetary control is enabled for the purchase order, helping manage expenditures within budget. |
| CancelFlag | Bool | True |
Indicates whether the purchase order is marked for cancellation. |
| ChangeOrderNumber | String | True |
The unique number associated with a change order to track modifications made to the original purchase order. |
| ChangeOrderInitiatingParty | String | False |
The party who initiated the change order request, such as the buyer, supplier, or requester. |
| ChangeOrderDescription | String | False |
A textual description detailing the reason or purpose of the change order, providing clarity on why changes were made. |
| ChangeOrderStatusCode | String | True |
An abbreviation indicating the current status of the change order in its lifecycle. |
| ChangeOrderStatus | String | True |
The current status of the change order, indicating whether it's in draft, pending approval, or finalized. |
| ChangeOrderTypeCode | String | True |
An abbreviation identifying the type of change order being processed. |
| ChangeOrderType | String | True |
The type of change order, specifying whether it's a revision, cancellation, or other types of change. |
| ChangeRequestedBy | String | True |
The individual or entity who requested the change to the purchase order. |
| ContractTermsExistFlag | Bool | True |
Indicates whether contract terms exist for the purchase order, helping determine if additional contractual obligations apply. |
| DuplicatedFromHeaderId | Long | True |
The header ID of the original purchase order from which this one was duplicated. |
| FundsStatus | String | True |
The status of funds for the purchase order, indicating if the funds are approved, pending, or unavailable. |
| FundsStatusCode | String | True |
An abbreviation identifying the funds status of the purchase order, helping to categorize the financial approval stage. |
| ImportSourceCode | String | False |
The source application from which the purchase order was imported, such as an external ERP system. |
| ReferenceNumber | String | True |
A reference number used to link the purchase order to other related documents or transactions. |
| LastUpdateDate | Datetime | True |
The date and time when the purchase order was last updated. |
| LastUpdatedBy | String | True |
The individual who last updated the purchase order, helping to track changes. |
| CreationDate | Datetime | True |
The date and time when the purchase order was originally created. |
| CreatedBy | String | True |
The individual who originally created the purchase order. |
| SupplierCCEmailAddress | String | False |
An email address to which a copy of the purchase order communication is sent for CC purposes. |
| SupplierBCCEmailAddress | String | False |
An email address to which a copy of the purchase order communication is sent for BCC purposes, hidden from other recipients. |
| OverridingApproverId | Long | False |
The unique identifier for the user designated as the overriding approver for approval routing, allowing a change in the approval process. |
| OverridingApprover | String | False |
The name of the person who overrides the first approver to route the purchase order for approval. |
| OverrideB2BCommunicationFlag | Bool | False |
Indicates whether the purchase order can be communicated using an alternative communication method other than B2B, with true meaning it can't be sent through B2B. |
| HasPOlineswithMultipleDistributionsFlag | Bool | True |
A flag indicating whether the purchase order lines are distributed across multiple accounts or locations. |
| HasReceivedOrInvoicedSchedulesFlag | Bool | True |
Indicates whether there are any received or invoiced schedules related to the purchase order. |
| AdditionalContactEmail | String | False |
Email addresses for additional supplier contacts who may need to receive notifications regarding the purchase order. |
| SpecialHandlingType | String | False |
The special handling type applied to the purchase order, detailing any specific handling instructions. |
| SpecialHandlingTypeCode | String | False |
An abbreviation identifying the special handling type for the purchase order, such as expedited processing or custom packaging. |
| specialHandlingDFF | String | False |
A special handling DFF (descriptive flexfield) used only for insert operations; for updates and deletes, use child table operations. |
| summaryAttributes | String | False |
Summary attributes used for insert operations; for updates or deletes, refer to child table operations. |
| DFF | String | False |
A DFF (descriptive flexfield) used for inserts only; for updates and deletes, refer to child table operations. |
| lines | String | False |
Used for insert operations to add lines to the purchase order; for updates and deletes, use child table operations. |
| globalDFFs | String | False |
Global descriptive flexfields used only for insert operations; for updates and deletes, use child table operations. |
| Finder | String | True |
The finder used for searching and referencing related purchase order records. |
| Intent | String | True |
The intent or purpose for which the purchase order was created. |
| SysEffectiveDate | String | True |
The system-effective date, used for tracking the period when the purchase order data is valid. |
| EffectiveDate | Date | True |
The effective date used to determine the resources valid as of the specified start date. |
Manages shipping schedules, delivery dates, and receiving locations for each line in a draft purchase order.
The Sync App uses the Oracle Fusion Cloud Financials API to process some of the filters having queryable=true in metadata. The Sync App processes other filters within the Sync App.
For example, the following query is processed server side:
SELECT * FROM [Cdata].[Procurement].[DraftPurchaseOrderslinesschedules] WHERE LineLocationId = 10003
Create an DraftPurchaseOrderslinesschedule.
You need to provide DraftPurchaseOrdersUniqID instead of DraftPurchaseOrdersPOHeaderId and LinesUniqId instead of LinesPOLineId , to insert the record.
INSERT into DraftPurchaseOrderslinesschedules(DraftPurchaseOrdersUniqID,LinesUniqId,ScheduleNumber,Quantity,ShipToLocation,ShipToOrganization,ReceiptCloseTolerancePercent,InvoiceMatchOptionCode,EarlyReceiptToleranceDays,InvoiceCloseTolerancePercent,LateReceiptToleranceDays,AccrueAtReceiptFlag,InspectionRequiredFlag,ReceiptRequiredFlag,ReceiptRoutingId,DestinationTypeCode,Carrier,ServiceLevel,ModeOfTransportCode) values (121321,2131,5,10,'Marseille','Marseille',0,'P',60,0,0,'N',false,false,3,'EXPENSE','Airborne','2nd day air','PARCEL')
The Oracle Fusion Cloud Financials API uses DraftPurchaseOrdersUniqID instead of DraftPurchaseOrdersPOHeaderId, LinesUniqId instead of LinesPOLineId and LineLocationUniqId instead of LineLocation as a path parameter in the URL to update the record.
If you want to update a record directly using the id (without any other filter), you can update the record in the following way:
Update [Cdata].[Procurement].[DraftPurchaseOrderslinesschedules] set Description='abcd' where draftPurchaseOrdersUniqID=454545454 and LinesUniqId=121 and LineLocationUniqId=55655
Note: This does not require any extra GET request to retrieve the UniqId. You need to provide all the UniqIds.
Alternatively, if you want to apply any other filter. Please use DraftPurchaseOrdersPOHeaderId instead of DraftPurchaseOrdersUniqID, LinesPOLineId instead of LinesUniqId and LineLocation instead of LineLocationUniqId. You can update the record in the following way:
Update [Cdata].[Procurement].[DraftPurchaseOrderslinesschedules] set Description='abcd' where DraftPurchaseOrdersPOHeaderId=454545454
Note : Update on aggregates are not allowed by API, use the child tables to add/update/delete aggregates.
The Oracle Fusion Cloud Financials API uses DraftPurchaseOrdersUniqID instead of DraftPurchaseOrdersPOHeaderId, LinesUniqId instead of LinesPOLineId and LineLocationUniqId instead of LineLocation as a path parameter in the URL to delete the record.
If you want to delete a record directly using the id (without any other filter), you can delete the record in the following way:
Delete from [Cdata].[Procurement].[DraftPurchaseOrderslinesschedules] where draftPurchaseOrdersUniqID=454545454 and LinesUniqId=121 and LineLocationUniqId=55655
Note: This does not require any extra GET request to retrieve the UniqId. You need to provide all the UniqIds.
Alternatively, if you want to apply any other filter. Please use DraftPurchaseOrdersPOHeaderId instead of DraftPurchaseOrdersUniqID, LinesPOLineId instead of LinesUniqId and LineLocation instead of LineLocationUniqId. You can delete the record in the following way:
Delete from [Cdata].[Procurement].[DraftPurchaseOrderslinesschedules] where DraftPurchaseOrdersPOHeaderId=454545454
| Name | Type | ReadOnly | Description |
| DraftPurchaseOrdersPOHeaderId [KEY] | Long | True |
The unique identifier for a draft purchase order header, linking the schedule to the corresponding purchase order. |
| DraftPurchaseOrdersUniqId [KEY] | String | True |
A unique identifier used for insert, update, and delete operations in place of DraftPurchaseOrdersPOHeaderId, providing a more specific reference for the schedule. |
| LinesPOLineId [KEY] | Long | True |
The identifier for the specific purchase order line, linking this schedule to the corresponding line item. |
| LinesUniqId [KEY] | String | True |
A unique identifier for the schedule line, used for insert, update, and delete operations instead of LinesPOLineId. |
| LineLocationId [KEY] | Long | True |
The identifier for the location where the purchase order line item is to be delivered, indicating the specific shipping location. |
| LineLocationUniqId [KEY] | String | True |
A unique identifier used in insert, update, and delete operations instead of LineLocationId, providing a more specific reference for the location. |
| ScheduleNumber | Decimal | False |
The number that uniquely identifies the purchase order schedule for the given purchase order line. |
| POLineId | Long | False |
The unique identifier for the parent purchase order line, used when the schedule is a split or a child of another line. |
| LineNumber | Decimal | True |
The line number assigned to the schedule, helping to track and identify the specific line item within the schedule. |
| POHeaderId | Long | False |
The identifier for the purchase order header associated with this purchase order schedule. |
| OrderNumber | String | True |
The order number for the purchase order schedule, used to track the order across the system. |
| Quantity | Decimal | False |
The quantity of items specified in the purchase order schedule, indicating how many units are being scheduled. |
| Amount | Decimal | False |
The monetary value of the scheduled item or service, reflecting the total cost for the scheduled quantity. |
| ShipToOrganizationId | Long | False |
The unique identifier for the inventory organization where the supplier is expected to deliver the item. |
| ShipToOrganizationCode | String | False |
The abbreviation or code for the inventory organization where the item is to be shipped. |
| ShipToOrganization | String | False |
The name of the inventory organization that will receive the shipment. |
| ShipToLocation | String | False |
The name of the physical location within the organization where the item will be delivered. |
| ShipToLocationId | Long | False |
The identifier for the specific location within the organization where the item is to be shipped. |
| ShipToLocationCode | String | False |
The abbreviation or code that uniquely identifies the shipping location within the organization. |
| ShipToLocationInternalCode | String | False |
An internal code used to identify the location where goods should be shipped within the organization. |
| DestinationTypeCode | String | False |
A code representing how the item will be used upon fulfillment, such as inventory, expense, drop ship, or manufacturing. |
| DestinationType | String | False |
The type of destination indicating how to categorize the charge for the item, including values like inventory, expense, drop ship, or work order. |
| LocationOfFinalDischargeId | Long | False |
The identifier for the final location where the item or service will be delivered or discharged. |
| LocationOfFinalDischargeCode | String | False |
An abbreviation that identifies the final discharge location where the goods will be received. |
| TransactionBusinessCategoryId | Long | False |
The identifier for the business category classification of the transaction, typically used for tax reporting purposes. |
| TransactionBusinessCategoryCode | String | False |
An abbreviation for the business category used for tax categorization of the transaction. |
| TransactionBusinessCategory | String | False |
The description of the business category used to classify the transaction for tax purposes. |
| UserDefinedFiscalClassificationCode | String | False |
An abbreviation for the user-defined fiscal classification, which can be customized for tax or financial reporting. |
| UserDefinedFiscalClassification | String | False |
An additional custom classification for fiscal reporting or tax purposes, as defined by the organization. |
| ProductFiscalClassificationId | Long | False |
The unique identifier for the fiscal classification of a product, used for tax categorization by tax authorities. |
| ProductFiscalClassificationCode | String | False |
An abbreviation for the fiscal classification of the product, used in tax reporting. |
| ProductFiscalClassification | String | False |
The classification applied by tax authorities to a product, used for tax categorization. |
| ProductCategoryCode | String | False |
The code used to categorize the product for tax purposes, based on the tax classification. |
| ProductCategory | String | False |
The name or description of the product category used for tax reporting and categorization. |
| LineIntendedUseId | Long | False |
The identifier for the intended business use of a product, indicating how the purchaser plans to use the item. |
| LineIntendedUse | String | False |
The purpose for which the product is intended to be used by the purchaser in their business. |
| ProductTypeCode | String | False |
An abbreviation that identifies the product type, typically used for classification in tax or financial reporting. |
| ProductType | String | False |
The type of product, determining how tax is calculated. Common types include goods and services. |
| AssessableValue | Decimal | False |
The value of the product that is assessable for tax purposes, typically based on the transaction amount. |
| TaxClassificationCode | String | False |
The abbreviation for the tax classification code, used for categorizing products and services for tax reporting. |
| TaxClassification | String | False |
The tax classification used to group items for tax reporting and processing purposes. |
| InvoiceCloseTolerancePercent | Decimal | False |
The percentage tolerance used to determine whether a purchase order schedule should be closed when the invoice covers only part of the scheduled quantity or amount. |
| ReceiptCloseTolerancePercent | Decimal | False |
The percentage tolerance used to determine whether a purchase order schedule should be closed when only part of the scheduled quantity or amount is received. |
| EarlyReceiptToleranceDays | Decimal | False |
The maximum number of days that the system allows for an early shipment of the order. |
| LateReceiptToleranceDays | Decimal | False |
The maximum number of days that the system allows for a late shipment of the order. |
| AccrueAtReceiptFlag | Bool | False |
A flag indicating whether to accrue the purchase order schedule at the time of receipt. If true, the system will accrue at receipt; if false, accrual does not occur at receipt. |
| ReceiptRoutingId | Long | False |
The identifier for the receipt routing method to use when receiving the item, such as standard receipt or inspection required. |
| ReceiptRouting | String | False |
The method used for routing the receipt, determining how the item is handled when it arrives (for example, standard receipt, inspection required, or direct delivery). |
| InvoiceMatchOptionCode | String | False |
A code indicating whether the invoice must match the purchase order or receipt for validation. Possible values include C (consumption advice), P (purchase order), or R (receipt). |
| InvoiceMatchOption | String | False |
The matching option used for invoice validation, specifying whether to match against the purchase order or receipt. For consignment, it matches the consumption advice. |
| InspectionRequiredFlag | Bool | False |
A flag indicating whether the schedule requires inspection before payment can be made. If true, inspection is required; if false, payment can be made without inspection. |
| ReceiptRequiredFlag | Bool | False |
A flag indicating whether receipt of the goods is required before payment can be made. If true, receipt is required; if false, payment can occur even without receipt. |
| MatchApprovalLevelCode | String | False |
An abbreviation for the match approval level, specifying the level of matching required between the purchase order, receipt, inspection, and invoice. |
| MatchApprovalLevel | String | False |
The approval level required for matching purchase order quantities, receipts, inspections, and invoices before payment can be made. Values include 2-way, 3-way, or 4-way match. |
| AllowSubstituteReceiptsFlag | Bool | False |
A flag indicating whether the schedule allows for a substitute item to be used in place of the original item. If true, substitution is allowed; if false, no substitution is permitted. |
| FirmFlag | Bool | True |
A flag indicating whether the schedule is firm or not, determining whether the order commitment is fixed or flexible. |
| OverReceiptTolerancePercent | Decimal | False |
The percentage tolerance for receiving more than the ordered quantity without triggering the over-receipt action. |
| BackToBackFlag | Bool | True |
A flag indicating whether the purchase order schedule is a back-to-back order, typically used for orders that directly correspond to another order. |
| NoteToReceiver | String | False |
A note providing additional instructions to the receiver regarding how to process the purchase order schedule. |
| RequestedDeliveryDate | Date | False |
The date on which the buyer has requested that the supplier deliver the item. |
| PromisedDeliveryDate | Date | False |
The date on which the supplier has promised to deliver the item to the buyer. |
| RequestedShipDate | Date | False |
The date on which the buyer has requested that the supplier ship the item. |
| PromisedShipDate | Date | False |
The date on which the supplier has promised to ship the item to the buyer. |
| SalesOrderNumber | String | True |
The sales order number associated with this purchase order schedule. |
| SalesOrderLineNumber | String | True |
The sales order line number related to this purchase order schedule. |
| SalesOrderScheduleNumber | String | True |
The sales order schedule number associated with this purchase order schedule. |
| SecondaryQuantity | Decimal | False |
The scheduled quantity in a secondary unit of measure, applicable when multiple units of measure are used. |
| TaxableFlag | Bool | True |
A flag indicating whether the item is subject to tax under the applicable tax rules. |
| Carrier | String | False |
The company responsible for transporting the item to the destination. |
| CarrierId | Long | False |
The unique identifier for the carrier company handling the shipment. |
| CountryOfOrigin | String | False |
The country where the item is produced or manufactured, used for customs and regulatory purposes. |
| CountryOfOriginCode | String | False |
An abbreviation for the country of origin, typically used in international trade and customs processing. |
| ShipToExceptionAction | String | False |
The action to take if there is an exception with the ship-to location, such as none, reject, or warning. |
| ShipToExceptionActionCode | String | False |
The code indicating the action to take when there is a discrepancy with the ship-to location, such as none, reject, or warning. |
| FundsStatusCode | String | True |
The code representing the current funds status for this schedule, indicating whether there are sufficient funds. |
| FundsStatus | String | True |
The description of the funds status, showing whether the purchase order schedule has adequate funds for the purchase. |
| ModeOfTransport | String | False |
The mode of transport used to ship the item, such as truck, air, or sea. |
| ModeOfTransportCode | String | False |
An abbreviation for the mode of transport used for shipment, such as 'TRK' for truck, 'AIR' for air, or 'SEA' for sea. |
| CancelDate | Date | True |
The date when the purchase order schedule was canceled, if applicable. |
| CancelReason | String | False |
The reason for the cancellation of the purchase order schedule, providing context for the decision. |
| CancelledBy | Long | True |
The identifier of the user or system that canceled the purchase order schedule. |
| RejectedReason | String | True |
The reason why the purchase order schedule was rejected, if applicable. |
| ReasonForChange | String | False |
The reason for changing the schedule, such as product modification, price adjustment, or shipping issues. |
| ChangeAcceptedFlag | Bool | True |
A flag indicating whether the changes made to the purchase order schedule have been accepted. |
| ChangeOrderAmountCancelled | Decimal | True |
The amount of the change order that has been canceled. |
| ChangeOrderQuantityCancelled | Decimal | True |
The quantity of the change order that has been canceled. |
| CustomerItem | String | True |
The item identifier used by the customer for this purchase order schedule. |
| CustomerItemDescription | String | True |
The description of the item from the customer’s perspective. |
| CustomerPOLineNumber | String | True |
The customer’s purchase order line number associated with this schedule. |
| CustomerPONumber | String | True |
The customer’s purchase order number associated with this schedule. |
| CustomerPOScheduleNumber | String | True |
The customer’s purchase order schedule number associated with this schedule. |
| CurrencyCode | String | True |
The currency code used for the purchase order schedule, such as USD or EUR. |
| Currency | String | True |
The name of the currency used for the purchase order schedule. |
| RejectedBy | Long | True |
The user or system that rejected the purchase order schedule. |
| RejectedByRole | String | True |
The role of the user who rejected the purchase order schedule. |
| CancelFlag | Bool | False |
A flag indicating whether the schedule is canceled (true) or not canceled (false). |
| SecondaryUOMCode | String | True |
The code for the secondary unit of measure used in the purchase order schedule. |
| SecondaryUOM | String | True |
The secondary unit of measure for the purchase order schedule, applicable when more than one unit of measure is used. |
| UOMCode | String | False |
An abbreviation for the unit of measure used for the purchase order schedule. |
| UOM | String | False |
The unit of measure used for the scheduled quantity of the item. |
| PricingUOMCode | String | False |
The unit of measure used for pricing the item in the purchase order schedule. |
| PricingUOM | String | True |
The unit of measure used for the pricing of the item in the purchase order schedule. |
| ReceiptDateExceptionActionCode | String | False |
The action to take when the receipt does not match the ordered quantity or amount by the specified receipt date tolerance. Possible values include none, reject, or warning. |
| ReceiptDateExceptionAction | String | False |
The action to take when the receipt deviates from the ordered quantity or amount based on the receipt date tolerance, such as none, reject, or warning. |
| OverReceiptActionCode | String | False |
The code indicating what action to take when the receipt exceeds the ordered quantity or amount. |
| OverReceiptAction | String | False |
The action to take when the receipt quantity exceeds the ordered quantity, such as none, reject, or warning. |
| WorkOrderId | Long | True |
The identifier for the work order associated with the purchase order schedule. |
| WorkOrderNumber | String | True |
The work order number associated with the purchase order schedule. |
| WorkOrderOperationId | Long | True |
The operation identifier for the work order associated with the purchase order schedule. |
| WorkOrderOperationSequence | Decimal | True |
The sequence number for the operation in the work order related to the purchase order schedule. |
| WorkOrderSubType | String | True |
The subtype of the work order related to the purchase order schedule. |
| SupplierOrderLineNumber | String | True |
The supplier's order line number associated with this purchase order schedule. |
| OrchestrationAgreementLineNumber | Long | True |
The line number within the orchestration agreement for this purchase order schedule. |
| OrchestrationAgreementNumber | String | True |
The number of the orchestration agreement associated with this purchase order schedule. |
| PrimaryTradeRelationshipId | Long | True |
The identifier for the primary trade relationship involved in this purchase order schedule. |
| POTradingOrganizationId | Long | True |
The identifier for the trading organization associated with this purchase order schedule. |
| POTradingOrganizationCode | String | True |
The code for the trading organization associated with the purchase order schedule. |
| POTradingOrganization | String | True |
The name of the trading organization associated with this purchase order schedule. |
| FirmStatusLookupCode | String | True |
The lookup code for the firm status of this purchase order schedule. |
| FirmStatus | String | True |
The firm status of the purchase order schedule, indicating whether the schedule is confirmed or tentative. |
| ParentLineLocationId | Long | True |
The identifier for the parent line location from which this schedule was derived. |
| ParentScheduleNumber | Decimal | False |
The number of the parent schedule from which this purchase order schedule was created. |
| ShipToCustomerContactId | Long | True |
The identifier for the contact person at the ship-to customer location for this purchase order schedule. |
| ShipToCustomerContact | String | True |
The name of the contact person at the ship-to customer location for the purchase order schedule. |
| ShipToCustomerId | Long | True |
The identifier for the ship-to customer for this purchase order schedule. |
| ShipToCustomer | String | True |
The name of the customer receiving the goods in this purchase order schedule. |
| ShipToCustomerLocationId | Long | True |
The identifier for the specific location of the ship-to customer. |
| ServiceLevelCode | String | False |
The abbreviation for the service level, indicating the priority or method of shipping. |
| ServiceLevel | String | False |
The service level associated with the shipment, indicating the speed or method of delivery. |
| CancelUnfulfilledDemandFlag | Bool | False |
A flag indicating whether to cancel any unfulfilled demand when the purchase order schedule is canceled. |
| CreatedBy | String | True |
The user or system that created the purchase order schedule record. |
| CreationDate | Datetime | True |
The date and time when the purchase order schedule record was created. |
| LastUpdateDate | Datetime | True |
The date and time when the purchase order schedule was last updated. |
| LastUpdatedBy | String | True |
The user or system that last updated the purchase order schedule record. |
| ShippingMethod | String | False |
The method of transport used for shipping the item in the purchase order schedule. |
| RetainageRate | Decimal | False |
The percentage of the invoice value that is withheld as retainage, often used in construction projects. |
| LastAcceptableDeliveryDate | Date | True |
The last date on which the item can be delivered according to the purchase order schedule. |
| LastAcceptableShipDate | Date | True |
The last date on which the item can be shipped according to the purchase order schedule. |
| OriginalPromisedDeliveryDate | Date | True |
The original promised delivery date for the purchase order schedule, prior to any changes. |
| OriginalPromisedShipDate | Date | True |
The original promised ship date for the purchase order schedule, prior to any changes. |
| Type | String | False |
The type of payment schedule for the purchase order, such as lump sum or based on units of work. |
| Description | String | False |
A description of the work associated with the purchase order schedule, often used for progress payments. |
| Price | Decimal | False |
The price for the item or service specified in the purchase order schedule. |
| TypeCode | String | False |
The abbreviation for the type of purchase order schedule, typically used to classify the payment type (for example, rate, lump sum). |
| Finder | String | True |
A search identifier used to locate specific purchase order schedules. |
| Intent | String | True |
The intended action or purpose related to the schedule, such as creating, reviewing, or updating. |
| SysEffectiveDate | String | True |
The effective date in the system, marking when the schedule was created or last updated. |
| CUReferenceNumber | Int | False |
An identifier used to link child aggregate records to their corresponding parent tables. |
| EffectiveDate | Date | True |
The effective date for the schedule, used to determine when the purchase order schedule becomes valid. |
Handles internal purchase requests for items or services, capturing details for eventual PO creation or approval.
The Sync App uses the Oracle Fusion Cloud Financials API to process some of the filters having queryable=true in metadata. The Sync App processes other filters within the Sync App.
For example, the following query is processed server side:
SELECT * FROM [Cdata].[Procurement].[PurchaseRequisitions] WHERE RequisitionHeaderId = 10003
Create an PurchaseRequisition.
INSERT INTO [Cdata].[Procurement].[PurchaseRequisitions](RequisitioningBUId,PreparerId,ExternallyManagedFlag,Description,InterfaceSourceCode,Justification) values (300000046987012,300000050813523,false,'POST-ing a Requisition Header from REST','Rest123','Need this for business purposes')
You can also add aggregates with the parent table, using TEMP table and aggregates. Please refer to Invoices.
The Oracle Fusion Cloud Financials API uses RequisitionHeaderUniqId instead of RequisitionHeaderId as a path parameter in the URL to update the record.
If you want to update a record directly using the id (without any other filter), you can update the record in the following way:
Update [Cdata].[Procurement].[PurchaseRequisitions] set Description='abcd' where RequisitionHeaderUniqId=454545454;
Note: This does not require any extra GET request to retrieve the UniqId.
Alternatively, if you want to apply any other filter. Please use RequisitionHeaderId instead of RequisitionHeaderUniqId. You can update the record in the following way:
Update [Cdata].[Procurement].[PurchaseRequisitions] set Description='abcd' where RequisitionHeaderId=454545454 and Requisition='aaa';
Note : Update on aggregates are not allowed by API, use the child tables to add/update/delete aggregates.
The Oracle Fusion Cloud Financials API uses RequisitionHeaderUniqId instead of RequisitionHeaderId as a path parameter in the URL to delete the record.
If you want to delete a record directly using the id (without any other filter), you can delete the record in the following way:
Delete from [Cdata].[Procurement].[PurchaseRequisitions] where RequisitionHeaderUniqId=454545454;
Note: This does not require any extra GET request to retrieve the UniqId.
Alternatively, if you want to apply any other filter. Please use RequisitionHeaderId instead of RequisitionHeaderUniqId. You can delete the record in the following way:
Delete from [Cdata].[Procurement].[PurchaseRequisitions] where RequisitionHeaderUniqId=454545454 and Requisition='aaa';
| Name | Type | ReadOnly | Description |
| RequisitionHeaderId [KEY] | Long | True |
The unique identifier for the header of the requisition, linking the requisition data to the main requisition record. |
| RequisitionHeaderUniqId [KEY] | String | True |
A unique identifier for the requisition header, to be used in insert, update, and delete operations instead of RequisitionHeaderId. |
| Requisition | String | True |
The requisition number or identifier used to track the specific requisition in the system. |
| RequisitioningBUId | Long | False |
The unique identifier for the business unit that raised the requisition for goods or services, linking the requisition to the originating business unit. |
| RequisitioningBU | String | False |
The name of the business unit that initiated the requisition for goods and services. |
| PreparerId | Long | False |
The unique identifier for the user who created the requisition, linking the requisition to the preparer. |
| Preparer | String | True |
The name or identifier of the user who created the requisition. |
| PreparerEmail | String | False |
The email address of the user who owns the requisition, typically the creator unless ownership has been transferred. |
| Description | String | False |
A brief description of the requisition, providing context or details about the request. |
| Justification | String | False |
The reason or rationale for creating the requisition, explaining why the goods or services are required. |
| DocumentStatus | String | True |
The current status of the requisition document (for example, Pending, Approved, Rejected). |
| DocumentStatusCode | String | True |
A code that represents the status of the requisition document for easier reference in system processes. |
| SubmissionDate | Datetime | True |
The date and time when the requisition was submitted for approval or processing. |
| ApprovedDate | Datetime | True |
The date when the requisition was officially approved. |
| FunctionalCurrencyCode | String | True |
The currency code used for financial transactions in the requisition, typically representing the currency of the requisitioning business unit. |
| SoldToLegalEntityId | Long | True |
The unique identifier for the legal entity to which the requisition is sold, used for legal and financial tracking. |
| SoldToLegalEntity | String | True |
The name or description of the legal entity to which the requisition is assigned. |
| FundsStatus | String | True |
The status of the funds for the requisition, indicating whether funds are available or require additional approvals. |
| FundsStatusCode | String | True |
A code representing the funds status for the requisition, used for easier system tracking. |
| InterfaceSourceCode | String | False |
An abbreviation that identifies the source of the requisition, typically used when importing requisition data. |
| InterfaceSourceLineId | Long | True |
The unique identifier for the line item in the interface source, used to track the specific line associated with the requisition. |
| EmergencyPONumber | String | True |
The purchase order number assigned in emergency cases for expedited requisitions. |
| ModifyingApproverId | Long | True |
The unique identifier for the user who is modifying the requisition's approval details. |
| ModifyingApprover | String | True |
The name of the user who is modifying the approval details of the requisition. |
| ModifyingApproverEmail | String | True |
The email address of the user modifying the requisition's approval details. |
| OverridingApproverId | Long | False |
The unique identifier for the user designated as the overriding approver for approval routing, responsible for final approval. |
| OverridingApproverPersonNumber | String | False |
The person number of the overriding approver, linking to the user in the HR system. |
| OverridingApprover | String | True |
The name of the overriding approver specified on the requisition for approval routing. |
| OverridingApproverEmail | String | True |
The email address of the overriding approver, used for communication and approval notifications. |
| FundsOverrideApproverId | Long | True |
The unique identifier for the user who approves overrides to the requisition's funds availability. |
| FundsOverrideApprover | String | True |
The name of the user responsible for approving funds overrides on the requisition. |
| FundsOverrideApproverEmail | String | True |
The email address of the user responsible for approving funds overrides. |
| ApprovedById | Long | False |
The unique identifier for the user who approved the requisition. |
| ApprovedByEmail | String | False |
The email address of the approver, used for notifications and approvals. |
| BudgetaryControlEnabledFlag | Bool | True |
Indicates whether budgetary control is enabled for the requisition (True/False). |
| EmergencyRequisitionFlag | Bool | True |
Indicates whether the requisition is an emergency requisition, requiring expedited processing (True/False). |
| ExternallyManagedFlag | Bool | False |
Indicates whether the requisition is externally managed (True) or internally managed (False). |
| InternalTransferFlag | Bool | True |
Indicates whether the requisition involves an internal transfer of goods or services (True/False). |
| FundsChkFailWarnFlag | Bool | False |
Indicates whether a funds check failed (True), did not fail (False), or has not been set (Null). |
| CreationDate | Datetime | True |
The date and time when the requisition record was created in the system. |
| LastUpdateDate | Datetime | True |
The date and time when the requisition was last updated. |
| CreatedBy | String | True |
The user who created the requisition record in the system. |
| LastUpdatedBy | String | True |
The user who last updated the requisition record. |
| ActiveRequisitionFlag | Bool | False |
Indicates whether the requisition is active for the preparer and business unit combination (Y/N). |
| SourceApplicationCode | String | False |
The code identifying the application that created the requisition, though this attribute is not currently in use. |
| HasPendingApprovalLinesFlag | Bool | True |
Indicates whether there are any lines in the requisition that are pending approval (True/False). |
| HasRejectedLinesFlag | Bool | True |
Indicates whether any lines in the requisition have been rejected (True/False). |
| HasReturnedLinesFlag | Bool | True |
Indicates whether any lines in the requisition have been returned for modifications (True/False). |
| HasWithdrawnLinesFlag | Bool | True |
Indicates whether any lines in the requisition have been withdrawn (True/False). |
| LifecycleStatusCode | String | True |
The code representing the lifecycle status of the requisition, such as 'Open', 'Closed', or 'Approved'. |
| LifecycleStatus | String | True |
The display name of the lifecycle status, providing more context about the requisition's stage. |
| HasActionRequiredLinesFlag | Bool | True |
Indicates whether there are lines in the requisition that require action (True/False). |
| IdentificationKey | String | True |
A unique key used to identify the requisition in the system, often used for lookup purposes. |
| LockedByBuyerFlag | Bool | True |
Indicates whether the requisition is locked by the buyer, preventing further changes (True/False). |
| RejectedReason | String | True |
The reason given for rejecting the requisition, providing context for the decision. |
| RejectedById | Long | True |
The unique identifier for the user who rejected the requisition. |
| RejectedByDisplayName | String | True |
The display name of the user who rejected the requisition, used for communication and reporting. |
| RequisitionLineGroup | String | True |
A grouping identifier for requisition lines, typically used to categorize or associate multiple lines together. |
| InsufficientFundsFlag | Bool | False |
Indicates whether the requisition was submitted with insufficient funds and required a funds override (True/False). |
| SpecialHandlingTypeCode | String | False |
An abbreviation that identifies the special handling type for the requisition (for example, 'Bill Only', 'Bill and Replace'). |
| SpecialHandlingType | String | False |
The type of special handling required for the requisition, such as 'Bill Only', 'Bill and Replace', or others. |
| TaxationCountryCode | String | False |
The country code representing the taxation country associated with the requisition. |
| TaxationCountry | String | False |
The display name of the taxation country associated with the requisition. |
| ConcatDocumentFiscalClassificationCode | String | False |
A code that identifies the concatenation of parent classification and document fiscal classification for the requisition. |
| DocumentFiscalClassificationCode | String | False |
A code that identifies the fiscal classification for the document, used for financial and tax reporting. |
| DocumentFiscalClassification | String | False |
The display name of the document fiscal classification, providing context for tax and legal purposes. |
| TaxAttrsUserOverrideHeaderFlag | Bool | True |
Indicates whether the user has overridden the tax attributes at the header level for the requisition. |
| specialHandlingDFF | String | False |
A flexfield column used for special handling data, only applicable during insert operations. |
| summaryAttributes | String | False |
A column used for summary-level attributes, only applicable during insert operations. |
| DFF | String | False |
A column for capturing flexfield data, only applicable during insert operations. |
| lines | String | False |
A column used to reference requisition lines, only applicable during insert operations. |
| BindPreparerId | Long | True |
The identifier used to bind the preparer's data when performing operations on the requisition. |
| BindRequisitionHeaderId | Long | True |
The identifier used to bind the requisition header data during operations. |
| Finder | String | True |
A placeholder or reference for the search functionality to locate requisition records. |
| EffectiveDate | Date | True |
The date from which the requisition data is considered effective, used to filter records within the valid date range. |
Displays item-level details (part, quantity, pricing) for each line in the requisition, forming the basis for purchasing decisions.
The Sync App uses the Oracle Fusion Cloud Financials API to process some of the filters having queryable=true in metadata. The Sync App processes other filters within the Sync App.
For example, the following query is processed server side:
SELECT * FROM [Cdata].[Procurement].[PurchaseRequisitionsLines] WHERE RequisitionLineId=300000294334273
Create an PurchaseRequisitionsLine. PurchaseRequisitionsUniqId is used to uniquely identify the PurchaseRequisition.
You need to provide PurchaseRequisitionsUniqId, instead of PurchaseRequisitionsRequisitionHeaderId , to insert the record.
INSERT into PurchaseRequisitionsLines(PurchaseRequisitionsUniqId,LineNumber,LineTypeId,ItemDescription,Quantity,UOMCode,UOM,Price,CurrencyCode,DestinationOrganizationId,DeliverToLocationId,DestinationTypeCode,RequesterId,CategoryName,RequestedDeliveryDate) values (300000294334268,2,1,'TestSS Item from POST',10,'zzu','Ea',10,'USD',300000047274444,300000047013200,'EXPENSE',300000047340498,'Toilet Paper','2025-02-26')
The Oracle Fusion Cloud Financials API uses PurchaseRequisitionsUniqId instead of PurchaseRequisitionsRequisitionHeaderId and RequisitionLineUniqId instead of RequisitionLineId as a path parameter in the URL to update the record.
If you want to update a record directly using the id (without any other filter), you can update the record in the following way:
Update [Cdata].[Procurement].[PurchaseRequisitionsLines] set Quantity=45 where RequisitionLineUniqId=454545454 and PurchaseRequisitionsUniqID=545;
Note: This does not require any extra GET request to retrieve the UniqId.
Alternatively, if you want to apply any other filter. Please use RequisitionLineId instead of RequisitionLineUniqId and PurchaseRequisitionsRequisitionHeaderId instead of PurchaseRequisitionsUniqId. You can update the record in the following way:
Update [Cdata].[Procurement].[PurchaseRequisitionsLines] set Quantity=45 where PurchaseRequisitionsRequisitionHeaderId=545 and Quantity=4
Note : Update on aggregates are not allowed by API, use the child tables to add/update/delete aggregates.
The Oracle Fusion Cloud Financials API uses PurchaseRequisitionsUniqId instead of PurchaseRequisitionsRequisitionHeaderId and RequisitionLineUniqId instead of RequisitionLineId as a path parameter in the URL to delete the record.
If you want to delete a record directly using the id (without any other filter), you can delete the record in the following way:
Delete from [Cdata].[Procurement].[PurchaseRequisitionsLines] where RequisitionLineUniqId=454545454 and PurchaseRequisitionsUniqID=545;
Note: This does not require any extra GET request to retrieve the UniqId.
Alternatively, if you want to apply any other filter. Please use RequisitionLineId instead of RequisitionLineUniqId and PurchaseRequisitionsRequisitionHeaderId instead of PurchaseRequisitionsUniqId. You can delete the record in the following way:
Delete from [Cdata].[Procurement].[PurchaseRequisitionsLines] where PurchaseRequisitionsRequisitionHeaderId=545 and Quantity=4
| Name | Type | ReadOnly | Description |
| PurchaseRequisitionsRequisitionHeaderId [KEY] | Long | True |
The unique identifier for the requisition header associated with this requisition line. This field links the line to the overall requisition. Example: 1001 for requisition ID 1001. |
| PurchaseRequisitionsUniqId [KEY] | String | True |
A unique identifier for the requisition. It is used for insert, update, and delete operations in place of the RequisitionHeaderId. Example: 'REQ1001' could be a unique ID. |
| RequisitionHeaderId | Long | True |
The identifier for the requisition header associated with this requisition line. This value connects the requisition line to the requisition it belongs to. Example: 12345. |
| RequisitionLineId [KEY] | Long | True |
A unique identifier for the individual requisition line. This is used to track a specific item or service requested in the requisition. Example: 001 for line 1 in the requisition. |
| RequisitionLineUniqId [KEY] | String | True |
A unique identifier for the requisition line. Used instead of RequisitionLineId for insert, update, and delete operations. Example: 'LINE1001'. |
| LineNumber | Decimal | False |
The sequential number assigned to the requisition line. It helps in ordering and referencing the requisition lines. Example: 1 for the first line, 2 for the second. |
| SmartFormId | Long | False |
The identifier for the SmartForm associated with the requisition line. A SmartForm can help streamline data entry or automate processes. Example: 456 for a custom SmartForm. |
| SmartFormName | String | False |
The name of the SmartForm associated with this requisition line, used for identifying and organizing forms. Example: 'Basic Requisition Form'. |
| ParentRequisitionLineId | Long | True |
The identifier for the parent requisition line, used when there are dependent or related lines within the same requisition. Example: 1001 for the main item in the requisition. |
| LineTypeId | Long | False |
The identifier for the line type of the requisition. This could categorize the line as a product, service, or another category. Example: 2 for a service line. |
| LineTypeCode | String | False |
The code representing the requisition line type, helping to classify the line (for example, 'PROD' for products or 'SRVC' for services). Example: 'SRVC'. |
| LineType | String | True |
A human-readable description of the requisition line type. This helps distinguish between different types of requisition lines. Example: 'Service' or 'Product'. |
| RequisitionLineSource | String | False |
The source from which the requisition line originated. It could be manually created or sourced from an agreement or catalog. Example: 'Manual' or 'Catalog'. |
| CategoryId | Long | False |
The unique identifier for the category to which the requisition line belongs. Categories help in grouping items or services in the requisition. Example: 1001 for 'Office Supplies'. |
| CategoryName | String | False |
The name of the category for the requisition line. This is used for easier classification and reporting. Example: 'Electronics'. |
| ItemDescription | String | False |
A description of the item or service being requested. This provides more details on what is being requisitioned. Example: 'Laptop computer with 15-inch screen'. |
| ItemId | Long | False |
The unique identifier for the item in the item catalog. This links the requisition line to the item being requested. Example: 1234 for a specific product in the catalog. |
| Item | String | False |
The name or code of the item requested. This can be a short, recognizable description. Example: 'Laptop' or 'Office Chair'. |
| ItemRevision | String | False |
The revision number for the item, indicating if it has been updated or changed. Example: 'Rev A' or 'Rev B'. |
| Quantity | Decimal | False |
The quantity of the item or service requested. This determines how many units are needed. Example: 10 for ten laptops. |
| SecondaryQuantity | Decimal | False |
An optional field to capture a secondary quantity in a different unit of measure. For example, if you order 10 boxes, this field could capture the quantity in individual items (for example, 100 items per box). Example: 100 for 10 boxes containing 100 units each. |
| UnitPrice | Decimal | False |
The price per unit of the item or service being requested. This field reflects the negotiated or catalog price per unit. Example: 500 for $500 per laptop. |
| CurrencyCode | String | False |
The currency code used for pricing in this requisition line, such as USD for US Dollars or EUR for Euros. Example: 'USD'. |
| Currency | String | False |
The full name of the currency used in the requisition line. Example: 'US Dollar' or 'Euro'. |
| UOMCode | String | False |
The unit of measure code that represents how the quantity is measured (for example, 'EA' for each, 'BOX' for box). Example: 'EA' for each. |
| UOM | String | False |
The unit of measure that describes the quantity measurement. It could be 'Each', 'Box', or other units depending on the item. Example: 'Each'. |
| SecondaryUOMCode | String | True |
The unit of measure code for the secondary quantity if applicable. This might be used for alternate units like weight or volume. Example: 'KG' for kilograms. |
| SecondaryUOM | String | True |
The unit of measure for the secondary quantity. For example, you could specify weight in kilograms for an item that is ordered by each. Example: 'KG' for kilograms. |
| ConversionRateType | String | False |
The type of conversion rate applied to convert between different currencies or units of measure. Example: 'Spot Rate' for current exchange rates. |
| UserConversionRateType | String | True |
The conversion rate type manually selected by the user, allowing for overrides. Example: 'User-Defined'. |
| ConversionRateDate | Date | False |
The date the conversion rate is based on. This ensures the rate applies to the correct time period. Example: '2023-12-01'. |
| ConversionRate | Decimal | False |
The rate at which quantities or currencies are converted. Example: 1.25 for converting USD to EUR. |
| Price | Decimal | False |
The price at which the item is being requisitioned. This could reflect the standard price or a negotiated price. Example: 200 for $200 per item. |
| LineStatus | String | True |
The current status of the requisition line, such as 'Open', 'Approved', or 'Closed'. Example: 'Open'. |
| LineStatusDisplayValue | String | True |
A user-friendly value for displaying the line status in the system. This may provide more readable options than the status code. Example: 'Pending Approval'. |
| Amount | Decimal | True |
The total amount for the requisition line, calculated as Quantity x UnitPrice. Example: 5000 for 10 units at $500 each. |
| CurrencyAmount | Decimal | False |
The amount for the requisition line expressed in the specified currency. Example: 5000 for 10 units at $500 each in USD. |
| UrgentFlag | Bool | False |
Indicates whether the requisition line is marked as urgent, requiring expedited processing. Example: True for urgent items, False for regular items. |
| NegotiatedByPreparerFlag | Bool | False |
Indicates whether the requisition line price has been negotiated by the preparer. Example: True for negotiated prices. |
| NegotiationRequiredFlag | Bool | False |
Indicates whether the requisition line requires negotiation before approval. Example: True for items requiring special pricing or terms. |
| ProcurementCardFlag | Bool | False |
Indicates whether the requisition line will be paid using a procurement card. Example: True if using a corporate procurement card. |
| SourceAgreementTypeCode | String | False |
The code representing the type of source agreement for the requisition line. This helps identify whether the line is sourced from a blanket agreement, contract, or other sources. Example: 'BPA' for Blanket Purchase Agreement. |
| SourceAgreementType | String | True |
A human-readable description of the source agreement type for the requisition line. Example: 'Contract' or 'Blanket Purchase Agreement'. |
| SourceAgreementHeaderId | Long | False |
The unique identifier for the source agreement header related to the requisition line. This links the requisition line to the original source agreement. Example: 1234 for the blanket agreement. |
| SourceAgreement | String | False |
The name or description of the source agreement, which is the origin of the requisition line. Example: 'Office Supplies Contract'. |
| SourceAgreementLineId | Long | False |
The unique identifier for the line within the source agreement associated with the requisition line. Example: 001 for the first line item in the source agreement. |
| SourceAgreementLineNumber | Decimal | False |
The line number within the source agreement related to the requisition line. This helps track which specific line of the source agreement is being referenced. Example: 1 for the first line. |
| UNNumberId | Long | False |
The unique identifier for the UN number associated with the requisition line. This is used for hazardous materials and safety classification. Example: 789 for a specific hazardous material. |
| UNNumber | String | True |
The UN number associated with the requisition line, identifying dangerous goods for compliance purposes. Example: 'UN1234' for a specific hazardous material. |
| HazardClassId | Long | False |
The identifier for the hazard class of the requisition line item, used for safety and regulatory purposes. Example: 10 for flammable liquids. |
| HazardClass | String | True |
The name or classification of the hazard associated with the requisition line, for example, 'Flammable' or 'Corrosive'. |
| HazardClassCode | String | True |
The code representing the hazard class of the requisition line. This is used in regulatory reporting and classification. Example: 'FL' for flammable materials. |
| UNSPSCCode | String | False |
The UNSPSC (United Nations Standard Products and Services Code) for the requisition line, used for categorizing goods and services. Example: '43211504' for computers. |
| ManufacturerName | String | False |
The name of the manufacturer of the item in the requisition line. This helps identify the supplier of the item. Example: 'HP' for Hewlett Packard. |
| ManufacturerPartNumber | String | False |
The manufacturer's part number for the item, used for tracking specific products. Example: 'HP1234' for a laptop part number. |
| BPAPriceUserOverrideFlag | Bool | True |
Indicates whether the user has overridden the price from the Blanket Purchase Agreement (BPA) for the requisition line. Example: True if the price was adjusted. |
| NewSupplierFlag | Bool | False |
Indicates whether the supplier for this requisition line is new. This can help track new supplier relationships. Example: True if the supplier is newly onboarded. |
| SupplierId | Long | False |
The unique identifier for the supplier associated with the requisition line. This links the requisition to the supplier’s details. Example: 1001 for 'ABC Supplies'. |
| Supplier | String | False |
The name of the supplier for the requisition line. Example: 'XYZ Electronics' or 'Global Supplies'. |
| SupplierSiteId | Long | False |
The unique identifier for the supplier site associated with the requisition line, used to track where goods or services are provided. Example: 001 for 'XYZ Electronics - NY'. |
| SupplierSite | String | False |
The name or code of the supplier site, which refers to the specific location of the supplier. Example: 'XYZ Electronics - LA'. |
| SupplierContactId | Long | False |
The unique identifier for the supplier contact associated with the requisition line, used for communication. Example: 5678 for the main contact person. |
| SupplierContact | String | False |
The name of the supplier contact for the requisition line, used to communicate about the order. Example: 'John Doe' or 'Sarah Smith'. |
| SupplierContactEmail | String | True |
The email address of the supplier contact for the requisition line, used for official correspondence. Example: '[email protected]'. |
| SupplierContactPhone | String | True |
The phone number of the supplier contact for the requisition line, used for communication. Example: '(555) 123-4567'. |
| SupplierContactFax | String | True |
The fax number of the supplier contact for the requisition line, if applicable. Example: '(555) 987-6543'. |
| AdditionalContactEmail | String | False |
An additional email address for contacting the supplier, used for backups or secondary communication. Example: '[email protected]'. |
| SuggestedSupplier | String | False |
The name of the suggested supplier for the requisition line, often used when the original supplier is unavailable. Example: 'ABC Corp' as an alternative to 'XYZ Electronics'. |
| SuggestedSupplierSite | String | False |
The name of the suggested supplier site for the requisition line, used when recommending a different location for fulfillment. Example: 'ABC Corp - NY'. |
| SuggestedSupplierContact | String | False |
The name of the suggested supplier contact for the requisition line, used for managing supplier relationships. Example: 'Jane Doe' for an alternative supplier contact. |
| SuggestedSupplierContactPhone | String | False |
The phone number of the suggested supplier contact, used to manage communication. Example: '(555) 444-5678'. |
| SuggestedSupplierContactFax | String | False |
The fax number of the suggested supplier contact, if applicable. Example: '(555) 444-5679'. |
| SuggestedSupplierContactEmail | String | False |
The email address of the suggested supplier contact, used for backup communication. Example: '[email protected]'. |
| SupplierItemNumber | String | False |
The item number assigned by the supplier for the requisition line, used for item identification. Example: 'ABC123' for a specific part number. |
| RequesterId | Long | False |
The unique identifier for the requester who initiated the requisition line. This links the requisition line to the individual who made the request. Example: 2345 for 'John Doe'. |
| Requester | String | True |
The name of the requester who created the requisition line. Example: 'Jane Smith'. |
| RequesterDisplayName | String | True |
The display name of the requester, which may be formatted differently for easier display. Example: 'Jane S.' |
| RequesterEmail | String | False |
The email address of the requester, used for notifications and correspondence. Example: '[email protected]'. |
| SuggestedBuyerId | Long | False |
The unique identifier for the suggested buyer for the requisition line. Example: 3456 for 'Mike Johnson'. |
| SuggestedBuyer | String | True |
The name of the suggested buyer for the requisition line, often used when a buyer needs to be assigned. Example: 'Mike Johnson'. |
| SuggestedBuyerEmail | String | False |
The email address of the suggested buyer for the requisition line. Example: '[email protected]'. |
| ModifiedByBuyerId | Long | True |
The unique identifier for the buyer who modified the requisition line. Example: 4567 for 'Sarah Lee'. |
| ModifiedByBuyer | String | True |
The name of the buyer who last modified the requisition line. Example: 'Sarah Lee'. |
| AssignedBuyerId | Long | True |
The unique identifier for the buyer assigned to the requisition line for further action. Example: 5678 for 'Alex Patel'. |
| AssignedBuyer | String | True |
The name of the buyer assigned to manage the requisition line. Example: 'Alex Patel'. |
| AssignedBuyerDisplayName | String | True |
The display name of the buyer assigned to the requisition line. Example: 'Alex P.' |
| AssignedBuyerEmail | String | True |
The email address of the assigned buyer for the requisition line. Example: '[email protected]'. |
| RequestedDeliveryDate | Date | False |
The requested date for delivering the item or service in the requisition line. Example: '2023-06-15'. |
| DestinationTypeCode | String | False |
The code representing the destination type for the requisition line (for example, 'WARE' for warehouse, 'STOR' for store). Example: 'WARE'. |
| DestinationType | String | False |
A description of the destination type for the requisition line. Example: 'Warehouse' or 'Store'. |
| DestinationOrganizationId | Long | False |
The unique identifier for the organization where the requisition line’s items are to be delivered. Example: 123 for 'XYZ Corp'. |
| DestinationOrganizationCode | String | False |
The code representing the destination organization. Example: 'XYZ'. |
| DestinationOrganization | String | True |
The name or description of the destination organization for the requisition line. Example: 'XYZ Corp'. |
| DestinationSubinventory | String | False |
The subinventory location within the destination organization where the requisition line’s items will be delivered. Example: 'Main Warehouse'. |
| OneTimeLocationFlag | Bool | True |
Indicates whether the requisition line uses a one-time delivery location, typically for special or temporary addresses. Example: True if the delivery address is a one-time use address. |
| DeliverToLocationId | Long | False |
The unique identifier for the location to which the requisition line’s items are to be delivered. Example: 789 for 'Main Office'. |
| DeliverToLocationCode | String | False |
The code used to reference the specific delivery location for the requisition line. Example: 'NYC' for the New York office. |
| DeliverToAddress | String | True |
The full address where the requisition line’s items will be delivered. Example: '123 Main St, New York, NY 10001'. |
| FormattedDeliverToAddress | String | True |
A version of the delivery address formatted for display or printing. This is typically used for shipping or logistics. Example: '123 Main St, Suite 200, New York, NY 10001'. |
| NoteToBuyer | String | False |
A note for the buyer associated with the requisition line, often containing special instructions or clarifications about the purchase. Example: 'Please prioritize this order for immediate shipment.' |
| NoteToReceiver | String | False |
A note for the receiver of the requisition line’s items, typically containing handling or inspection instructions. Example: 'Inspect for damage before signing for receipt.' |
| NoteToSupplier | String | False |
A note for the supplier providing the requisition line’s items, often containing additional order specifications. Example: 'Please ensure packaging is eco-friendly.' |
| RequisitionLineInPool | String | True |
Indicates whether the requisition line is in a pool, awaiting further processing or approval. Example: 'Yes' if the line is in the approval pool. |
| POAutomationFailedReasonCode | String | True |
The code representing the reason for failure in the purchase order automation process. This helps in troubleshooting automation issues. Example: 'PRICE_ERR' for pricing errors. |
| POAutomationFailedReason | String | True |
A detailed description of why the purchase order automation failed for the requisition line. Example: 'Price mismatch with the supplier catalog'. |
| POHeaderId | Long | True |
The unique identifier for the purchase order header created from the requisition line, used to track the PO associated with the requisition. Example: 10234 for 'PO10234'. |
| POLineId | Long | True |
The unique identifier for the purchase order line associated with the requisition line, helping to link the requisition to the created purchase order. Example: 1 for the first line in the PO. |
| PurchaseOrder | String | True |
The purchase order number generated for the requisition line. This number is used for tracking the order. Example: 'PO12345'. |
| POBuyerId | Long | True |
The unique identifier for the buyer assigned to the purchase order for the requisition line. Example: 4001 for 'Alice Green'. |
| BuyerOnPurchaseOrder | String | True |
The name of the buyer responsible for the purchase order generated from the requisition line. Example: 'Alice Green'. |
| SupplierOnPurchaseOrder | String | True |
The name of the supplier listed on the purchase order associated with the requisition line. Example: 'ABC Electronics'. |
| ProcurementBUId | Long | True |
The unique identifier for the procurement business unit handling the requisition line. Example: 5001 for 'Procurement Department'. |
| ProcurementBU | String | True |
The name of the procurement business unit managing the requisition line. Example: 'Global Procurement'. |
| SourceTypeCode | String | False |
The code representing the source type for the requisition line, such as 'Manual' for manually created requisitions or 'Catalog' for items selected from a catalog. Example: 'Manual'. |
| SourceType | String | False |
The description of the source type for the requisition line, such as 'Manual' or 'Catalog'. Example: 'Catalog' for sourced items. |
| SourceOrganizationId | Long | False |
The unique identifier for the source organization where the requisition line originated. Example: 2001 for 'North America Sales'. |
| SourceOrganizationCode | String | False |
The code representing the source organization where the requisition line originated. Example: 'NAM' for North America. |
| SourceOrganization | String | True |
The name or description of the organization from which the requisition line originated. Example: 'North America Sales'. |
| SourceSubinventory | String | False |
The subinventory where the requisition line originates, used for inventory tracking. Example: 'Main Warehouse'. |
| TransferOrderHeaderId | Long | True |
The unique identifier for the transfer order header associated with the requisition line, typically used for internal transfers. Example: 301 for 'Transfer Order 301'. |
| TransferOrder | String | True |
The transfer order number associated with the requisition line, used to track internal inventory transfers. Example: 'TO123'. |
| TransferOrderLineId | Long | True |
The unique identifier for the transfer order line related to the requisition line. Example: 1 for the first line in the transfer order. |
| NegotiationHeaderId | Long | True |
The unique identifier for the negotiation header associated with the requisition line, indicating that the line was part of a negotiation process. Example: 400 for 'Neg-400'. |
| Negotiation | String | True |
The description or name of the negotiation associated with the requisition line. Example: 'Supplier Negotiation for 2023 Electronics'. |
| NegotiationLineNumber | Decimal | True |
The line number in the negotiation related to the requisition line. Example: 1 for the first line in the negotiation. |
| ResponseNumber | Decimal | True |
The response number associated with the requisition line in a negotiation process, helping track different offers. Example: 1 for the first response. |
| ResponseLineNumber | Decimal | True |
The line number of the response in the negotiation process. Example: 1 for the first line in the response. |
| OnNegotiationFlag | Bool | True |
Indicates whether the requisition line is currently under negotiation. Example: True if the item is under negotiation for better terms. |
| WorkOrderId | Long | True |
The unique identifier for the work order associated with the requisition line, used to track internal production or service orders. Example: 6001 for 'WO6001'. |
| WorkOrder | String | True |
The work order number associated with the requisition line. Example: 'WO12345'. |
| WorkOrderOperationId | Long | True |
The unique identifier for the operation in the work order associated with the requisition line. Example: 101 for 'Operation 1'. |
| WorkOrderOperationSequence | Decimal | True |
The sequence number for the operation in the work order, used for tracking work order progress. Example: 1 for the first operation. |
| WorkOrderProduct | String | True |
The product or service associated with the work order operation for the requisition line. Example: 'Custom Widget'. |
| WorkOrderSubType | String | True |
The subtype of the work order related to the requisition line, used for additional classification of work order types. Example: 'Assembly'. |
| BackToBackFlag | Bool | True |
Indicates whether the requisition line is linked to a back-to-back process, often used in supply chain to automatically create purchase orders from requisitions. Example: True if the line is back-to-back. |
| ConfiguredItemFlag | Bool | True |
Indicates whether the requisition line is for a configured item that requires customization. Example: True for customized laptop configurations. |
| DeliverToCustomerId | Long | True |
The unique identifier for the customer receiving the requisition line’s goods. Example: 7890 for 'Acme Corp'. |
| DeliverToCustomer | String | True |
The name of the customer receiving the requisition line’s goods. Example: 'Acme Corp'. |
| DeliverToCustomerLocationId | Long | False |
The location ID where the requisition line’s items are to be delivered, typically used for multiple customer locations. Example: 101 for 'Main Office'. |
| RequestedShipDate | Date | True |
The requested date for shipping the requisition line’s items. Example: '2023-05-15'. |
| SalesOrderLineNumber | String | True |
The sales order line number associated with the requisition line, helping to track sales orders and their requisitions. Example: 'SO1234-1'. |
| SalesOrder | String | True |
The sales order number associated with the requisition line, linking the requisition to a customer order. Example: 'SO1234'. |
| SalesOrderScheduleNumber | String | True |
The schedule number for the sales order associated with the requisition line. Example: 'SO1234-S1'. |
| ShipToCustomerId | Long | True |
The unique identifier for the customer to whom the goods in the requisition line are shipped. Example: 12345 for 'XYZ Corp'. |
| ShipToCustomer | String | True |
The name of the customer receiving the goods in the requisition line. Example: 'XYZ Corp'. |
| ServiceLevelCode | String | True |
The code representing the service level agreement for the requisition line, indicating the level of service expected. Example: 'EXP' for expedited shipping. |
| ServiceLevel | String | True |
The description of the service level associated with the requisition line. This could indicate the urgency or type of service provided. Example: 'Expedited' or 'Standard'. |
| ModeOfTransportCode | String | True |
The code representing the mode of transport for the requisition line, used to track how the goods are delivered. Example: 'AIR' for air transport. |
| ModeOfTransport | String | True |
The description of the transport mode for the requisition line. This provides details about how the goods are being delivered. Example: 'Air Freight' or 'Ground Shipping'. |
| CarrierId | Long | True |
The unique identifier for the carrier responsible for transporting the requisition line’s goods. Example: 2001 for 'FedEx'. |
| Carrier | String | True |
The name of the carrier responsible for shipping the requisition line’s goods. Example: 'FedEx' or 'UPS'. |
| CreatedBy | String | True |
The username or identifier of the user who created the requisition line. Example: 'JohnDoe' or 'JaneSmith'. |
| CreationDate | Datetime | True |
The date and time when the requisition line was created. This timestamp is important for tracking the requisition’s creation. Example: '2023-01-15 09:00:00'. |
| LastUpdatedBy | String | True |
The username or identifier of the user who last updated the requisition line. Example: 'MikeBrown'. |
| LastUpdateDate | Datetime | True |
The date and time when the requisition line was last modified. This helps track changes over time. Example: '2023-01-20 12:30:00'. |
| LastSubmittedDate | Datetime | True |
The date and time when the requisition line was last submitted for approval. Example: '2023-01-18 10:00:00'. |
| LastApprovalDate | Datetime | True |
The date and time when the requisition line was last approved. Example: '2023-01-19 14:30:00'. |
| OriginalSubmittedDate | Datetime | True |
The original date and time when the requisition line was first submitted for approval. Example: '2023-01-15 09:00:00'. |
| OriginalApprovalDate | Datetime | True |
The original date and time when the requisition line was first approved. Example: '2023-01-16 11:00:00'. |
| CancelDate | Date | True |
The date when the requisition line was canceled, indicating the end of its process. Example: '2023-01-20'. |
| CancelReason | String | True |
The reason for canceling the requisition line, providing context for the cancellation. Example: 'Budget Constraints'. |
| RequisitionLinePOInstanceId | Long | True |
The unique identifier for the purchase order instance created from the requisition line. This helps link requisition lines to generated POs. Example: 12345. |
| BuyerProcessingFlag | Bool | True |
Indicates whether the requisition line is being actively processed by the buyer. Example: True if the buyer is handling the line. |
| RequisitionLineGroup | String | True |
A grouping identifier for requisition lines, often used to categorize lines with similar characteristics or processes. Example: 'Tech Equipment'. |
| ProductType | String | False |
The type of product requested in the requisition line, helping to classify the type of goods or services. Example: 'Hardware' or 'Software'. |
| ProductTypeCode | String | False |
The code used to represent the product type in the requisition line. Example: 'HW' for hardware or 'SW' for software. |
| LineImageURL | String | True |
The URL linking to an image of the product associated with the requisition line. Example: 'http://example.com/product123.jpg'. |
| SupplierItemAuxiliaryId | String | False |
An auxiliary identifier for the item assigned by the supplier, used for tracking products that may have additional identifiers. Example: 'AUX12345'. |
| DisableAutosourceFlag | Bool | False |
Indicates whether autosourcing is disabled for the requisition line, preventing the system from automatically sourcing items. Example: True if autosourcing is turned off. |
| DeliverToOneTimeAddress | String | True |
The address used for one-time deliveries. This is often used for special or temporary addresses. Example: '456 Temporary St, New York, NY'. |
| LineTypeOrderTypeLookupCode | String | True |
The lookup code representing the order type for the requisition line, indicating the type of purchase or service. Example: 'PURCHASE' for a standard purchase order. |
| ReturnedByBuyerId | Long | True |
The unique identifier for the buyer who returned the requisition line, usually due to issues with the order. Example: 7890 for 'Alice Green'. |
| ReturnedByBuyerDisplayName | String | True |
The display name of the buyer who returned the requisition line. Example: 'Alice Green'. |
| ReturnReason | String | True |
The reason provided for returning the requisition line, indicating why it was rejected or returned. Example: 'Incorrect Product'. |
| LifecycleStatusCode | String | True |
The code representing the lifecycle status of the requisition line, which shows the current stage of processing. Example: 'OPEN', 'APPROVED'. |
| LifecycleStatus | String | True |
The display name of the requisition line’s lifecycle status, giving more context to the processing stage. Example: 'Approved' or 'In Review'. |
| ActionRequiredCode | String | True |
The code representing the action required for the requisition line, such as 'Approve' or 'Review'. Example: 'APPROVE'. |
| ActionRequired | String | True |
The description of the action required for the requisition line, helping users understand what is needed. Example: 'Approval Needed' or 'Price Review'. |
| POCancelReason | String | True |
The reason for canceling the associated purchase order, if applicable. Example: 'Vendor Delayed Shipment'. |
| POHoldReason | String | True |
The reason the purchase order for the requisition line is placed on hold. Example: 'Payment Issue'. |
| PublicShoppingListHeaderId | Long | False |
The unique identifier for the public shopping list header associated with the requisition line, used for shared requisition lists. Example: 3210 for 'Public Shopping List'. |
| InformationTemplateTouchedFlag | Bool | False |
Indicates whether the information template has been modified for the requisition line. Example: True if the template was edited. |
| FundsStatusCode | String | True |
The code representing the funds status for the requisition line, indicating whether funds are available. Example: 'AVAILABLE' or 'INSUFFICIENT'. |
| FundsStatus | String | True |
The description of the funds status, helping to understand the availability of funds. Example: 'Available' or 'Not Approved'. |
| LifecycleSecondaryStatus | String | True |
An additional status indicating the secondary stage of the requisition line’s lifecycle. Example: 'Under Review' or 'Awaiting Approval'. |
| ItemUserOverrideFlag | Bool | False |
Indicates whether the item was manually overridden by the user. Example: True if the user changed the item details. |
| BPADescriptionUserOverrideFlag | Bool | True |
Indicates whether the description for the BPA (Blanket Purchase Agreement) was overridden by the user. Example: True if the description was customized. |
| EPPLineId | Long | False |
The unique identifier for the EPP (Enhanced Purchase Process) line associated with the requisition. Example: 45678 for the specific EPP line. |
| MarketplaceItemId | String | False |
The unique identifier for the item in an external marketplace associated with the requisition line. Example: 'MARKET1234' for an item listed on a marketplace. |
| ConcatTransactionBusinessCategoryCode | String | False |
The concatenated code representing the transaction business category for the requisition line, used for classification and grouping purposes. Example: 'OFFICE-TECH' for office technology items. |
| TransactionBusinessCategory | String | False |
The business category associated with the requisition line, providing an easy classification of the item or service being requisitioned. Example: 'Office Equipment' or 'Software'. |
| TransactionBusinessCategoryCode | String | False |
The code representing the business category of the requisition line for internal classification. Example: 'TECH' for technology items. |
| TaxationCountryCode | String | True |
The code representing the taxation country for the requisition line, helping to determine tax rates and rules. Example: 'US' for the United States. |
| ConcatDocumentFiscalClassificationCode | String | True |
The concatenated code combining the document’s fiscal classification with the requisition line’s data, used for tax reporting. Example: 'TAX-USA' for items taxed in the U.S. |
| ProductFiscalClassificationCode | String | False |
The code representing the fiscal classification of the product in the requisition line, used for tax reporting and compliance. Example: 'EXEMPT' for tax-exempt products. |
| ProductFiscalClassificationId | Long | False |
The unique identifier for the fiscal classification of the product in the requisition line, helping with tax reporting and categorization. Example: 101 for 'Exempt Product'. |
| ConcatProductCategoryCode | String | False |
The concatenated code representing the product category associated with the requisition line, used for classification. Example: 'COMPUTER-HARDWARE'. |
| IntendedUseCode | String | False |
The code that defines the intended use for the requisitioned item, helping to categorize it for specific purposes. Example: 'OFFICE' for office use. |
| IntendedUseId | Long | False |
The unique identifier for the intended use of the requisition line’s item, linking the item to its specific use. Example: 5001 for 'Office Equipment'. |
| UserDefinedFiscalClassificationCode | String | False |
The user-defined fiscal classification code for the requisition line, allowing for customization in tax or accounting processes. Example: 'REGULAR' for standard tax rate items. |
| TaxClassificationCode | String | False |
The tax classification code associated with the requisition line, used to apply the appropriate tax rules. Example: 'TAXABLE' for taxable goods. |
| AssessableValue | Decimal | False |
The assessable value for tax purposes, used to calculate the amount that will be taxed. Example: 200 for an item with a taxable value of $200. |
| FirstPartyTaxRegId | Long | False |
The tax registration ID for the first party involved in the transaction, used for tax reporting. Example: 12345 for 'ABC Corp'. |
| ThirdPartyTaxRegId | Long | False |
The tax registration ID for the third party involved in the transaction, if applicable. Example: 67890 for a third-party supplier. |
| LocationOfFinalDischargeId | Long | False |
The identifier for the location where the goods will be finally discharged or delivered, relevant for customs or taxation. Example: 1001 for 'Port of Los Angeles'. |
| LocationOfFinalDischargeCode | String | True |
The code representing the location of final discharge for the requisition line, typically used in shipping and logistics. Example: 'LA' for the 'Port of Los Angeles'. |
| FirstPartyTaxRegNumber | String | True |
The tax registration number for the first party involved in the transaction, typically used for tax compliance. Example: '123-456-7890'. |
| CostCenter | String | True |
The cost center associated with the requisition line, used for budgeting and accounting purposes. Example: 'Sales Office'. |
| IntendedUse | String | False |
The intended use of the item requested in the requisition line, often used to justify the purchase. Example: 'Office Supplies' or 'Manufacturing Equipment'. |
| ProductFiscalClassification | String | False |
The fiscal classification of the product in the requisition line, which helps determine tax rates and rules. Example: 'Taxable' or 'Exempt'. |
| ThirdPartyTaxRegNumber | String | False |
The tax registration number for a third party involved in the requisition line, used for compliance and tax reporting. Example: '987-654-3210'. |
| UserDefinedFiscalClassification | String | False |
The user-defined classification for the requisition line, allowing for customized tax reporting or accounting. Example: 'Import Tax' or 'Local Tax'. |
| DocumentFiscalClassificationCode | String | True |
The fiscal classification code for the document associated with the requisition line, affecting tax treatment. Example: 'VAT'. |
| DocumentFiscalClassification | String | True |
The description of the document’s fiscal classification, indicating how it should be treated for tax purposes. Example: 'Exempt' or 'Standard Rate'. |
| TaxationCountry | String | True |
The country associated with the taxation of the requisition line, used to determine tax rates and apply country-specific rules. Example: 'USA' or 'Germany'. |
| ProductCategory | String | False |
The category to which the product belongs, used for classification and reporting purposes. Example: 'Electronics' or 'Furniture'. |
| ProductCategoryCode | String | False |
The code representing the category of the product in the requisition line, helping to classify it for accounting and procurement purposes. Example: 'EL' for Electronics. |
| TaxClassification | String | False |
The classification that determines how the requisition line is taxed, used to ensure compliance with tax laws. Example: 'Sales Tax' or 'Exempt'. |
| TaxAttrsUserOverrideLineFlag | Bool | True |
Indicates whether the user has overridden the tax attributes for the requisition line. Example: True if the user modified the tax classification. |
| SuggestedPrcBUId | Long | False |
The unique identifier for the suggested procurement business unit for the requisition line, guiding where the procurement will occur. Example: 4001 for 'Central Procurement'. |
| informationTemplates | String | False |
This field is for insert operations only. For updates or deletions, use operations on the child table. This field is typically used to reference a template for item or requisition details. |
| DFF | String | False |
This field is for insert operations only. For updates or deletions, use operations on the child table. This is a reference to a descriptive flexfield for capturing custom data. |
| specialHandlingDFF | String | False |
This field is for insert operations only. For updates or deletions, use operations on the child table. This field tracks special handling requirements for the requisition line. |
| distributions | String | False |
This field is for insert operations only. For updates or deletions, use operations on the child table. It links the requisition line to any distribution-related data or financial postings. |
| BindPreparerId | Long | True |
The unique identifier for the preparer, used to link the requisition line to the user who created it. Example: 5001 for 'John Doe'. |
| BindRequisitionHeaderId | Long | True |
The unique identifier for the requisition header, helping to link the requisition line to its parent header record. Example: 2001 for 'Requisition 2001'. |
| Finder | String | True |
A reference field used for searching requisition lines within the system, allowing users to filter and locate specific requisitions. Example: 'Search by Item'. |
| CUReferenceNumber | Int | False |
The reference number linking child aggregates with their parent tables, ensuring data integrity between the requisition lines and parent records. Example: 1001 for 'Requisition Line 1'. |
| EffectiveDate | Date | True |
The date from which the requisition line is considered effective. This is typically used to filter records by date range or to apply business logic. Example: '2023-01-01'. |
Manages core supplier records, including contact details, addresses, business classifications, and attachments.
The Sync App uses the Oracle Fusion Cloud Financials API to process some of the filters having queryable=true in metadata. The Sync App processes other filters within the Sync App.
For example, the following query is processed server side:
SELECT * FROM [Cdata].[Procurement].[Suppliers] WHERE SupplierId = 10003
Create a Supplier.
INSERT INTO [Cdata].[Procurement].[Suppliers] (BusinessRelationshipCode,Supplier,TaxOrganizationTypeCode) VALUES ('SPEND_AUTHORIZED', 'Lee Supplies1', 'CORPORATION')
You can also add aggregates with the parent table, using TEMP table and aggregates. Please refer to Invoices.
The Oracle Fusion Cloud Financials API uses SupplierUniqId instead of SupplierId as a path parameter in the URL to update the record.
If you want to update a record directly using the id (without any other filter), you can update the record in the following way:
Update [Cdata].[Procurement].[Suppliers] set YearEstablished=2021 where SupplierUniqId = 454545454;
Note: This does not require any extra GET request to retrieve the UniqId.
Alternatively, if you want to apply any other filter. Please use SupplierId instead of SupplierUniqId. You can update the record in the following way:
Update [Cdata].[Procurement].[Suppliers] set YearEstablished=2021 where SupplierUniqId = 454545454 and ParentSupplier='asdw';
Note : Update on aggregates are not allowed by API, use the child tables to add/update/delete aggregates.
| Name | Type | ReadOnly | Description |
| SupplierId [KEY] | Long | True |
The unique identifier assigned to each supplier in the system. |
| SupplierUniqId [KEY] | String | True |
This value should be used in all insert, update, and delete operations as a more stable identifier than SupplierId. |
| SupplierPartyId | Long | False |
A unique identifier for the supplier party, which can represent an entity or organization associated with the supplier. |
| Supplier | String | False |
The official name of the supplier as recorded in the system. |
| SupplierNumber | String | False |
An identifier used to distinguish the supplier, often assigned by external systems or organizations. |
| AlternateName | String | False |
An alternate or secondary name for the supplier, which may be used in different contexts or regions. |
| TaxOrganizationTypeCode | String | False |
The abbreviation identifying the supplier's tax organization type. The valid values are defined in the lookup type POZ_ORGANIZATION_TYPE, which can be managed through the Setup and Maintenance work area. |
| TaxOrganizationType | String | False |
The full description of the tax organization type associated with the supplier, based on the lookup type POZ_ORGANIZATION_TYPE. |
| SupplierTypeCode | String | False |
A code representing the type of supplier according to the lookup type POZ_VENDOR_TYPE, which can be maintained in the Setup and Maintenance work area. |
| SupplierType | String | False |
The description of the supplier type, as defined in the POZ_VENDOR_TYPE lookup. This value should be updated as needed. |
| InactiveDate | Date | False |
The date when the supplier was marked as inactive in the system, meaning they no longer conduct business. |
| Status | String | True |
The current operational status of the supplier, which may include values such as active, inactive, or pending. |
| BusinessRelationshipCode | String | False |
A code representing the business relationship between the enterprise and the supplier, defined in the lookup type ORA_POZ_BUSINESS_RELATIONSHIP. |
| BusinessRelationship | String | False |
A textual description of the business relationship with the supplier, providing more context about the supplier's role. |
| ParentSupplierId | Long | False |
The unique identifier for the parent supplier, if applicable. This is used to track hierarchical supplier relationships. |
| ParentSupplier | String | False |
The name of the parent supplier in the supplier hierarchy, which may be relevant for organizations with multiple subsidiary suppliers. |
| ParentSupplierNumber | String | True |
The unique identifier for the parent supplier, which may be assigned by external systems or the supplier itself. |
| CreationDate | Datetime | True |
The timestamp of when the supplier record was created in the system. |
| CreatedBy | String | True |
The name or identifier of the user who created the supplier record. |
| LastUpdateDate | Datetime | True |
The timestamp of the last update made to the supplier record. |
| LastUpdatedBy | String | True |
The name or identifier of the user who last updated the supplier record. |
| CreationSourceCode | String | True |
A code that identifies the source of the supplier record creation, such as an integration system or manual entry. |
| CreationSource | String | True |
A description of the source from which the supplier record was created, providing additional context. |
| DataFoxScore | Long | False |
An intelligence score assigned to the supplier by Oracle DataFox. Although the attribute exists, it is not currently being used in the system. |
| DataFoxScoringCriteria | String | False |
A detailed explanation of the criteria used by Oracle DataFox to assign scores to suppliers, though this is not currently active. |
| Alias | String | False |
An alternate internal name used for the supplier organization, useful for internal references or different naming conventions. |
| DUNSNumber | String | False |
A unique number assigned to the supplier organization by Dun & Bradstreet for identification in business transactions. |
| OneTimeSupplierFlag | Bool | False |
Indicates whether the supplier is a one-time supplier (true) or not (false). By default, the value is false. |
| RegistryId | String | True |
An identifier for the supplier's registration in a relevant registry or official record. |
| CustomerNumber | String | False |
The unique number the supplier assigns to the buying organization for tracking purposes. |
| StandardIndustryClass | String | False |
The standard industry classification code assigned to the supplier, which categorizes their business within a specific industry. |
| IndustryCategory | String | False |
A code representing the supplier's industry category, as defined by Oracle DataFox intelligence. This attribute is not currently in use. |
| IndustrySubcategory | String | False |
A code representing the supplier's industry subcategory, also provided by Oracle DataFox intelligence, but not in use. |
| NationalInsuranceNumber | String | False |
A unique identification number for a supplier who is an individual, used by some countries for tracking work, taxation, and government benefits. |
| NationalInsuranceNumberExistsFlag | Bool | False |
Indicates whether the National Insurance number is available for the supplier (true) or not (false). By default, the value is false. |
| CorporateWebsite | String | False |
The official website URL for the supplier organization. |
| YearEstablished | Int | False |
The year the supplier organization was originally established. |
| MissionStatement | String | False |
A description of the supplier's mission or core values as defined by the organization. |
| YearIncorporated | Int | False |
The year when the supplier organization was formally incorporated as a legal entity. |
| ChiefExecutiveTitle | String | False |
The formal title of the chief executive officer within the supplier organization. |
| ChiefExecutiveName | String | False |
The name of the individual currently serving as the chief executive officer of the supplier organization. |
| PrincipalTitle | String | False |
The formal title of the principal officer within the supplier organization. |
| PrincipalName | String | False |
The name of the principal officer responsible for managing the supplier organization. |
| FiscalYearEndMonthCode | String | False |
A code representing the month when the fiscal year ends for the supplier organization. Valid values are defined in the MONTH lookup type. |
| FiscalYearEndMonth | String | False |
The full name of the month when the fiscal year ends for the supplier organization, such as 'December' or 'June.' |
| CurrentFiscalYearPotentialRevenue | Decimal | False |
The estimated potential revenue that the supplier expects to generate during the current fiscal year. |
| PreferredFunctionalCurrencyCode | String | False |
The currency code used by the supplier in their financial transactions. This value is defined by the supplier organization. |
| PreferredFunctionalCurrency | String | False |
The full name of the currency that the supplier prefers to use for financial transactions, such as 'USD' or 'EUR.' |
| TaxRegistrationCountryCode | String | False |
A code representing the country where the supplier is registered for value-added tax purposes. |
| TaxRegistrationCountry | String | False |
The full name of the country where the supplier is registered for value-added tax purposes. |
| TaxRegistrationNumber | String | False |
A unique identification number assigned to the supplier for tax purposes in some countries, such as those in the European Union. |
| TaxpayerCountryCode | String | False |
A code representing the country where the supplier organization is responsible for paying taxes. |
| TaxpayerCountry | String | False |
The full name of the country where the supplier organization is located and responsible for tax obligations. |
| TaxpayerId | String | False |
A unique identification number for the supplier used for tax reporting purposes. |
| TaxpayerIdExistsFlag | Bool | False |
Indicates whether the taxpayer ID is available for the supplier (true) or not (false). By default, the value is false. |
| FederalReportableFlag | Bool | False |
Indicates whether the supplier is reportable to the Internal Revenue Service (IRS) in the United States under the 1099 tax code. |
| FederalIncomeTaxTypeCode | String | False |
A code identifying the type of income tax that applies to the supplier for IRS 1099 reporting purposes. |
| FederalIncomeTaxType | String | False |
A description of the type of income tax that applies to the supplier, used for IRS 1099 reporting. |
| StateReportableFlag | Bool | False |
Indicates whether the supplier is reportable to a state taxing authority in the United States for tax purposes. |
| TaxReportingName | String | False |
The name used for tax reporting purposes for suppliers who are reportable under the IRS 1099 tax code. |
| NameControl | String | False |
The first four characters of the supplier's last name, used for IRS 1099 reporting and matching. |
| VerificationDate | Date | False |
The date when the supplier's tax verification for the 1099 tax code was most recently updated. |
| UseWithholdingTaxFlag | Bool | False |
Indicates whether withholding tax is applicable to the supplier (true) or not (false). By default, the value is false. |
| WithholdingTaxGroupId | Long | False |
The unique identifier for the tax group assigned to the supplier for withholding tax purposes. |
| WithholdingTaxGroup | String | False |
The description of the withholding tax group assigned to the supplier based on applicable tax regulations. |
| BusinessClassificationNotApplicableFlag | Bool | False |
Indicates whether a business classification is applicable to the supplier (false) or not (true). By default, the value is false. |
| DataFoxId | String | False |
The unique identifier assigned by Oracle DataFox to the company linked with the supplier. This attribute is not in use. |
| DataFoxCompanyName | String | False |
The company name provided by Oracle DataFox for the linked supplier organization. This attribute is not in use. |
| DataFoxLegalName | String | False |
The legal name of the supplier company as provided by Oracle DataFox. This attribute is not in use. |
| DataFoxCompanyPrimaryURL | String | False |
The primary website URL for the supplier as tracked by Oracle DataFox. This attribute is not in use. |
| DataFoxNAICSCode | String | False |
The NAICS code provided by Oracle DataFox for the supplier organization. This attribute is not in use. |
| DataFoxCountry | String | False |
The country where the supplier organization is located, as provided by Oracle DataFox. This attribute is not in use. |
| DataFoxEIN | String | False |
The employer identification number (EIN) provided by Oracle DataFox for the supplier organization. This attribute is not in use. |
| DataFoxLastSyncDate | Datetime | False |
The timestamp when the supplier profile was last synchronized with Oracle DataFox. This attribute is not in use. |
| OBNEnabledFlag | Bool | True |
Indicates whether the OBN (Oracle Business Network) feature is enabled for the supplier. |
| OnOFACListFlag | Bool | False |
Indicates whether the supplier is listed on the US Government's Office of Foreign Assets Control (OFAC) list, which tracks sanctioned individuals and organizations. |
| OFACSources | String | False |
Details about the specific lists within the US Government's consolidated screening list that the supplier appears on, such as from the Office of Foreign Assets Control. |
| contacts | String | False |
Used only for insert operations. For update and delete, use the appropriate child table operations. |
| productsAndServices | String | False |
Used only for insert operations. For update and delete, use the appropriate child table operations. |
| DFF | String | False |
Used only for insert operations. For update and delete, use the appropriate child table operations. |
| globalDFF | String | False |
Used only for insert operations. For update and delete, use the appropriate child table operations. |
| businessClassifications | String | False |
Used only for insert operations. For update and delete, use the appropriate child table operations. |
| sites | String | False |
Used only for insert operations. For update and delete, use the appropriate child table operations. |
| addresses | String | False |
Used only for insert operations. For update and delete, use the appropriate child table operations. |
| BilltoBuId | Long | True |
The unique identifier for the billing business unit associated with the supplier. |
| BindPurchaseFlag | String | True |
A flag that indicates whether the supplier is bound to a particular purchase type or condition. |
| BindReqBuId | Long | True |
The unique identifier for the required business unit associated with the supplier. |
| BindSourcingOnlyFlag | String | True |
Indicates whether the supplier is restricted to sourcing activities only (true or false). |
| BindSysdate | Date | True |
The system date when the binding action was performed for the supplier. |
| Finder | String | True |
A reference to a search or lookup system associated with the supplier record. |
Captures location data for suppliers, such as physical or mailing addresses, to support invoicing and shipping.
The Sync App uses the Oracle Fusion Cloud Financials API to process some of the filters having queryable=true in metadata. The Sync App processes other filters within the Sync App.
For example, the following query is processed server side:
SELECT * FROM [Cdata].[Procurement].[Suppliersaddresses] WHERE SupplierAddressId = 10003
Create a Supplieraddress.
You need to provide SuppliersUniqId, instead of SuppliersSupplierId , to insert the record.
INSERT INTO [Cdata].[Procurement].[Suppliersaddresses] (SuppliersUniqId,AddressName,Country,AddressLine1,City,State,PostalCode,AddressPurposeOrderingFlag,AddressPurposeRemitToFlag,AddressPurposeRFQOrBiddingFlag) VALUES ('300000051066029','Headquarter','United States','Example Road','Redwood City','CA','94065',true,true,false)
The Oracle Fusion Cloud Financials API uses SuppliersUniqId instead of SuppliersSupplierId and SupplierAddressUniqId instead of SupplierAddressId as a path parameter in the URL to update the record.
If you want to update a record directly using the id (without any other filter), you can update the record in the following way:
Update [Cdata].[Procurement].[Suppliersaddresses] set PhoneNumber='66565' where SuppliersUniqId = 454545454 and SupplierAddressUniqId=454;
Note: This does not require any extra GET request to retrieve the UniqId. You need to provide all the UniqIds.
Alternatively, if you want to apply any other filter. Please use SuppliersSupplierId instead of SuppliersUniqId and SupplierAddressId instead of SupplierAddressUniqId. You can update the record in the following way:
Update [Cdata].[Procurement].[Suppliersaddresses] set PhoneNumber='66565' where SuppliersSupplierId = 454545454
Note : Update on aggregates are not allowed by API, use the child tables to add/update/delete aggregates.
| Name | Type | ReadOnly | Description |
| SuppliersSupplierId [KEY] | Long | True |
The unique identifier for the supplier associated with the supplier address. |
| SuppliersUniqId [KEY] | String | True |
This value should be used in insert, update, and delete operations instead of SuppliersSupplierId for a more stable reference to the supplier. |
| SupplierAddressId [KEY] | Long | True |
The unique identifier for the supplier address within the system. |
| SupplierAddressUniqId [KEY] | String | True |
This value should be used in insert, update, and delete operations instead of SupplierAddressId for a more stable reference to the address. |
| AddressName | String | False |
The name assigned to the supplier address, which may be used for distinguishing between different addresses associated with the same supplier. |
| CountryCode | String | False |
An abbreviation representing the country where the supplier address is located. |
| Country | String | False |
The full name of the country where the supplier address is located. |
| AddressLine1 | String | False |
The first line of the street address for the supplier's location. |
| AddressLine2 | String | False |
The second line of the street address for the supplier's location, if applicable. |
| AddressLine3 | String | False |
The third line of the street address for the supplier's location, if applicable. |
| AddressLine4 | String | False |
The fourth line of the street address for the supplier's location, if applicable. |
| City | String | False |
The city or locality where the supplier address is located. |
| State | String | False |
The state or province where the supplier address is located. |
| PostalCode | String | False |
The postal code for the supplier address, used for location identification. |
| PostalCodeExtension | String | False |
An optional four-digit extension to the postal code, typically used to further refine the location. |
| Province | String | False |
The province or regional division of the supplier address. |
| County | String | False |
The county or district of the supplier address. |
| Building | String | False |
The building number or name associated with the supplier address. |
| FloorNumber | String | False |
The floor number or specific level within the building for the supplier address. |
| PhoneticAddress | String | False |
The phonetic representation of the supplier address, used for Japanese kana or Chinese kanji scripts. |
| LanguageCode | String | False |
An abbreviation identifying the language in which the supplier address is recorded. |
| Language | String | False |
The full name of the language in which the supplier address is recorded, such as 'English' or 'Japanese.' |
| Addressee | String | False |
The individual or role associated with receiving communications at the supplier address. |
| GlobalLocationNumber | String | False |
The global location number (GLN) assigned to the supplier address for global identification purposes. |
| AdditionalAddressAttribute1 | String | False |
An additional customizable attribute for the supplier address format, allowing flexibility in storing extra address details. |
| AdditionalAddressAttribute2 | String | False |
Another customizable attribute for additional details of the supplier address. |
| AdditionalAddressAttribute3 | String | False |
A third customizable attribute for storing extra information about the supplier address. |
| AdditionalAddressAttribute4 | String | False |
A fourth customizable attribute for storing further address information. |
| AdditionalAddressAttribute5 | String | False |
A fifth customizable attribute for storing additional supplier address details. |
| AddressPurposeOrderingFlag | Bool | False |
Indicates whether the supplier address can be used for ordering purposes. If true, it is usable for order transactions; if false, it is not. |
| AddressPurposeRemitToFlag | Bool | False |
Indicates whether the supplier address is available for sending payments. If true, it can be used for remittance; if false, it cannot. |
| AddressPurposeRFQOrBiddingFlag | Bool | False |
Indicates whether the supplier address can be used for requests for proposal or bidding. If true, it is available for such purposes. |
| PhoneCountryCode | String | False |
The country code associated with the phone number of the supplier address. |
| PhoneAreaCode | String | False |
The area or region code associated with the phone number for the supplier address. |
| PhoneNumber | String | False |
The phone number for the supplier address, used for direct contact. |
| PhoneExtension | String | False |
The extension number for the phone at the supplier address, if applicable. |
| FaxCountryCode | String | False |
The country code associated with the fax number for the supplier address. |
| FaxAreaCode | String | False |
The area or region code for the fax number of the supplier address. |
| FaxNumber | String | False |
The fax number for the supplier address, used for sending documents. |
| String | False |
The email address associated with the supplier address, used for electronic communications. | |
| InactiveDate | Date | False |
The date when the supplier address was marked as inactive, indicating that it is no longer in use. |
| Status | String | True |
The current status of the supplier address, such as active, inactive, or pending. |
| CreationDate | Datetime | True |
The timestamp indicating when the supplier address record was created in the system. |
| CreatedBy | String | True |
The user or system responsible for creating the supplier address record. |
| LastUpdateDate | Datetime | True |
The timestamp of the last update made to the supplier address record. |
| LastUpdatedBy | String | True |
The user or system responsible for the most recent update to the supplier address record. |
| DFF | String | False |
This column can only be used for insert operations. For updates and deletes, use the appropriate child table operations. |
| BilltoBuId | Long | True |
The unique identifier for the billing business unit associated with the supplier address. |
| BindPurchaseFlag | String | True |
A flag indicating whether the supplier address is bound to purchase-related activities. |
| BindReqBuId | Long | True |
The unique identifier for the business unit required for the supplier address. |
| BindSourcingOnlyFlag | String | True |
Indicates whether the supplier address is bound only for sourcing activities (true) or has other uses (false). |
| BindSysdate | Date | True |
The system date when the supplier address binding action occurred. |
| Finder | String | True |
A reference to a lookup or search function used for locating the supplier address. |
| SupplierId | Long | True |
The unique identifier for the supplier associated with this address. |
| CUReferenceNumber | Int | False |
A reference number used to link child aggregates with the parent supplier address data. |
Maintains supplier contact records, including names, emails, and roles for consistent communication and procurement updates.
The Sync App uses the Oracle Fusion Cloud Financials API to process some of the filters having queryable=true in metadata. The Sync App processes other filters within the Sync App.
For example, the following query is processed server side:
SELECT * FROM [Cdata].[Procurement].[Supplierscontacts] WHERE SupplierContactId = 10003
You need to provide SuppliersUniqId, instead of SuppliersSupplierId , to insert the record.
Create a Suppliercontacts. SuppliersUniqId is used to uniquely identify the Supplier.
INSERT INTO [Cdata].[Procurement].[Supplierscontacts] (SuppliersUniqId,Salutation,FirstName,LastName,AdministrativeContactFlag,MobileCountryCode,MobileAreaCode,MobileNumber) VALUES ('300000051066029','Mr.','Test1','Test2',true,'1','650','555-2234')
The Oracle Fusion Cloud Financials API uses SuppliersUniqId instead of SuppliersSupplierId and SupplierContactUniqId instead of SupplierContactId as a path parameter in the URL to update the record.
If you want to update a record directly using the id (without any other filter), you can update the record in the following way:
Update [Cdata].[Procurement].[Supplierscontacts] set PhoneNumber='66565' where SuppliersUniqId = 454545454 and SupplierContactUniqId=454;
Note: This does not require any extra GET request to retrieve the UniqId. You need to provide all the UniqIds.
Alternatively, if you want to apply any other filter. Please use SuppliersSupplierId instead of SuppliersUniqId and SupplierContactId instead of SupplierContactUniqId. You can update the record in the following way:
Update [Cdata].[Procurement].[Supplierscontacts] set PhoneNumber='66565' where SuppliersSupplierId = 454545454
Note : Update on aggregates are not allowed by API, use the child tables to add/update/delete aggregates.
| Name | Type | ReadOnly | Description |
| SuppliersSupplierId [KEY] | Long | True |
The unique identifier for the supplier associated with the supplier contact. |
| SuppliersUniqId [KEY] | String | True |
The stable identifier for the supplier. Use this value in insert, update, and delete operations instead of SuppliersSupplierId. |
| SupplierContactId [KEY] | Long | True |
The unique identifier for the supplier contact, assigned by the system. |
| SupplierContactUniqId [KEY] | String | True |
The stable identifier for the supplier contact. Use this value in insert, update, and delete operations instead of SupplierContactId. |
| SalutationCode | String | False |
An abbreviation identifying the honorific title (for example, Mr., Ms., Dr.) of the supplier contact. Valid values are defined in the CONTACT_TITLE lookup type. |
| Salutation | String | False |
The honorific title for the supplier contact, such as 'Mr.', 'Ms.', 'Dr.', or other formal titles. |
| FirstName | String | False |
The first name of the supplier contact. |
| MiddleName | String | False |
The middle name of the supplier contact, if available. |
| LastName | String | False |
The last name or family name of the supplier contact. |
| JobTitle | String | False |
The job title or position held by the supplier contact within their organization. |
| AdministrativeContactFlag | Bool | False |
Indicates whether the supplier contact is an administrative contact. 'True' means the contact is administrative; 'False' means they are not. The default value is 'False.' |
| PhoneCountryCode | String | False |
An abbreviation representing the country code for the phone number of the supplier contact. |
| PhoneAreaCode | String | False |
An abbreviation representing the area or region code for the phone number of the supplier contact. |
| PhoneNumber | String | False |
The primary phone number for the supplier contact. |
| PhoneExtension | String | False |
The phone extension for the supplier contact, if applicable. |
| MobileCountryCode | String | False |
An abbreviation representing the country code for the mobile phone number of the supplier contact. |
| MobileAreaCode | String | False |
An abbreviation representing the area or region code for the mobile phone number of the supplier contact. |
| MobileNumber | String | False |
The mobile phone number of the supplier contact. |
| FaxCountryCode | String | False |
An abbreviation representing the country code for the fax number of the supplier contact. |
| FaxAreaCode | String | False |
An abbreviation representing the area or region code for the fax number of the supplier contact. |
| FaxNumber | String | False |
The fax number for the supplier contact. |
| String | False |
The email address of the supplier contact. | |
| Status | String | True |
The current status of the supplier contact, such as 'Active,' 'Inactive,' or 'Pending.' |
| InactiveDate | Date | False |
The date when the supplier contact was marked as inactive in the system, indicating they are no longer available for contact. |
| PersonProfileId [KEY] | Long | False |
A unique identifier for the person profile associated with the supplier contact, used for linking the contact to their personal profile. |
| CreationDate | Datetime | True |
The date and time when the supplier contact record was created in the system. |
| CreatedBy | String | True |
The user or system that created the supplier contact record. |
| LastUpdateDate | Datetime | True |
The date and time of the most recent update made to the supplier contact record. |
| LastUpdatedBy | String | True |
The user or system responsible for the last update made to the supplier contact record. |
| DFF | String | False |
This field can only be used during insertion. For updates and deletions, refer to child table operations, if applicable. |
| addresses | String | False |
This field can only be used during insertion. For updates and deletions, refer to child table operations, if applicable. |
| BilltoBuId | Long | True |
The unique identifier for the billing business unit associated with the supplier contact. |
| BindPurchaseFlag | String | True |
Indicates whether the supplier contact is linked to purchase-related activities. The value can be 'true' or 'false.' |
| BindReqBuId | Long | True |
The unique identifier for the business unit required for processing the supplier contact record. |
| BindSourcingOnlyFlag | String | True |
Indicates whether the supplier contact is limited to sourcing-related activities only. 'True' means the contact is restricted to sourcing, while 'False' means they are available for other activities. |
| BindSysdate | Date | True |
The system date when the binding operation for the supplier contact was executed. |
| Finder | String | True |
A reference to a lookup or search function used for locating or retrieving the supplier contact record. |
| SupplierId | Long | True |
The unique identifier for the supplier associated with this contact record. |
| CUReferenceNumber | Int | False |
A reference number used to map child aggregates with their respective parent tables. |
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| CatalogCategoryHierarchyNodes | Organizes catalog categories in a hierarchical structure, enabling guided navigation for items or services in procurement. |
| ComplianceChecklists | Stores procurement compliance checklist details, supporting evaluations or audits of supplier qualifications and practices. |
| ComplianceChecklistTemplates | Defines reusable templates for compliance checklists, allowing systematic creation of supplier qualification or audit processes. |
| ContentZones | Manages content zones that determine available catalogs, forms, and lists in Self Service Procurement, controlling visibility and security. |
| ContentZonescatalogAssignments | Specifies which local, punchout, or informational catalogs are linked to a given content zone, defining available shopping resources. |
| ContentZonespublicShoppingListAssignments | Assigns public shopping lists to a content zone, allowing employees to access common requisition items in Self Service Procurement. |
| ContentZonessecurityAssignments | Controls security access for content zones by requisitioning BU, worker, or deliver-to location, determining who can view specific content. |
| ContentZonessmartFormAssignments | Associates smart forms with a content zone, enabling tailored form-based requests for goods or services. |
| DraftPurchaseOrdersattachments | Manages files attached to draft purchase orders, such as specs or contractual clauses, before finalization. |
| DraftPurchaseOrdersDFF | Captures descriptive flexfields specific to draft purchase orders, accommodating custom procurement data. |
| DraftPurchaseOrdersglobalDFFs | Stores global descriptive flexfields for draft purchase orders, addressing regional or enterprise-wide attributes. |
| DraftPurchaseOrderslines | Details each line item (for example, item ID, quantity, unit price) within a draft purchase order prior to supplier communication. |
| DraftPurchaseOrderslinesattachments | Enables users to attach line-level documents (specifications, drawings) to a draft purchase order. |
| DraftPurchaseOrderslinesDFF | Holds descriptive flexfields for draft purchase order lines, capturing additional user-defined data points. |
| DraftPurchaseOrderslinesschedulesattachments | Stores files tied to draft purchase order schedules, such as shipping instructions or special handling documents. |
| DraftPurchaseOrderslinesschedulesDFF | Provides descriptive flexfields for schedules on a draft purchase order, supporting custom scheduling details. |
| DraftPurchaseOrderslinesschedulesdistributions | Allocates costs of a draft purchase order schedule to accounts or projects, preparing accurate financial coding. |
| DraftPurchaseOrderslinesschedulesglobalDFFs | Houses global descriptive flexfields on draft PO schedules, meeting organizational or geographic compliance needs. |
| DraftPurchaseOrderssummaryAttributes | Summarizes high-level attributes of a draft purchase order, compiling data from all lines for review or analysis. |
| DraftSupplierNegotiationResponses | Tracks supplier draft responses to negotiations (RFI, RFQ, auctions) before final submission, allowing iterative updates. |
| DraftSupplierNegotiationResponsesattachments | Manages documents supporting a draft negotiation response (for example, quotes, clarifications) submitted by a supplier. |
| DraftSupplierNegotiationResponseslines | Captures line-level information in a supplier’s draft response, including price, quantity, and delivery terms. |
| DraftSupplierNegotiationResponseslinesattachments | Stores supporting documents for each line of a supplier’s draft response, such as technical specifications or proposals. |
| DraftSupplierNegotiationResponseslinescostFactors | Tracks additional cost details, such as freight and setup charges, in a supplier’s draft response to a negotiation line. |
| DraftSupplierNegotiationResponseslineslineAttributeGroups | Groups negotiation line attributes (for example, color, model, capacity) in a supplier’s draft response, supporting complex bid details. |
| DraftSupplierNegotiationResponseslineslineAttributeGroupslineAttributes | Lists the individual attributes of a negotiation line within a supplier’s draft response, providing granular specification data. |
| DraftSupplierNegotiationResponseslinespriceBreaks | Defines price variations based on location, volume, or date in a supplier’s draft negotiation response line. |
| DraftSupplierNegotiationResponseslinespriceTiers | Captures tiered pricing details for a supplier’s draft negotiation line, allowing discounted rates at higher order quantities. |
| DraftSupplierNegotiationResponsessections | Groups various sections (for example, commercial, technical) in a supplier's draft negotiation response, organizing requirements and replies. |
| DraftSupplierNegotiationResponsessectionsrequirements | Lists specific requirements or questions within each section, prompting suppliers to provide data or clarifications. |
| DraftSupplierNegotiationResponsessectionsrequirementsattachments | Stores supporting files linked to a draft requirement, such as technical documents or references from the supplier. |
| DraftSupplierNegotiationResponsessectionsrequirementsresponseValues | Holds the supplier's actual responses (text, numeric, date) for each requirement in a draft negotiation response. |
| Finders | Displays search finder names and corresponding attributes for a specific view, helping locate and filter procurement data. |
| FlexFndDffDescriptiveFlexfieldContexts | Retrieves descriptive flexfield contexts for extended data capture, customizing the procurement application's data structures. |
| FlexFndPvsCharacterIdCharacterValues | Exposes character-based values in a value set, letting users manage permissible entries for specific procurement fields. |
| PersonalShoppingLists | Stores user-specific shopping lists containing favorite or frequently purchased items for quick requisition creation. |
| PersonalShoppingListslines | Breaks down a personal shopping list into individual items or services, enabling faster selection during requisitioning. |
| ProcurementAgents | Maintains records of users designated as procurement agents (buyers, supplier managers), defining their responsibilities and privileges. |
| ProcurementApprovedSupplierListEntries | Tracks relationships between suppliers and the items or categories they’re approved to supply, ensuring compliance and vendor checks. |
| ProcurementApprovedSupplierListEntriesDFF | Holds descriptive flexfields tied to approved supplier list entries, allowing additional data capture or custom validations. |
| ProcurementPersonsLOV | Supports lookups of employees or individuals who can create or approve requisitions, ensuring authorized procurement actions. |
| PublicShoppingListLines | Represents items included in a publicly accessible shopping list, shared across multiple users or business units. |
| PublicShoppingLists | Defines public shopping list headers, grouping related items for streamlined requisition or bulk purchasing. |
| PunchoutConnections | Manages URL redirections for punchout catalogs, integrating external supplier catalogs into the procurement flow. |
| PurchaseAgreementImportRequests | Facilitates bulk import of procurement documents (for example, blanket purchase agreements), verifying and loading them into the system. |
| PurchaseAgreementImportRequestsbusinessUnitAccess | Defines which requisitioning business units can leverage an imported purchase agreement, enabling multi-BU procurement sharing. |
| PurchaseAgreementImportRequestslines | Specifies goods or services from the imported agreement, listing line details without delivery schedules or discrete distributions. |
| PurchaseAgreementImportRequestslinesitemAttributes | Captures extended item data, like manufacturer part numbers or supplier URLs, during purchase agreement imports. |
| PurchaseAgreementImportRequestslinespriceBreaks | Handles bulk or location-based pricing discounts in imported agreements, detailing cost variations for different purchase conditions. |
| PurchaseAgreementImportRequestslinestranslationItemAttributes | Records translation-specific item attributes for multilingual or localized agreement data imports. |
| PurchaseAgreementLines | Describes goods or services in a purchase agreement, excluding delivery or fulfillment specifics, to outline negotiated items. |
| PurchaseAgreementLinesitemAttributes | Contains auxiliary item data in a purchase agreement (supplier part number, manufacturer info) to ensure accurate fulfillment. |
| PurchaseAgreementLinespriceBreaks | Displays volume-based or location-based price variations for each agreement line, providing cost details beyond the base unit price. |
| PurchaseAgreements | Holds purchase agreement headers (quantity- or value-based) with negotiated terms, used by subsequent POs or contracts. |
| PurchaseAgreementsbusinessUnitAccess | Specifies which business units can use a purchase agreement, enabling enterprise-wide or localized access to negotiated terms. |
| PurchaseAgreementslines | Defines the line items (goods/services) under a purchase agreement, detailing negotiated prices and quantities. |
| PurchaseAgreementslinesitemAttributes | Carries supplemental item information on a purchase agreement line, such as manufacturer details or supplier item reference. |
| PurchaseAgreementslinespriceBreaks | Captures location- or quantity-based price adjustments for agreement lines, ensuring appropriate pricing for each scenario. |
| PurchaseAgreementsnotificationControls | Configures alerts (for example, expiration, usage threshold) for purchase agreements, notifying stakeholders of key milestones. |
| PurchaseOrders | Represents finalized purchase orders for goods or services from external suppliers, capturing key terms and statuses. |
| PurchaseOrdersattachments | Stores documents (for example, contracts, specifications) linked to a purchase order, enhancing detail for audits or approvals. |
| PurchaseOrderSchedules | Manages delivery schedules within a purchase order, tracking ship-to locations, dates, and associated quantities. |
| PurchaseOrdersDFF | Captures additional descriptive flexfield data at the purchase order header level, allowing custom fields. |
| PurchaseOrdersglobalDFFs | Houses global descriptive flexfields used across purchase orders to accommodate standardized international or enterprise data. |
| PurchaseOrderslines | Lists line-level details within a purchase order, specifying items, quantities, unit prices, and related buying terms. |
| PurchaseOrderslinesattachments | Contains attached documents for individual purchase order lines, such as technical specs or regulatory certifications. |
| PurchaseOrderslinesDFF | Offers descriptive flexfields for purchase order lines, capturing extra information beyond the standard line fields. |
| PurchaseOrderslinesschedules | Defines the planned shipment dates and delivery details for each line item in a purchase order. |
| PurchaseOrderslinesschedulesattachments | Manages attachments for purchase order schedules, such as shipping instructions or agreement references. |
| PurchaseOrderslinesschedulesDFF | Enables descriptive flexfields at the schedule level, supporting specialized shipping or delivery requirements. |
| PurchaseOrderslinesschedulesdistributions | Allocates purchase order schedule costs to particular accounts or projects, ensuring accurate financial tracking. |
| PurchaseOrderslinesschedulesglobalDFFs | Holds global descriptive flexfields for purchase order schedules, enabling consistent enterprise or region-level data. |
| PurchaseOrdersLOV | Provides a quick search interface for existing purchase orders, aiding users in referencing or reusing prior orders. |
| PurchaseRequisitionsattachments | Maintains documents attached to purchase requisitions, such as quotes, justifications, or requirement definitions. |
| PurchaseRequisitionsDFF | Stores descriptive flexfields at the requisition header level, enabling custom data elements beyond standard fields. |
| PurchaseRequisitionslinesattachments | Attaches supporting files to requisition lines, such as product specs or vendor quotes, ensuring clear documentation. |
| PurchaseRequisitionslinesDFF | Provides descriptive flexfields for requisition lines, capturing unique data like internal codes or cost justification details. |
| PurchaseRequisitionslinesdistributions | Splits the requisition line cost across multiple accounts or projects, aiding correct budget and financial reporting. |
| PurchaseRequisitionslinesdistributionsDFF | Enables descriptive flexfields for requisition line distributions, adding specialized data for cost allocations. |
| PurchaseRequisitionslinesdistributionsprojectDFF | Captures project-specific descriptive flexfields for requisition line distributions, linking costs to project tasks or milestones. |
| PurchaseRequisitionslinesinformationTemplates | Associates custom information templates (for example, extra fields or questionnaires) with requisition lines for specialized scenarios. |
| PurchaseRequisitionslinesinformationTemplatesinformationTemplateDFF | Stores descriptive flexfields related to an information template, accommodating extra user-defined attributes for a requisition line. |
| PurchaseRequisitionslinesspecialHandlingDFF | Manages special handling flexfields for unique shipping or handling requirements at the requisition line level. |
| PurchaseRequisitionsspecialHandlingDFF | Enables descriptive flexfields for special handling instructions at the requisition header, ensuring compliance or safety measures. |
| PurchaseRequisitionssummaryAttributes | Aggregates summary-level data on a requisition, consolidating details from all lines for higher-level review or analysis. |
| PurchasingDocumentImportErrors | Lists errors encountered during bulk imports of purchasing documents, such as invalid data or missing references. |
| PurchasingNews | Publishes announcements or updates for procurement teams, covering new policies, system changes, or supplier updates. |
| QuestionnaireResponses | Manages supplier or compliance questionnaire responses, collecting details for audits, qualifications, and due diligence. |
| QuestionnaireResponsesquestionnaireAttachments | Stores attachments linked to questionnaire responses (for example, supporting documents, references), providing additional context for responses. |
| QuestionnaireResponsesquestionnaireResponseSections | Organizes questionnaires into sections, each containing related questions or topics for supplier or compliance evaluations. |
| QuestionnaireResponsesquestionnaireResponseSectionsquestionnaireResponseDetails | Captures individual answers or notes for each question in a questionnaire section, reflecting the respondent’s input. |
| QuestionnaireResponsesquestionnaireResponseSectionsquestionnaireResponseDetailsquestionAttachments | Manages files attached to specific question responses, such as certificates or documentation supporting the respondent’s claims. |
| QuestionnaireResponsesquestionnaireResponseSectionsquestionnaireResponseDetailsquestionnaireResponseValues | Holds the actual data points (for example, text, dates, numeric values) provided in response to each question, enabling detailed analysis. |
| RecentRequisitions | Lists the most recently created or submitted requisitions for a given user, speeding up reorders or reference checks. |
| RequisitionOneTimeLocations | Maintains ad-hoc delivery addresses (for example, temporary job sites) for requisitions, capturing non-standard ship-to details. |
| RequisitionPreferences | Stores user-defined requisition defaults—like favorite charge accounts, default delivery locations, or preference settings. |
| RequisitionPreferencesfavoriteChargeAccounts | Tracks a user’s most commonly used charge accounts, simplifying account selection during requisition line allocation. |
| RequisitionPreferencesprojectDFF | Enables descriptive flexfields for project costing within a user’s requisition preferences, linking requisition data to project tasks. |
| RequisitionPreferencespurchasingNews | Surfaces relevant procurement announcements or updates within a user’s requisitioning context (for example, changes in policy). |
| RequisitionPreferencesrequisitioningOptions | Reflects configured requisitioning BU features, profile options, and active functional opt-ins that shape the user’s requisition interface. |
| RequisitionProcessingRequests | Handles the conversion of approved requisition lines into purchase documents (for example, purchase orders), orchestrating the procurement flow. |
| RequisitionProcessingRequestslines | Specifies which approved requisition lines are to be processed into new or existing purchasing documents. |
| RequisitionProductDetails | Retrieves extended information about a requisition item, including its description, category, and associated services or configurations. |
| RequisitionProductDetailspriceBreaks | Displays tiered or location-based price variations for an item in a requisition, guiding cost-effective purchasing decisions. |
| ShoppingCatalogSmartFormDetails | Represents the smart form configuration for procuring items or services, capturing fields and validation logic for shopper input. |
| ShoppingCatalogSmartFormDetailsagreementRequisitionBUAssignments | Indicates which requisitioning business units are assigned to an agreement specified in a smart form, defining usage scope. |
| ShoppingCatalogSmartFormDetailsattachments | Holds references to files attached to a smart form, such as instructions or supplementary materials for the shopper. |
| ShoppingCatalogSmartFormDetailsinformationTemplateAssignments | Associates information templates (additional fields or questionnaires) with a smart form, ensuring comprehensive data collection. |
| ShoppingLists | Aggregates both personal and public shopping list headers to quickly locate items for requisition creation. |
| ShoppingSearches | Enables keyword or attribute-based item searches within procurement catalogs, streamlining the user’s shopping experience. |
| ShoppingSearchesbrandFilters | Applies brand-specific filters to search results, helping users refine item listings by preferred or authorized brands. |
| ShoppingSearchesresultItems | Holds detailed data for items returned in a shopping search, including item ID, pricing, and availability. |
| ShoppingSearchesresultPunchoutCatalogs | Lists punchout catalog links included in search results, letting users directly access supplier-hosted catalogs. |
| StandardLookupsLOV | Queries the list of valid codes and meanings for standard lookups, ensuring consistent use of reference data. |
| SupplierEligibilities | Designates whether a supplier is allowed to participate in sourcing events, capturing approval statuses or disqualifications. |
| SupplierInitiatives | Tracks the creation and status of supplier initiatives, which manage supplier assessments or qualification projects. |
| SupplierInitiativesattachments | Manages files related to a supplier initiative, such as supporting documents or evidence of compliance. |
| SupplierInitiativesDFF | Provides descriptive flexfields for supplier initiatives, capturing additional contextual or compliance-related data. |
| SupplierInitiativesevaluationTeamMembers | Lists members of the evaluation team assigned to a supplier initiative, detailing their roles and responsibilities in the review process. |
| SupplierInitiativesqualificationAreas | Identifies the qualification areas within an initiative, specifying the criteria against which suppliers are assessed. |
| SupplierInitiativessuppliers | Tracks the suppliers participating in an initiative, providing status updates and scoring information for qualification or selection. |
| SupplierNegotiationResponses | Retrieves supplier-submitted responses to sourcing negotiations (for example, RFI, RFQ), offering visibility into proposed terms and pricing. |
| SupplierNegotiationResponsesattachments | Manages files (for example, statements of work, supporting documents) attached to negotiation responses, ensuring comprehensive bid details. |
| SupplierNegotiationResponseslines | Displays line-level details, such as pricing or lead times, in a supplier’s negotiation response for each item or service. |
| SupplierNegotiationResponseslinesattachments | Holds documents specifically tied to each negotiation response line, such as product specifications or compliance certificates. |
| SupplierNegotiationResponseslinescostFactors | Captures additional line-level cost factors (shipping, setup fees) entered by suppliers, contributing to the final bid amount. |
| SupplierNegotiationResponseslineslineAttributeGroups | Groups relevant attributes (color, dimensions, performance) for a negotiation line in the supplier’s response. |
| SupplierNegotiationResponseslineslineAttributeGroupslineAttributes | Lists each attribute within an attribute group for a negotiation line, enabling detailed supplier-submitted specifications. |
| SupplierNegotiationResponseslinespriceBreaks | Defines tiered or location-based discounts proposed by suppliers, applied to negotiated line pricing. |
| SupplierNegotiationResponseslinespriceTiers | Specifies quantity-based price tiers in a supplier’s response, outlining price changes above certain order thresholds. |
| SupplierNegotiationResponsessections | Structures supplier negotiation requirements into sections (for example, technical, legal), allowing organized input and review. |
| SupplierNegotiationResponsessectionsrequirements | Lists requirement questions or prompts within each negotiation section, requesting supplier input on capabilities or compliance. |
| SupplierNegotiationResponsessectionsrequirementsattachments | Holds supporting files (drawings, certificates) attached to specific negotiation requirements, clarifying supplier responses. |
| SupplierNegotiationResponsessectionsrequirementsresponseValues | Records the supplier's answers or data points for each requirement, supporting thorough analysis of submitted proposals. |
| SupplierNegotiations | Oversees key negotiation details (for example, objectives, timelines, participants) for supplier sourcing events or auctions. |
| SupplierNegotiationsabstracts | Maintains summary or abstract information for the negotiation, providing a concise overview of the event. |
| SupplierNegotiationsabstractsDFF | Houses descriptive flexfields for negotiation abstracts, allowing custom data points at the summary level. |
| SupplierNegotiationsattachments | Holds reference documents (terms, supporting files) at the negotiation header, enriching the negotiation record. |
| SupplierNegotiationscollaborationTeamMembers | Identifies internal team members collaborating on the negotiation, specifying roles (for example, evaluator, observer). |
| SupplierNegotiationsDFF | Employs internal descriptive flexfields at the negotiation header level, adding fields for specialized data capture. |
| SupplierNegotiationslines | Details products and services being sourced in the negotiation, including specifications, baseline pricing, or quantity. |
| SupplierNegotiationslinesattachments | Manages line-level attachments (drawings, product sheets) for negotiation lines, ensuring clarity in requested goods or services. |
| SupplierNegotiationslinescostFactors | Tracks cost factors (transport, warranty, extras) at the negotiation line level, influencing total evaluated cost. |
| SupplierNegotiationslinesDFF | Uses descriptive flexfields for negotiation lines, capturing additional data beyond standard fields. |
| SupplierNegotiationslineslineAttributeGroups | Defines attribute groups for negotiation lines, grouping characteristic sets for more complex products or services. |
| SupplierNegotiationslineslineAttributeGroupslineAttributes | Lists each distinct attribute within a line attribute group, giving evaluators granular insight into supplier bids. |
| SupplierNegotiationslinesnegotiationLineRecommendedSuppliers | Identifies recommended suppliers for a specific negotiation line, guiding targeted invitations or shortlisting. |
| SupplierNegotiationslinespriceBreaks | Stores line-level price break data (volume discounts, date-based pricing) to refine cost evaluations. |
| SupplierNegotiationslinespriceTiers | Holds quantity-based pricing tiers for negotiation lines, capturing cost variations that apply once certain purchase thresholds are reached. |
| SupplierNegotiationsnegotiationActivities | Lists the sourcing activities (for example, approvals, messages, updates) performed within a negotiation’s lifecycle. |
| SupplierNegotiationsnegotiationRecommendedSuppliers | Marks suppliers that are preselected or recommended for a negotiation, streamlining invitations and bid evaluations. |
| SupplierNegotiationsresponseCurrencies | Specifies the currencies accepted for negotiation responses, along with exchange rates to normalize bids against the negotiation currency. |
| SupplierNegotiationsscoringTeams | Defines teams responsible for evaluating or scoring suppliers’ bids, including their assigned negotiation roles. |
| SupplierNegotiationsscoringTeamsscoringTeamMembers | Lists individual members in each scoring team, capturing their roles and responsibilities in the bid evaluation process. |
| SupplierNegotiationssections | Breaks down a negotiation into logical sections (for example, commercial requirements, technical specs, contractual terms). |
| SupplierNegotiationssectionsrequirements | Enables creation of structured negotiation requirements or questions, requesting detailed information from bidding suppliers. |
| SupplierNegotiationssectionsrequirementsacceptableResponseScoreValues | Lists scoring rules or acceptable answers for each requirement, helping evaluators rate supplier responses consistently. |
| SupplierNegotiationssectionsrequirementsattachments | Stores supplementary files associated with specific negotiation requirements, such as reference documents or images. |
| SupplierNegotiationssupplierDFF | Houses descriptive flexfields at the negotiation header for supplier-specific data, capturing additional attributes not in standard fields. |
| SupplierNegotiationssuppliers | Shows suppliers invited or participating in the negotiation, logging their bids, statuses, and communication history. |
| SupplierNegotiationssupplierssupplierLineAccessRestrictions | Implements line-level access restrictions, ensuring certain suppliers only see or bid on designated negotiation lines. |
| SupplierQualificationAreas | Manages qualification areas, like compliance or financial stability, for assessing supplier eligibility and performance. |
| SupplierQualificationAreasattachments | Stores attachments for qualification areas, such as policy files or reference documents supporting the qualification criteria. |
| SupplierQualificationAreasbusinessUnits | Connects qualification areas to specific business units, indicating which organizational segments require those assessments. |
| SupplierQualificationAreasoutcomes | Defines possible results (for example, pass, fail, conditional) for a qualification area, aiding standardized supplier evaluations. |
| SupplierQualificationAreasquestions | Lists questions for a given qualification area, capturing the required data to assess supplier compliance or capability. |
| SupplierQualificationQuestionResponses | Collects the actual answers suppliers provide to qualification questions, forming a record for subsequent review. |
| SupplierQualificationQuestionResponsesvalues | Captures detailed data points (for example, numeric values, text inputs) for each question response, enabling in-depth analysis. |
| SupplierQualificationQuestionResponsesvaluesattachments | Associates supporting documents or certificates with question responses, demonstrating supplier qualifications or compliance. |
| SupplierQualificationQuestions | Defines the questions used in supplier qualification, covering areas like safety standards or financial viability. |
| SupplierQualificationQuestionsacceptableResponses | Lists potential valid answers or response choices for a qualification question, ensuring standardized input options. |
| SupplierQualificationQuestionsacceptableResponsesbranches | Indicates subsequent branching logic for a given response, posing follow-up questions based on the initial answer. |
| SupplierQualificationQuestionsattachments | Holds documents (images, policy PDFs) linked to a question, giving respondents extra context or references. |
| SupplierQualificationQuestionsscores | Applies scoring rules (for example, numeric weighting) to question responses, letting evaluators quantify supplier qualification results. |
| SupplierRegistrationAddressGeographies | Tracks geographic data (country, region) for supplier addresses, enforcing location-based validations during registration. |
| SupplierRegistrationAddressStyleFormats | Defines distinct layouts for addresses in various countries, aligning supplier registration with local postal standards. |
| SupplierRegistrationAddressStyleFormatsAddressStyleFormatLayout | Describes how address components (street, city, postal code) are placed in a given address format layout. |
| SupplierRegistrationBankBranchesLOV | Presents valid bank branch lookups for supplier bank account setup, ensuring precise banking details in registrations. |
| SupplierRegistrationBanksLOV | Lists recognized banks usable in supplier registration flows, allowing accurate banking information and payment routing. |
| SupplierRegistrationCertifyingAgenciesLOV | Lists agencies authorized to certify supplier business classifications (for example, small business, minority-owned), ensuring accurate accreditation data. |
| SupplierRegistrationConfigurations | Enables retrieval of prospective and spend-authorized registration configurations, controlling mandatory fields and setup details for supplier signups. |
| SupplierRegistrationOptions | Defines supplier registration flow options (for example, attachments required, tax ID fields), shaping the onboarding experience and required data. |
| SupplierRegistrationPhoneCountryCodes | Enumerates valid country dialing codes for supplier phone numbers, aligning registration data with international standards. |
| SupplierRegistrationProductsAndServicesLOV | Retrieves categories (for example, office supplies, IT services) used to classify supplier offerings during registration. |
| SupplierRegistrationProductsAndServicesLOVchildCategories | Tracks subcategories under primary product and service classifications, enabling multi-level supplier categorization. |
| SupplierRegistrationQuestionnaireResponses | Handles supplier-provided answers to registration questionnaires, capturing additional information like financial details or compliance data. |
| SupplierRegistrationQuestionnaireResponsesquestionnaireAttachments | Facilitates attachments (for example, supporting documents) to questionnaire responses, adding evidence or documentation during supplier onboarding. |
| SupplierRegistrationQuestionnaireResponsesquestionnaireResponseSections | Organizes questionnaire content into logical sections, grouping related questions for clarity and streamlined completion. |
| SupplierRegistrationQuestionnaireResponsesquestionnaireResponseSectionsquestionnaireResponses | Stores the supplier’s answers to each question in a section, capturing all responses for thorough review. |
| SupplierRegistrationQuestionnaireResponsesquestionnaireResponseSectionsquestionnaireResponsesquestionAttachments | Maintains files attached to specific questions in a supplier’s registration questionnaire, supporting claims or validations. |
| SupplierRegistrationQuestionnaireResponsesquestionnaireResponseSectionsquestionnaireResponsesquestionnaireResponseValues | Details the actual data inputs (for example, numeric, text) for each question, enabling precise analysis of supplier registration responses. |
| SupplierRegistrationRequests | Controls supplier registration requests, whether prospective or spend-authorized, storing essential onboarding data and statuses. |
| SupplierRegistrationRequestsaddresses | Manages address information tied to a supplier registration request, capturing physical location details for the supplier. |
| SupplierRegistrationRequestsaddressesaddressContacts | Tracks contact people (for example, branch manager, local admin) at a specific supplier address, supporting multi-contact setups. |
| SupplierRegistrationRequestsaddressesDFF | Captures descriptive flexfields for address records in supplier registration requests, supporting unique business data needs. |
| SupplierRegistrationRequestsattachments | Holds uploaded files (for example, tax forms, certificates) linked to a supplier registration, improving documentation completeness. |
| SupplierRegistrationRequestsbankAccounts | Stores supplier bank account details during registration, ensuring valid routing information for future payments. |
| SupplierRegistrationRequestsbankAccountsattachments | Allows attachments related to a supplier’s bank account (for example, proof of account ownership, voided checks). |
| SupplierRegistrationRequestsbusinessClassifications | Maintains classification records (for example, minority-owned, small business) for a supplier registration request, aligning with compliance requirements. |
| SupplierRegistrationRequestsbusinessClassificationsattachments | Holds files proving or explaining a supplier’s business classification, ensuring accurate and documented registrations. |
| SupplierRegistrationRequestscontacts | Stores contact information (for example, phone, email) for supplier representatives, forming the basis for communication. |
| SupplierRegistrationRequestscontactsDFF | Enables descriptive flexfields on supplier contact data, allowing extra fields beyond standard attributes. |
| SupplierRegistrationRequestscontactsroles | Tracks user account roles assigned to a supplier contact (for example, primary contact, user administrator), controlling system access. |
| SupplierRegistrationRequestsDFF | Houses descriptive flexfields at the registration request header, supporting additional data not covered by standard fields. |
| SupplierRegistrationRequestsproductsAndServices | Logs the products and services a supplier offers, matching them to internal categories for procurement decisions. |
| SupplierRegistrationRolesLOV | Lists user roles available for assignment during supplier registration, ensuring appropriate access for new supplier users. |
| SuppliersaddressesDFF | Holds custom descriptive flexfields for supplier address records, enabling extended data capture as needed. |
| Suppliersattachments | Provides attachment capabilities for supplier records (for example, contracts, certifications), enhancing reference documentation. |
| SuppliersbusinessClassifications | Specifies recognized business types or certifications (for example, minority-owned) for a supplier, meeting regulatory or diversity goals. |
| SuppliersbusinessClassificationsattachments | Associates proof documents (certificates, letters) with the supplier’s business classification, validating their status. |
| Supplierscontactsaddresses | Links specific addresses to a supplier contact (for example, branch office, headquarters), clarifying shipping or invoice routes. |
| SupplierscontactsDFF | Provides descriptive flexfields for supplier contact details, enabling custom fields beyond standard attributes. |
| SuppliersDFF | Contains descriptive flexfields for supplier data at the header, storing extra organizational or region-specific information. |
| SuppliersglobalDFF | Holds global descriptive flexfields for supplier records, allowing consistent multi-national data capture. |
| SuppliersproductsAndServices | Specifies the goods or services a supplier offers, mapped to relevant categories in the procurement system. |
| Supplierssites | Records supplier site details (for example, operational addresses, payment methods), facilitating transaction-level usage. |
| Supplierssitesassignments | Determines how supplier sites are assigned to internal business units or ledger sets, managing usage boundaries. |
| Supplierssitesattachments | Tracks documents tied to a supplier site, such as compliance documents or service-level agreements. |
| SupplierssitesDFF | Enables custom descriptive flexfields at the supplier site level, supporting additional operational or region-specific data. |
| SupplierssitesglobalDFF | Stores global descriptive flexfields for supplier sites, accommodating enterprise-wide requirements for site metadata. |
| SupplierssitesthirdPartyPaymentRelationships | Manages third-party payment setups (for example, factoring relationships) for supplier sites, ensuring correct pay-to instructions. |
| ValueSets | Stores definitions for standardized lookups or data validation sets, ensuring consistent entries across the procurement module. |
| ValueSetsvalidationTable | Indicates the base table used for validation, defining the permissible values for procurement data fields. |
| ValueSetsValues | Enumerates allowed values in a value set (codes, translations), ensuring data consistency in user inputs. |
| WorkConfirmations | Handles confirmations of completed work for complex service or construction purchase orders, aiding accurate billing and progress tracking. |
| WorkConfirmationsattachments | Associates files (for example, progress photos, sign-off sheets) with a work confirmation, substantiating the claimed progress or deliverables. |
| WorkConfirmationsdocumentActions | Reflects the actions (approve, reject, revise) taken on a work confirmation document, ensuring an audit trail of changes. |
| WorkConfirmationslines | Details line-level entries for a work confirmation, tracking the portions of work completed or amounts to be billed. |
Organizes catalog categories in a hierarchical structure, enabling guided navigation for items or services in procurement.
| Name | Type | Description |
| CategoryId [KEY] | Long | Unique identifier for the category in the CatalogCategoryHierarchyNodes table. This ID is used to reference and manage specific categories in the catalog hierarchy. |
| CategoryName | String | The name of the category within the catalog hierarchy. This value is used to label and identify the category in various views or reports. |
| CategoryImageUrl | String | The URL to the image representing the category. This image is typically displayed in the user interface to visually represent the category in the catalog. |
| ItemCategoryFlag | Bool | A flag indicating whether the category is an item category. This value helps to distinguish between categories that contain items and those that may serve other purposes. |
| CategoryDescription | String | A textual description of the category. This field provides more detailed information about the category and is often used to explain its purpose or contents. |
| FeaturedCategoryFlag | Bool | A flag that identifies whether the category is featured within the catalog. Featured categories are typically given prominence in the user interface to attract attention. |
| ParentCategoryId [KEY] | Long | The unique identifier of the parent category in the catalog hierarchy. This value helps establish the hierarchical relationship between categories, indicating which category is the parent of the current category. |
| ParentCategoryName | String | The name of the parent category in the catalog hierarchy. This field provides context by identifying the higher-level category under which the current category is nested. |
| CreatedBy | String | The user or system that created the category record. This field tracks the origin of the category and is important for auditing and data management. |
| CreationDate | Datetime | The date and time when the category record was created. This timestamp helps track when the category was first introduced into the catalog system. |
| LastUpdatedBy | String | The user or system that last updated the category record. This field is important for tracking changes made to the category and can be used in audits. |
| LastUpdateDate | Datetime | The date and time when the category record was last updated. This timestamp allows users to track when the category was last modified, ensuring data currency. |
| Finder | String | A field used for searching or locating specific category records within the system. It may contain keywords or other criteria to assist in identifying the category quickly. |
| Keyword | String | Keywords associated with the category to help improve searchability. This field is used to store relevant terms that can be used to locate the category in search queries. |
| UserPreferenceId | Long | Unique identifier for the user preference associated with the category. This field links a user's preferences to specific categories, influencing the presentation of the catalog to the user. |
Stores procurement compliance checklist details, supporting evaluations or audits of supplier qualifications and practices.
| Name | Type | Description |
| ChecklistInitiativeId [KEY] | Long | System-generated identifier for the compliance checklist. This identifier is stored as an initiative ID and is used to uniquely reference a specific compliance checklist within the system. |
| Checklist | String | A unique value that identifies the compliance checklist. This field serves as the primary reference for the checklist in the system. |
| Title | String | The title or name given to the compliance checklist. This field helps identify the checklist and provides context for its purpose or subject matter. |
| StatusCode | String | A code representing the status of the compliance checklist. This field is used to track the current state of the checklist, such as whether it is 'Pending', 'In Progress', or 'Completed'. |
| Status | String | Describes the current status of the compliance checklist. This field provides more detailed information about the checklist’s progress or stage in the compliance process. |
| ProcurementBUId | Long | Unique identifier for the procurement business unit where the compliance checklist was created. This value links the checklist to the specific business unit responsible for its creation. |
| ProcurementBU | String | The name of the procurement business unit where the compliance checklist was created. This helps identify which part of the organization is responsible for managing and completing the checklist. |
| ChecklistOwnerId | Long | Unique identifier for the owner of the compliance checklist. This field is used to link the checklist to the individual or group responsible for overseeing its completion. |
| ChecklistOwner | String | The name of the person or entity who owns and is responsible for the compliance checklist. The owner manages the checklist’s creation, updates, and overall progress. |
| ChecklistTemplateId | Long | System-generated identifier for the checklist template used to create the compliance checklist. This links the checklist to the template that defines its structure and content. |
| ChecklistTemplate | String | The name or identifier of the checklist template used to create the compliance checklist. This field helps track which predefined template was selected for the checklist’s structure. |
| ChecklistTemplateRevision | Int | The revision number of the checklist template used. This field helps track changes to the template, ensuring the most up-to-date version is used in the checklist. |
| ReopenDate | Datetime | The date and time when the compliance checklist was reopened. This timestamp is recorded when the checklist is revisited after being closed or completed. |
| ReopenedById | Long | Unique identifier for the user who reopened the compliance checklist. This links the action of reopening the checklist to the specific individual responsible for it. |
| ReopenedBy | String | The name of the user who reopened the compliance checklist. This field provides accountability for who took the action of reopening the checklist. |
| ReopenReason | String | The reason given for reopening the compliance checklist. This helps provide context for why the checklist was revisited or modified after its initial closure. |
| CompletionDate | Datetime | The date and time when the compliance checklist was marked as complete. This timestamp is recorded when all necessary tasks or steps are finished and the checklist is considered finalized. |
| CompletedById | Long | Unique identifier for the user who completed the compliance checklist. This links the completion action to the specific individual responsible for finalizing the checklist. |
| CompletedBy | String | The name of the user who completed the compliance checklist. This field provides accountability for the individual who finished the checklist’s tasks or actions. |
| CancellationDate | Datetime | The date and time when the compliance checklist was canceled. This timestamp is used when the checklist is deemed no longer necessary or valid and is canceled before completion. |
| CanceledById | Long | Unique identifier for the user who canceled the compliance checklist. This links the cancellation action to the specific individual responsible for stopping the checklist. |
| CanceledBy | String | The name of the user who canceled the compliance checklist. This field identifies the individual who took the action of halting the checklist process. |
| CanceledReason | String | The reason provided for the cancellation of the compliance checklist. This field explains why the checklist was canceled, providing context for its removal from active processes. |
| CreationDate | Datetime | The date and time when the compliance checklist was originally created. This timestamp records the creation event and serves as a reference for when the checklist was introduced. |
| POHeaderId | Long | System-generated identifier for the purchasing document associated with the compliance checklist. This field links the checklist to the corresponding purchase order header. |
| PONumber | String | A unique identifier for the purchasing document associated with the compliance checklist. This number is used to track and link the checklist to its corresponding purchase order. |
| POStatus | String | The current status of the purchasing document associated with the compliance checklist. This field reflects the status of the purchase order, such as 'Open', 'Completed', or 'Canceled'. |
| PurchasingDocumentType | String | The type of purchasing document associated with the compliance checklist. This field identifies whether the related document is a purchase order, requisition, or other type of procurement document. |
| Finder | String | A field used for searching or locating specific compliance checklist records within the system. It may contain search criteria or keywords that help users quickly find the relevant checklist. |
| EffectiveDate | Date | This query parameter is used to fetch resources or records that were effective as of the specified start date. It ensures that only valid and relevant data is returned based on the date the query is executed. |
Defines reusable templates for compliance checklists, allowing systematic creation of supplier qualification or audit processes.
| Name | Type | Description |
| ChecklistTemplateId [KEY] | Long | System-generated identifier for the checklist template. This ID is stored as a qualification model ID and uniquely identifies the checklist template within the system. |
| ChecklistTemplate | String | The name given to the checklist template. This field is used to identify the template and provides context for its intended purpose or content. |
| ProcurementBU | String | The procurement business unit where the checklist template was created. This field helps identify which part of the organization is responsible for creating the checklist template. |
| ProcurementBUId | Long | Unique identifier for the procurement business unit where the checklist template was created. This value is used to link the template to the specific business unit within the organization. |
| Revision | Int | The revision number of the checklist template. This field tracks the version history of the template, ensuring that the most recent version is used in compliance processes. |
| Status | String | Describes the current status of the checklist template. Possible values include 'Draft', 'Active', 'Inactive', or 'Archived', indicating the template’s lifecycle stage and availability. |
| StatusCode | String | A code representing the status of the checklist template. This helps categorize the template based on its current state, such as whether it is in development, active, or no longer in use. |
| OriginalChecklistTemplateId | Long | System identifier for the original checklist template. This ID links the current template to its original version, helping track template evolution and changes. |
| ChecklistTemplateDescription | String | A textual description of the checklist template. This field provides more detailed information about the template’s purpose, structure, or intended use. |
| GlobalFlag | Bool | Indicates whether the checklist template is available across all procurement business units. When true, the template can be used by any business unit within the organization. |
| Owner | String | The owner of the checklist template. This field identifies the person or team responsible for maintaining and updating the template. |
| OwnerId | Long | Unique identifier for the person or team who owns the checklist template. This value is used to track the owner of the template and their responsibility for its management. |
| LatestRevisionFlag | Bool | Indicates whether the checklist template is the most recent revision. If true, this version of the template is the latest update available for use. |
| ActivationDate | Datetime | The date and time when the checklist template was activated. This timestamp records when the template was made available for use in the system. |
| HasInactiveOrOutdatedComponentsFlag | Bool | Indicates whether the checklist template contains any inactive or outdated components, such as previous revisions of checklist sections or questions that are no longer relevant. |
| BindProcurementBuId | Long | The identifier used to link the checklist template to a specific procurement business unit. This helps define the business unit responsible for using or maintaining the template. |
| Finder | String | A field used to search or locate specific checklist template records within the system. It may contain keywords or search criteria to assist users in quickly finding the relevant template. |
| EffectiveDate | Date | This query parameter is used to fetch resources that are effective as of the specified start date. It ensures that only records that were valid at or after the given date are returned. |
Manages content zones that determine available catalogs, forms, and lists in Self Service Procurement, controlling visibility and security.
| Name | Type | Description |
| ContentZoneId [KEY] | Long | Unique identifier for the content zone. This value is used to track and reference a specific content zone within the system. |
| ContentZone | String | The name of the content zone. This field helps to identify the zone and provides context about its purpose or area of application within the organization. |
| ProcurementBUId | Long | Unique identifier for the procurement business unit where the content zone is created. This value links the content zone to the specific business unit responsible for it. |
| ProcurementBU | String | The name of the procurement business unit where the content zone is created. This field helps to identify which part of the organization is responsible for the content zone. |
| Description | String | A textual description of the content zone. This field provides more detailed information about the content zone’s purpose, scope, and usage within the organization. |
| UsageCode | String | An abbreviation that identifies the specific function or usage of the content zone. Valid values include 'REQUISITIONING' for requisitioning purposes and 'PROCUREMENT' for procurement-related functions. |
| Usage | String | Describes the function or purpose of the content zone. The values indicate whether the zone is intended for requisitioning or procurement use, helping to clarify its role in the business process. |
| SecuredByCode | String | An abbreviation identifying the security setting for the content zone. It indicates how the content zone is secured, such as by all requisitioning BUs, specific requisitioning BUs, workers, procurement agents, or deliver-to locations. Valid values include 'AVAIL_ALL_REQ_BUS', 'SECURED_BY_BU', 'SECURED_BY_WORKER', 'AVAIL_ALL_WORKERS', and 'SECURED_BY_DEL_LOC'. |
| SecuredBy | String | Describes the security settings for the content zone, detailing who or what is authorized to access or use the zone. It defines the level of access control, such as all requisitioning BUs, specific workers, or certain deliver-to locations. |
| CreationDate | Datetime | The date and time when the content zone was created. This timestamp is used to track when the content zone was introduced into the system. |
| CreatedBy | String | The user who created the content zone. This field provides accountability and helps to track the individual responsible for introducing the zone. |
| LastUpdatedBy | String | The user who most recently updated the content zone. This field is used to track changes and identify who made the last modification. |
| LastUpdatedDate | Datetime | The date and time when the content zone was last updated. This timestamp helps users understand when the most recent changes were made. |
| DeliverToLocationCode | String | A code representing the location to which items or services associated with the content zone are delivered. This field helps define where deliveries are directed within the system. |
| Finder | String | A field used for searching or locating specific content zone records within the system. It can contain search criteria or other parameters to assist users in finding relevant content zone data. |
| RequisitioningBU | String | The business unit responsible for requisitioning within the organization. This field is used to identify the specific business unit involved in requisitioning activities related to the content zone. |
| WorkerEmail | String | The email address of the worker associated with the content zone. This value is used to contact workers who are linked to the zone for tasks or updates. |
| EffectiveDate | Date | A query parameter used to fetch resources that are effective as of the specified start date. It ensures that only valid and active records are retrieved based on the specified date. |
Specifies which local, punchout, or informational catalogs are linked to a given content zone, defining available shopping resources.
| Name | Type | Description |
| ContentZonesContentZoneId [KEY] | Long | Unique identifier for the content zone in the catalog assignment. This ID links the content zone to the catalog assignment, helping to track and manage which content zone the catalog is associated with. |
| CatalogAssignmentId [KEY] | Long | Unique identifier for the catalog assignment. This ID is used to reference a specific assignment of a catalog to a content zone within the system. |
| ContentZoneId | Long | Unique identifier for the content zone associated with the catalog assignment. This value helps establish the relationship between the content zone and the catalog it is assigned to. |
| CatalogId | Long | Unique identifier for the catalog assigned to the content zone. This ID helps track and manage which catalog is linked to the content zone. |
| Catalog | String | The name of the catalog that is assigned to the content zone. This field provides context about the specific catalog linked to the content zone for organizational or operational purposes. |
| CatalogTypeCode | String | An abbreviation that identifies the type of catalog. Valid values include 'LOCAL' for internally managed catalogs, 'PUNCHOUT' for external catalogs accessed via punchout functionality, or 'INFORMATIONAL' for informational catalogs. |
| CatalogType | String | Describes the type of catalog assigned to the content zone. The values indicate whether the catalog is local, punchout (external), or informational, providing clarity on how the catalog is accessed and used. |
| CreationDate | Datetime | The date and time when the catalog assignment was created. This timestamp tracks when the catalog was linked to the content zone for the first time. |
| CreatedBy | String | The user who created the catalog assignment. This field helps identify the person responsible for linking the catalog to the content zone. |
| LastUpdatedBy | String | The user who most recently updated the catalog assignment. This field provides accountability for changes made to the catalog assignment after its creation. |
| LastUpdatedDate | Datetime | The date and time when the catalog assignment was last updated. This timestamp ensures that users can track when the most recent changes to the assignment occurred. |
| ContentZone | String | The name or identifier of the content zone. This value helps identify the specific content zone that the catalog is linked to. |
| DeliverToLocationCode | String | A code representing the location to which the catalog is delivered. This helps define the specific destination or site where the catalog is used in the procurement or requisitioning process. |
| Finder | String | A field used to search or locate specific catalog assignment records within the system. It contains search criteria or parameters to assist users in finding relevant catalog assignments quickly. |
| ProcurementBU | String | The name of the procurement business unit where the catalog assignment is created. This field helps to identify which procurement unit is responsible for managing the catalog within the content zone. |
| RequisitioningBU | String | The name of the requisitioning business unit associated with the catalog assignment. This field is used to identify the requisitioning unit responsible for initiating requests using the assigned catalog. |
| SecuredByCode | String | An abbreviation that identifies how the catalog assignment is secured within the content zone. It specifies whether access is restricted by business unit, worker, or location. Valid values include 'SECURED_BY_BU', 'SECURED_BY_WORKER', and 'SECURED_BY_DEL_LOC'. |
| UsageCode | String | An abbreviation that identifies the usage context of the catalog assignment. This field helps specify how the catalog is used, such as in requisitioning or procurement. Valid values include 'REQUISITIONING' or 'PROCUREMENT'. |
| WorkerEmail | String | The email address of the worker associated with the catalog assignment. This field is used to link workers to specific catalogs, helping to facilitate communication and catalog access. |
| EffectiveDate | Date | This query parameter is used to fetch resources that are effective as of the specified start date. It ensures that only records that are valid as of the given date are returned. |
Assigns public shopping lists to a content zone, allowing employees to access common requisition items in Self Service Procurement.
| Name | Type | Description |
| ContentZonesContentZoneId [KEY] | Long | Unique identifier for the content zone in the public shopping list assignment. This ID links the content zone to the public shopping list assignment, helping to track and manage the relationship. |
| PublicShoppingListAssignmentId [KEY] | Long | Unique identifier for the public shopping list assignment. This ID is used to reference a specific assignment of a public shopping list to a content zone. |
| ContentZoneId | Long | Unique identifier for the content zone associated with the public shopping list assignment. This value helps establish the connection between the content zone and the assigned public shopping list. |
| PublicShoppingListId | Long | Unique identifier for the public shopping list assigned to the content zone. This ID tracks which shopping list is linked to the specific content zone. |
| PublicShoppingList | String | The name of the public shopping list assigned to the content zone. This field provides context about the specific shopping list linked to the content zone. |
| CreationDate | Datetime | The date and time when the public shopping list assignment was created. This timestamp tracks when the public shopping list was linked to the content zone. |
| CreatedBy | String | The user who created the public shopping list assignment. This field identifies the individual responsible for associating the public shopping list with the content zone. |
| LastUpdatedBy | String | The user who most recently updated the public shopping list assignment. This field helps track changes made to the assignment after its creation. |
| LastUpdatedDate | Datetime | The date and time when the public shopping list assignment was last updated. This timestamp ensures that users can track when the most recent changes to the assignment occurred. |
| ContentZone | String | The name or identifier of the content zone. This value helps identify the specific content zone that the public shopping list is linked to. |
| DeliverToLocationCode | String | A code representing the location to which items or services from the public shopping list are delivered. This helps define the specific destination or site for deliveries within the system. |
| Finder | String | A field used for searching or locating specific public shopping list assignment records within the system. It may contain search criteria or keywords to help users find relevant assignments quickly. |
| ProcurementBU | String | The name of the procurement business unit where the public shopping list assignment is created. This field helps identify which procurement unit is responsible for managing the shopping list within the content zone. |
| RequisitioningBU | String | The name of the requisitioning business unit associated with the public shopping list assignment. This field is used to identify the requisitioning unit responsible for initiating requests using the assigned public shopping list. |
| SecuredByCode | String | An abbreviation that identifies how the public shopping list assignment is secured within the content zone. It specifies whether access is restricted by business unit, worker, or location. Valid values include 'SECURED_BY_BU', 'SECURED_BY_WORKER', and 'SECURED_BY_DEL_LOC'. |
| UsageCode | String | An abbreviation that identifies the usage context of the public shopping list assignment. This field helps specify how the shopping list is used, such as in requisitioning or procurement. Valid values include 'REQUISITIONING' or 'PROCUREMENT'. |
| WorkerEmail | String | The email address of the worker associated with the public shopping list assignment. This field links workers to specific shopping lists, helping to facilitate communication and list access. |
| EffectiveDate | Date | This query parameter is used to fetch resources that are effective as of the specified start date. It ensures that only records that were valid at or after the given date are returned. |
Controls security access for content zones by requisitioning BU, worker, or deliver-to location, determining who can view specific content.
| Name | Type | Description |
| ContentZonesContentZoneId [KEY] | Long | Unique identifier for the content zone in the security assignment. This ID links the content zone to the security assignment, helping to track and manage the assignment. |
| ContentZoneSecurityAssignmentId [KEY] | Long | Unique identifier for the security assignment. This ID is used to reference a specific assignment of security settings to a content zone. |
| ContentZoneId | Long | Unique identifier for the content zone associated with the security assignment. This value helps establish the connection between the content zone and the security settings applied to it. |
| RequisitioningBUId | Long | Unique identifier for the requisitioning business unit to which the content zone is assigned. This helps link the content zone to the relevant requisitioning business unit. |
| RequisitioningBU | String | The name of the requisitioning business unit to which the content zone is assigned. This field helps identify which requisitioning unit is responsible for the content zone. |
| WorkerId | Long | Unique identifier for the worker to whom the content zone is assigned. This value links the content zone to a specific worker responsible for it. |
| Worker | String | The name of the worker to whom the content zone is assigned. This field helps identify the specific individual associated with the content zone in the system. |
| WorkerEmail | String | The email address of the worker to whom the content zone is assigned. This value helps facilitate communication with the worker about the content zone. |
| DeliverToLocationId | Long | Unique identifier for the deliver-to location associated with the content zone. This value links the content zone to a specific location where goods or services related to the content zone are delivered. |
| DeliverToLocationCode | String | A code that identifies the deliver-to location for the content zone. This field is used to reference the location in the system. |
| DeliverToLocation | String | The name of the deliver-to location where the content zone is assigned. This field helps identify the specific location involved in the content zone assignment. |
| CreatedBy | String | The user who created the security assignment. This field tracks the individual responsible for assigning the security settings to the content zone. |
| CreationDate | Datetime | The date and time when the security assignment was created. This timestamp records when the content zone’s security settings were first applied. |
| LastUpdatedBy | String | The user who most recently updated the security assignment. This field helps track who made the last changes to the security settings of the content zone. |
| LastUpdateDate | Datetime | The date and time when the security assignment was most recently updated. This timestamp ensures that users can track when the most recent changes occurred. |
| ContentZone | String | The name or identifier of the content zone. This value helps identify the specific content zone being managed in the security assignment. |
| Finder | String | A field used for searching or locating specific security assignment records within the system. It contains search criteria or keywords to assist in quickly finding the relevant assignment. |
| ProcurementBU | String | The name of the procurement business unit associated with the content zone security assignment. This field helps identify the procurement unit responsible for managing the content zone. |
| SecuredByCode | String | An abbreviation identifying how the content zone is secured within the system. It specifies the level of access control, such as by business unit, worker, or location. Valid values include 'SECURED_BY_BU', 'SECURED_BY_WORKER', and 'SECURED_BY_DEL_LOC'. |
| UsageCode | String | An abbreviation that identifies the usage context of the security assignment. This field helps specify how the content zone is used, such as for requisitioning or procurement. Valid values include 'REQUISITIONING' or 'PROCUREMENT'. |
| EffectiveDate | Date | This query parameter is used to fetch resources that are effective as of the specified start date. It ensures that only records that were valid at or after the given date are returned. |
Associates smart forms with a content zone, enabling tailored form-based requests for goods or services.
| Name | Type | Description |
| ContentZonesContentZoneId [KEY] | Long | Unique identifier for the content zone in the smart form assignment. This ID links the content zone to the smart form assignment, allowing for the tracking and management of the content zone's associated smart forms. |
| SmartFormAssignmentId [KEY] | Long | Unique identifier for the smart form assignment. This ID is used to reference a specific assignment of a smart form to a content zone. |
| ContentZoneId | Long | Unique identifier for the content zone associated with the smart form assignment. This value helps establish the relationship between the content zone and the smart form assigned to it. |
| SmartFormId | Long | Unique identifier for the smart form assigned to the content zone. This ID is used to track which smart form is linked to the content zone. |
| SmartForm | String | The name of the smart form assigned to the content zone. This field provides context about the specific smart form linked to the content zone. |
| CreationDate | Datetime | The date and time when the smart form assignment was created. This timestamp tracks when the smart form was first linked to the content zone. |
| CreatedBy | String | The user who created the smart form assignment. This field identifies the individual responsible for associating the smart form with the content zone. |
| LastUpdatedBy | String | The user who most recently updated the smart form assignment. This field helps track who made the last changes to the smart form assignment. |
| LastUpdatedDate | Datetime | The date and time when the smart form assignment was last updated. This timestamp ensures that users can track when the most recent changes to the assignment occurred. |
| ContentZone | String | The name or identifier of the content zone. This field helps identify the specific content zone being managed in the smart form assignment. |
| DeliverToLocationCode | String | A code representing the location to which the smart form or related items are delivered. This helps define the specific destination or site for delivery in the context of the content zone. |
| Finder | String | A field used for searching or locating specific smart form assignment records within the system. It may contain search criteria or keywords to assist in quickly finding the relevant assignment. |
| ProcurementBU | String | The name of the procurement business unit associated with the smart form assignment. This field helps identify the procurement unit responsible for managing the smart form within the content zone. |
| RequisitioningBU | String | The name of the requisitioning business unit associated with the smart form assignment. This field helps identify the requisitioning unit responsible for initiating requests related to the assigned smart form. |
| SecuredByCode | String | An abbreviation identifying how the smart form assignment is secured within the content zone. It specifies whether access is restricted by business unit, worker, or location. Valid values include 'SECURED_BY_BU', 'SECURED_BY_WORKER', and 'SECURED_BY_DEL_LOC'. |
| UsageCode | String | An abbreviation identifying the usage context of the smart form assignment. This field helps specify how the smart form is used, such as in requisitioning or procurement. Valid values include 'REQUISITIONING' or 'PROCUREMENT'. |
| WorkerEmail | String | The email address of the worker associated with the smart form assignment. This value helps facilitate communication with the worker about the smart form and content zone. |
| EffectiveDate | Date | This query parameter is used to fetch resources that are effective as of the specified start date. It ensures that only records that were valid at or after the given date are returned. |
Manages files attached to draft purchase orders, such as specs or contractual clauses, before finalization.
| Name | Type | Description |
| DraftPurchaseOrdersPOHeaderId [KEY] | Long | The unique identifier for the purchase order header in the DraftPurchaseOrders table, used to link attachments to the relevant draft purchase order. |
| AttachedDocumentId [KEY] | Long | A unique identifier for the document that is attached to the purchase order. This value is generated when the user attaches a document to the purchase order. |
| LastUpdateDate | Datetime | The date and time when the attachment record was last updated, helping track the most recent modifications. |
| LastUpdatedBy | String | The user who last updated the attachment record, useful for auditing purposes. |
| DatatypeCode | String | An abbreviation identifying the data type of the attached document, providing clarity on the document's format (for example, PDF, Word). |
| FileName | String | The name of the attached document file, typically including the document's name and file extension. |
| DmFolderPath | String | The folder path where the attached document is stored in the document management system. |
| DmDocumentId | String | A unique identifier for the document in the document management system, linking it to the purchase order attachment. |
| DmVersionNumber | String | The version number assigned to the attached document, used to track document revisions. |
| Url | String | The URI (Uniform Resource Identifier) that locates the attached document, enabling access to the file. |
| CategoryName | String | The category or classification of the attached document, which can help organize and identify the document type (for example, invoice, contract). |
| UserName | String | The login credentials of the user who created the attachment, typically their username within the system. |
| Uri | String | The URI (Uniform Resource Identifier) that identifies the attached document, used for accessing the file or resource. |
| FileUrl | String | The URL (Uniform Resource Locator) that directly links to the attached document, providing a web address for downloading or viewing the document. |
| UploadedText | String | The text content of the attached document, if applicable, providing a preview or extract of the document's contents. |
| UploadedFileContentType | String | The content type of the uploaded file, describing its format. |
| UploadedFileLength | Long | The size of the attached document in bytes, indicating the file's size and helping manage storage limits. |
| UploadedFileName | String | The name of the file as uploaded, which may differ from the document's original name if modified during the upload process. |
| ContentRepositoryFileShared | Bool | A flag indicating whether the attached document is shared with others. If true, the document is shared; if false, it is not. |
| Title | String | The title of the attached document, providing a brief description or heading to summarize the content of the document. |
| Description | String | A detailed description of the attached document, providing additional context about its contents and purpose. |
| ErrorStatusCode | String | An abbreviation identifying any error code related to the document attachment, useful for debugging or error handling. |
| ErrorStatusMessage | String | The error message text, providing further details on any issues encountered during document processing or upload. |
| CreatedBy | String | The user who created the attachment record, helping track who initiated the attachment process. |
| CreationDate | Datetime | The date and time when the attachment record was created, indicating when the document was first associated with the purchase order. |
| FileContents | String | The contents of the attached document, typically in Base64 encoding, used for transferring document data. |
| ExpirationDate | Datetime | The date when the attached document expires or becomes no longer valid, often used for temporary documents. |
| LastUpdatedByUserName | String | The username of the person who last updated the attachment record, providing visibility into who made the most recent changes. |
| CreatedByUserName | String | The username of the person who created the attachment record, useful for audit purposes. |
| AsyncTrackerId | String | An identifier used to track the asynchronous upload process of large files or attachments, helping monitor the status of file uploads. |
| FileWebImage | String | A Base64-encoded image of the attached file, displayed in PNG format if the file is an image and can be rendered visually. |
| DownloadInfo | String | A JSON-formatted string that contains information needed to programmatically retrieve large file attachments, such as download links or metadata. |
| PostProcessingAction | String | The name of the action to be performed after the attachment is uploaded, such as indexing, converting, or notifying the user. |
| Finder | String | The finder used for searching and referencing related attachment records, helping locate attachments associated with purchase orders. |
| Intent | String | The intent or purpose of the attachment, typically describing the role it serves in the procurement process. |
| POHeaderId | Long | The unique identifier for the purchase order header, used to link attachments to the correct purchase order. |
| SysEffectiveDate | String | The system-effective date, which specifies the period during which the attachment is valid or applicable. |
| CUReferenceNumber | Int | A reference number that maps child aggregates to the parent tables, used for linking data between related tables. |
| EffectiveDate | Date | The date used to fetch records that are effective as of a specified start date, typically used for tracking changes over time. |
Captures descriptive flexfields specific to draft purchase orders, accommodating custom procurement data.
| Name | Type | Description |
| DraftPurchaseOrdersPOHeaderId [KEY] | Long | The unique identifier for a draft purchase order header in the DraftPurchaseOrdersDFF table. |
| PoHeaderId [KEY] | Long | A unique identifier for the purchase order, used to associate the details of the order with the corresponding header. |
| ContractType | String | Specifies the type of contract associated with the purchase order in the DraftPurchaseOrdersDFF table. |
| Contractnumber | String | The contract number that corresponds to the purchase order, used for linking to the specific agreement or contract. |
| _FLEX_Context | String | The context name for the descriptive flexfield (DFF) related to purchase order distributions, enabling flexible data capture for the order. |
| Finder | String | A search identifier used to locate specific records in the context of the purchase order data. |
| Intent | String | Describes the intended action or purpose of the transaction, such as creating, updating, or reviewing a purchase order. |
| SysEffectiveDate | String | The system's effective date, indicating when the purchase order record was created or last modified in the system. |
| CUReferenceNumber | Int | An identifier used to link child aggregate records with their corresponding parent tables, ensuring consistency in hierarchical data. |
| EffectiveDate | Date | The date from which the specified resources, such as the purchase order details, are considered effective and valid. |
Stores global descriptive flexfields for draft purchase orders, addressing regional or enterprise-wide attributes.
| Name | Type | Description |
| DraftPurchaseOrdersPOHeaderId [KEY] | Long | The unique identifier for a draft purchase order header in the DraftPurchaseOrdersglobalDFFs table. |
| PoHeaderId [KEY] | Long | A unique identifier for the purchase order header, linking the order details to the specific header record. |
| _FLEX_Context | String | The context for the descriptive flexfield in the DraftPurchaseOrdersglobalDFFs table, which defines the specific context of the data entry. |
| _FLEX_Context_DisplayValue | String | The display value for the descriptive flexfield context, providing a human-readable description of the context. |
| Finder | String | A search identifier that aids in locating specific purchase order records or related data. |
| Intent | String | Indicates the purpose or intended action related to the purchase order, such as creating, reviewing, or updating an order. |
| SysEffectiveDate | String | The system’s effective date, representing when the record in the DraftPurchaseOrdersglobalDFFs table was created or last modified. |
| CUReferenceNumber | Int | An identifier used to connect child aggregate data records with their corresponding parent tables for consistency. |
| EffectiveDate | Date | The effective date of the resource, used to fetch records or resources that are active or valid as of this specific date. |
Details each line item (for example, item ID, quantity, unit price) within a draft purchase order prior to supplier communication.
| Name | Type | Description |
| DraftPurchaseOrdersPOHeaderId [KEY] | Long | The unique identifier for a draft purchase order header in the DraftPurchaseOrderslines table, linking it to the corresponding header record. |
| POLineId [KEY] | Long | The unique identifier for the purchase order line within the DraftPurchaseOrderslines table. |
| LineNumber | Decimal | The line number that identifies the position of the line item within the purchase order. |
| POHeaderId | Long | The identifier linking this line to the corresponding purchase order header. |
| OrderNumber | String | The purchase order number associated with this line item. |
| LineTypeId | Long | The identifier for the type of purchase order line, used to categorize the line item. |
| LineType | String | The type of line item in the purchase order, such as goods or services. |
| ItemId | Long | The identifier for the item associated with this purchase order line. |
| Item | String | The description or name of the item being purchased in this order line. |
| ItemRevision | String | The revision identifier for the item, used to track different versions of the same item. |
| CategoryId | Long | The category identifier that classifies the purchased item or service. |
| CategoryCode | String | The category code that represents the classification of the item or service in the purchase order line. |
| Category | String | The name or description of the category to which the item or service belongs. |
| Description | String | A description of the purchase order line item, providing details about the product or service. |
| Amount | Decimal | The total amount of the purchase order line, usually representing the price before taxes or discounts. |
| Quantity | Decimal | The quantity of items or services being purchased in this line. |
| BasePrice | Decimal | The base price of the item or service before applying any discounts or price adjustments. |
| DiscountType | String | The type of discount applied to the purchase order line, such as percentage or fixed amount. |
| Discount | Decimal | The discount amount applied to the purchase order line, reducing the total price. |
| DiscountReason | String | The reason for applying a discount to the purchase order line. |
| Price | Decimal | The final price of the item or service after applying any discounts or adjustments. |
| UOMCode | String | The unit of measure code that indicates how the item is measured (for example, each, kg, liter). |
| UOM | String | The unit of measure for the item or service being purchased, such as 'each', 'box', or 'kg'. |
| PricingUOMCode | String | The unit of measure code used for pricing, which may differ from the purchase unit of measure. |
| PricingUOM | String | The unit of measure used to define the price of the item, often used for pricing consistency. |
| CurrencyCode | String | The currency code indicating the currency in which the price is specified (for example, USD, EUR). |
| Currency | String | The name of the currency used for the purchase order line (for example, US Dollars, Euros). |
| BaseModelId | Long | The identifier for the base model of the item, typically used for configurable or configurable items. |
| BaseModel | String | The name or description of the base model for the purchased item. |
| BaseModelPrice | Decimal | The price of the base model for the item, before any custom configurations or changes. |
| CancelDate | Date | The date when the purchase order line was canceled, if applicable. |
| CancelFlag | Bool | A flag indicating whether the purchase order line has been canceled (true) or not (false). |
| CancelReason | String | The reason for canceling the purchase order line, providing context for the cancellation. |
| CancelledBy | Long | The identifier for the user or system that canceled the purchase order line. |
| ChangeAcceptedFlag | Bool | A flag indicating whether any changes made to the purchase order line have been accepted. |
| ConfiguredItemFlag | Bool | A flag indicating whether the item in the purchase order line is configurable. |
| ConsignmentLineFlag | Bool | A flag indicating whether the line represents a consignment item, meaning the goods are supplied on a consignment basis. |
| SourceAgreementId | Long | The identifier for the source agreement related to this purchase order line, linking it to an existing contract or agreement. |
| SourceAgreementNumber | String | The number of the source agreement, providing an additional reference for the related contract or agreement. |
| SourceAgreementLineId | Long | The identifier for the specific line within the source agreement that corresponds to this purchase order line. |
| SourceAgreementLine | Decimal | The line number within the source agreement, used for mapping purchase order lines to contract lines. |
| SourceAgreementTypeCode | String | The code representing the type of agreement associated with this purchase order line (for example, standard, blanket). |
| SourceAgreementType | String | The name or description of the agreement type (for example, standard, blanket, framework). |
| SourceAgreementProcurementBUId | Long | The identifier for the procurement business unit associated with the source agreement. |
| SourceAgreementProcurementBU | String | The name of the procurement business unit associated with the source agreement. |
| ResponseLine | Decimal | The response line number that corresponds to this purchase order line, typically used in negotiations or supplier responses. |
| Response | Decimal | The response amount or price, representing the supplier’s reply to the purchase order request. |
| NegotiationId | Long | The identifier for the negotiation session related to this purchase order line, used to track the negotiation process. |
| Negotiation | String | The name or description of the negotiation related to this purchase order line. |
| NegotiationLine | Decimal | The line number within the negotiation document that corresponds to this purchase order line. |
| FundsStatusCode | String | The code indicating the status of funds associated with the purchase order line, such as available or reserved. |
| FundsStatus | String | The name or description of the funds status, showing whether there is sufficient budget for the purchase order line. |
| ManualPriceChangeFlag | Bool | A flag indicating whether the price of the purchase order line was manually adjusted. |
| NegotiatedFlag | Bool | A flag indicating whether the price or terms for the purchase order line were negotiated. |
| NoteToSupplier | String | Any special instructions or notes to the supplier regarding the purchase order line. |
| ReasonForChange | String | The reason for any changes made to the purchase order line, providing context for the update. |
| SupplierConfigurationId | String | The identifier for the supplier configuration associated with this purchase order line. |
| SupplierItem | String | The item identifier or code used by the supplier for the item in the purchase order line. |
| OptionsPrice | Decimal | The price for any optional items or configurations that can be added to the purchase order line. |
| UNNumberCode | String | The UN (United Nations) number code for hazardous materials associated with this purchase order line. |
| UNNumberId | Long | The identifier for the UN number associated with this purchase order line. |
| UNNumber | String | The UN number for hazardous materials, used for regulatory compliance in the shipping and handling of the items. |
| UNNumberDescription | String | A description of the UN number, typically providing more details about the hazardous material. |
| HazardClassCode | String | The code representing the hazard class of the item, used for regulatory and safety purposes. |
| HazardClassId | Long | The identifier for the hazard class associated with this purchase order line. |
| HazardClass | String | The name or description of the hazard class for the item in the purchase order line. |
| WorkOrderProduct | String | The product identifier associated with the work order, linking the purchase order line to the related work order. |
| TaxableFlag | Bool | A flag indicating whether the purchase order line is subject to tax. |
| ReferenceNumber | String | A reference number related to the purchase order line, used for tracking or external references. |
| CancelUnfulfilledDemandFlag | Bool | A flag indicating whether unfulfilled demand should be canceled, often used when items are not available. |
| CreationDate | Datetime | The date and time when the purchase order line was created. |
| CreatedBy | String | The identifier for the user or system that created the purchase order line. |
| LastUpdateDate | Datetime | The date and time when the purchase order line was last updated. |
| LastUpdatedBy | String | The identifier for the user or system that last updated the purchase order line. |
| MaximumRetainageAmount | Decimal | The maximum amount of retainage allowed for this purchase order line, typically used in construction or service contracts. |
| Manufacturer | String | The name of the manufacturer of the item in the purchase order line. |
| ManufacturerPartNumber | String | The part number assigned by the manufacturer for the item in the purchase order line. |
| CreditFlag | Bool | A flag indicating whether the purchase order line is subject to credit terms. |
| schedules | String | Schedules related to the purchase order line, typically used for managing delivery or service milestones. |
| DFF | String | Descriptive flexfield data used for additional custom fields in the purchase order line, typically for capturing specific attributes. |
| specialHandlingDFF | String | Descriptive flexfield data used for special handling instructions or requirements for the purchase order line. |
| Finder | String | A search identifier used for locating specific purchase order lines within the system. |
| Intent | String | The intended action or purpose of the transaction, such as creating, updating, or reviewing a purchase order line. |
| SysEffectiveDate | String | The system’s effective date, indicating when the purchase order line record was created or last modified. |
| CUReferenceNumber | Int | An identifier used to link child aggregate records with their corresponding parent tables for consistency. |
| EffectiveDate | Date | The date from which the specified purchase order line is considered effective and valid. |
Enables users to attach line-level documents (specifications, drawings) to a draft purchase order.
| Name | Type | Description |
| DraftPurchaseOrdersPOHeaderId [KEY] | Long | The unique identifier for a draft purchase order header, linking the attachment to the corresponding purchase order. |
| LinesPOLineId [KEY] | Long | The identifier for the specific line item in the purchase order that this attachment is related to. |
| AttachedDocumentId [KEY] | Long | A unique identifier for the document that is attached to the purchase order. This is a primary key assigned when the document is attached. |
| LastUpdateDate | Datetime | The date and time when the attachment record was last updated in the system. |
| LastUpdatedBy | String | The user who last updated the attachment record, providing an audit trail for changes. |
| DatatypeCode | String | An abbreviation that identifies the type of data associated with the attachment (for example, image, PDF, document). |
| FileName | String | The name of the attached document file, which helps identify the document. |
| DmFolderPath | String | The folder path in the document management system where the attached document is stored. |
| DmDocumentId | String | A unique identifier for the attached document in the document management system. |
| DmVersionNumber | String | The version number of the attached document, allowing tracking of different revisions of the same document. |
| Url | String | The URI (Uniform Resource Identifier) that points to the location of the attached document. |
| CategoryName | String | The category assigned to the attached document, which helps classify the document (for example, contract, invoice, specification). |
| UserName | String | The login credentials of the user who created the attachment record in the system. |
| Uri | String | The URI (Uniform Resource Identifier) that provides a direct link to the attached document. |
| FileUrl | String | The URL (Uniform Resource Locator) that can be used to access and download the attached document. |
| UploadedText | String | The content or text extracted from the attached document, if applicable. |
| UploadedFileContentType | String | The content type of the attached document, indicating its format. |
| UploadedFileLength | Long | The length of the attached document, typically measured in bytes, to indicate file size. |
| UploadedFileName | String | The name of the file as uploaded, which might be different from the original file name if modified during upload. |
| ContentRepositoryFileShared | Bool | Indicates whether the attached document is shared (true) or not shared (false) in the content repository. |
| Title | String | The title of the attached document, providing a brief identifier or description of its content. |
| Description | String | A detailed description of the attached document, outlining its purpose or contents. |
| ErrorStatusCode | String | An error code, if any, that identifies issues encountered during the attachment process. |
| ErrorStatusMessage | String | The error message, if any, that provides more details on the issue encountered with the attachment. |
| CreatedBy | String | The user who created the attachment record, helping to track the origin of the document in the system. |
| CreationDate | Datetime | The date and time when the attachment record was created. |
| FileContents | String | The contents of the attached document, typically stored as text or Base64-encoded data. |
| ExpirationDate | Datetime | The expiration date of the attached document, indicating when the document or its contents should no longer be valid. |
| LastUpdatedByUserName | String | The user name of the person who last updated the attachment record. |
| CreatedByUserName | String | The user name of the person who initially created the attachment record. |
| AsyncTrackerId | String | An identifier used to track the asynchronous upload process of the document, particularly for large files. |
| FileWebImage | String | The Base64 encoded image of the file, typically displayed as a .png image if the source document is a convertible image format. |
| DownloadInfo | String | A JSON-formatted string containing necessary information to retrieve large file attachments programmatically. |
| PostProcessingAction | String | The name of the action that can be performed after the attachment is uploaded, such as processing or validation steps. |
| Finder | String | A search identifier used to locate specific attachment records in the system. |
| Intent | String | Describes the intended action for the attachment, such as creating, updating, or reviewing an attachment. |
| POHeaderId | Long | The purchase order header ID associated with this attachment, linking it to the corresponding purchase order. |
| SysEffectiveDate | String | The system’s effective date, indicating when the attachment record was created or last modified. |
| CUReferenceNumber | Int | An identifier used to link child aggregate records with their corresponding parent tables for consistency. |
| EffectiveDate | Date | The effective date of the attached document, used to determine when it becomes valid or applicable in relation to the purchase order. |
Holds descriptive flexfields for draft purchase order lines, capturing additional user-defined data points.
| Name | Type | Description |
| DraftPurchaseOrdersPOHeaderId [KEY] | Long | The unique identifier for a draft purchase order header, linking it to the corresponding line distribution flexfield. |
| LinesPOLineId [KEY] | Long | The identifier for the specific line item in the purchase order that corresponds to this descriptive flexfield (DFF) record. |
| PoLineId [KEY] | Long | A unique identifier for the purchase order line within the DraftPurchaseOrderslinesDFF table, used to link the line to its associated details. |
| _FLEX_Context | String | The context name for the descriptive flexfield, which defines the specific data context for purchase order distributions. |
| _FLEX_Context_DisplayValue | String | The display value for the descriptive flexfield context, providing a user-friendly name or description of the context for purchase order distributions. |
| Finder | String | A search identifier used to locate specific descriptive flexfield records for purchase order lines. |
| Intent | String | Indicates the purpose or intended action related to the descriptive flexfield, such as creating, reviewing, or updating purchase order line details. |
| POHeaderId | Long | The purchase order header ID, linking the descriptive flexfield data to the corresponding purchase order header record. |
| SysEffectiveDate | String | The system’s effective date, indicating when the descriptive flexfield record for the purchase order line was created or last updated. |
| CUReferenceNumber | Int | An identifier used to link child aggregate records with their corresponding parent tables, ensuring consistency in hierarchical data. |
| EffectiveDate | Date | The date from which the descriptive flexfield data for the purchase order line is considered effective and valid. |
Stores files tied to draft purchase order schedules, such as shipping instructions or special handling documents.
| Name | Type | Description |
| DraftPurchaseOrdersPOHeaderId [KEY] | Long | The unique identifier for a draft purchase order header, linking the attachment to the corresponding purchase order. |
| LinesPOLineId [KEY] | Long | The unique identifier for the specific purchase order line, linking this attachment to the relevant line item. |
| SchedulesLineLocationId [KEY] | Long | The identifier for the location associated with the purchase order line schedule to which the document is attached. |
| AttachedDocumentId [KEY] | Long | A unique identifier for the document that is attached to the purchase order schedule. This value is generated by the system when the document is uploaded. |
| LastUpdateDate | Datetime | The date and time when the attachment record was last updated in the system. |
| LastUpdatedBy | String | The user who last updated the attachment record, providing an audit trail of changes. |
| DatatypeCode | String | An abbreviation that identifies the type of data represented by the attached document, such as image, PDF, or text. |
| FileName | String | The file name of the attached document, which is used to identify and track the document. |
| DmFolderPath | String | The path in the document management system where the attached document is stored. |
| DmDocumentId | String | The unique identifier for the document in the document management system. |
| DmVersionNumber | String | The version number of the attached document, which helps track revisions and updates. |
| Url | String | The URI (Uniform Resource Identifier) that links directly to the location of the attached document. |
| CategoryName | String | The category of the attached document, used to classify the document (for example, contract, invoice, specification). |
| UserName | String | The login credentials of the user who created the attachment, providing traceability. |
| Uri | String | The URI (Uniform Resource Identifier) for the attached document, providing a direct link to access it. |
| FileUrl | String | The URL (Uniform Resource Locator) that provides access to download or view the attached document. |
| UploadedText | String | The text content of the attached document, if applicable, often used for text-based documents. |
| UploadedFileContentType | String | The content type of the uploaded document, describing its format. |
| UploadedFileLength | Long | The size of the uploaded document, typically in bytes, indicating how large the file is. |
| UploadedFileName | String | The name of the file as it was uploaded, which might differ from the original file name. |
| ContentRepositoryFileShared | Bool | Indicates whether the document is shared in the content repository. If true, the document is shared; if false, it is not. |
| Title | String | The title of the attached document, providing a brief descriptor or name for the document. |
| Description | String | A detailed description of the attached document, explaining its contents and purpose. |
| ErrorStatusCode | String | An abbreviation for the error code, if any, that was encountered during the attachment process. |
| ErrorStatusMessage | String | The error message, if any, providing details about issues encountered with the attachment. |
| CreatedBy | String | The user who created the attachment record, helping to track the origin of the attachment. |
| CreationDate | Datetime | The date and time when the attachment record was created. |
| FileContents | String | The contents of the attached document, typically stored as text or Base64-encoded data. |
| ExpirationDate | Datetime | The date when the content in the attached document is no longer valid or accessible. |
| LastUpdatedByUserName | String | The user name of the individual who last updated the attachment record. |
| CreatedByUserName | String | The user name of the individual who created the attachment record. |
| AsyncTrackerId | String | An identifier used to track the progress of asynchronous file uploads. |
| FileWebImage | String | The Base64 encoded image of the document, displayed in .png format if the file is a convertible image. |
| DownloadInfo | String | A JSON-formatted string that contains all necessary information to programmatically retrieve a large file attachment. |
| PostProcessingAction | String | The name of the action that should be performed after the attachment has been uploaded, such as validation or indexing. |
| Finder | String | A search identifier used to locate specific attachment records in the system. |
| Intent | String | Describes the intended purpose of the attachment, such as creating, reviewing, or updating an attachment. |
| POHeaderId | Long | The purchase order header ID that links the attached document to the corresponding purchase order. |
| SysEffectiveDate | String | The system’s effective date, indicating when the attachment record was created or last modified. |
| CUReferenceNumber | Int | An identifier used to map child aggregate records to their corresponding parent tables for data consistency. |
| EffectiveDate | Date | The date from which the attached document is considered effective or valid in relation to the purchase order. |
Provides descriptive flexfields for schedules on a draft purchase order, supporting custom scheduling details.
| Name | Type | Description |
| DraftPurchaseOrdersPOHeaderId [KEY] | Long | The unique identifier for a draft purchase order header, linking it to the corresponding purchase order line schedule in the DraftPurchaseOrderslinesschedulesDFF table. |
| LinesPOLineId [KEY] | Long | The unique identifier for the specific purchase order line, linking this descriptive flexfield data to the relevant purchase order line. |
| SchedulesLineLocationId [KEY] | Long | The identifier for the location associated with the purchase order schedule line, used to track where the schedule is to be fulfilled. |
| LineLocationId [KEY] | Long | The identifier for the purchase order schedule, which links the schedule to the purchase order line. |
| _FLEX_Context | String | The context name for the descriptive flexfield, used to define the specific data context for purchase order distributions, enabling flexible data entry. |
| _FLEX_Context_DisplayValue | String | The display value for the descriptive flexfield context, providing a human-readable name or description of the context for purchase order distributions. |
| Finder | String | A search identifier used to locate specific descriptive flexfield records for purchase order line schedules. |
| Intent | String | Indicates the purpose or intended action related to the descriptive flexfield, such as creating, reviewing, or updating purchase order schedule details. |
| POHeaderId | Long | The purchase order header ID, linking the descriptive flexfield data for the purchase order schedule to the corresponding purchase order header. |
| SysEffectiveDate | String | The system’s effective date, representing when the descriptive flexfield record for the purchase order schedule was created or last updated. |
| CUReferenceNumber | Int | An identifier used to link child aggregate records with their corresponding parent tables, ensuring data consistency in hierarchical structures. |
| EffectiveDate | Date | The effective date of the descriptive flexfield data, indicating when the schedule information becomes valid or active in relation to the purchase order. |
Allocates costs of a draft purchase order schedule to accounts or projects, preparing accurate financial coding.
| Name | Type | Description |
| DraftPurchaseOrdersPOHeaderId [KEY] | Long | The unique identifier for a draft purchase order header, linking it to the corresponding purchase order line schedule distribution. |
| LinesPOLineId [KEY] | Long | The unique identifier for the purchase order line, linking this distribution to the relevant purchase order line item. |
| SchedulesLineLocationId [KEY] | Long | The identifier for the location associated with the purchase order schedule distribution, indicating where the goods or services are delivered. |
| PODistributionId [KEY] | Long | The unique identifier for the purchase order distribution, used to track individual distribution records for the purchase order line schedule. |
| DistributionNumber | Decimal | The number that uniquely identifies a specific distribution within the purchase order schedule, used to track and differentiate distributions. |
| POHeaderId | Long | The unique identifier for the purchase order, linking the distribution to the corresponding purchase order record. |
| OrderNumber | String | The order number associated with the purchase order schedule distribution, helping to track the order across the system. |
| POLineId | Long | The unique identifier for the parent line in the purchase order, used when the schedule is split into multiple distributions. |
| LineNumber | Decimal | The line number within the purchase order schedule distribution, used to identify the specific line item within the distribution. |
| LineLocationId | Long | The identifier for the location associated with the purchase order line schedule distribution. |
| ScheduleNumber | Decimal | The number of the purchase order schedule that this distribution belongs to, identifying which schedule the distribution is part of. |
| Quantity | Decimal | The distribution quantity for the item in the purchase order schedule, indicating how many units are included in this distribution. |
| Amount | Decimal | The amount calculated by multiplying the unit price by the distribution quantity, representing the monetary value of the scheduled distribution. |
| DeliverToLocationId | Long | The unique identifier for the final location that receives the item or service described in the distribution. |
| DeliverToLocationCode | String | The abbreviation or code for the final location where the item will be delivered. |
| DeliverToLocationInternalCode | String | An internal abbreviation or code for identifying the final location where goods will be delivered within the organization. |
| DeliverToLocation | String | The name of the location where the item or service is to be delivered. |
| POChargeAccountId | Long | The identifier for the account that will be charged for the purchase, used when the requisitioning business unit and sold-to legal entity are the same. |
| POChargeAccount | String | The account to charge for the purchase under this distribution, used when the requisitioning and sold-to legal entities are the same. |
| POAccrualAccountId | Long | The identifier for the account that will be charged for receipt accrual. This is used when the requisitioning and sold-to legal entities are the same. |
| POAccrualAccount | String | The account to charge for accruals when goods are received for the purchase order, used when the requisitioning and sold-to legal entities are the same. |
| POVarianceAccountId | Long | The identifier for the account to charge for price differences between the purchase order and the invoice. |
| POVarianceAccount | String | The account used to track price differences between the invoice and the purchase order. |
| DestinationChargeAccountId | Long | The identifier for the account to charge for the cost of the item in the requisitioning business unit. |
| DestinationChargeAccount | String | The account used to charge the cost of the item in the requisitioning business unit. |
| DestinationVarianceAccountId | Long | The identifier for the destination variance account used to handle any discrepancies in item costs. |
| DestinationVarianceAccount | String | The account used to handle any variance in the cost of the item being purchased. |
| RecoverableInclusiveTax | Decimal | The amount of recoverable inclusive tax for the distribution, representing tax that can be reclaimed. |
| RecoverableExclusiveTax | Decimal | The amount of recoverable exclusive tax for the distribution, representing tax that can be reclaimed. |
| NonrecoverableInclusiveTax | Decimal | The amount of nonrecoverable inclusive tax for the distribution, representing tax that cannot be reclaimed. |
| NonrecoverableExclusiveTax | Decimal | The amount of nonrecoverable exclusive tax for the distribution, representing tax that cannot be reclaimed. |
| ConversionRate | Decimal | The rate used to convert the purchase order amount into a different currency. |
| ConversionRateDate | Date | The date to use for determining the conversion rate when converting an amount into another currency, as rates can vary. |
| CurrencyCode | String | The currency code for the purchase order schedule distribution, such as USD for US dollars. |
| Currency | String | The name of the currency used for the purchase order schedule distribution (for example, US Dollars, Euros). |
| UOM | String | The unit of measure (UOM) used for the purchase order schedule distribution, indicating the measurement unit for the quantity. |
| BudgetDate | Date | The date on which the organization consumed the budget for this particular distribution. |
| ChangeAcceptedFlag | Bool | A flag indicating whether the changes made to this distribution have been accepted. |
| ChangeOrderAmountCancelled | Decimal | The amount of the change order that has been canceled, reflecting any reductions in the order. |
| ChangeOrderQuantityCancelled | Decimal | The quantity of the change order that has been canceled, reflecting any reductions in the quantity ordered. |
| DeliverToCustomerContactId | Long | The identifier for the customer contact associated with the delivery location for this distribution. |
| DeliverToCustomerContact | String | The name of the customer contact associated with the delivery of the order. |
| DeliverToCustomerId | Long | The identifier for the customer receiving the goods or services in this distribution. |
| DeliverToCustomer | String | The name of the customer receiving the goods or services in this distribution. |
| DeliverToCustomerLocationId | Long | The identifier for the location at the customer's address where the items or services will be delivered. |
| RequesterId | Long | The unique identifier for the deliver-to person or requester, identifying the person requesting the goods or services. |
| Requester | String | The name of the deliver-to person or requester for this purchase order distribution. |
| DestinationSubinventory | String | The subinventory or storage area where the item should be delivered within the organization’s inventory. |
| FundsStatusCode | String | The code representing the funds status for the purchase order schedule distribution, indicating whether funds are available. |
| FundsStatus | String | The description of the funds status for the purchase order schedule distribution, indicating whether the distribution is funded. |
| ParentDistributionId | Long | The unique identifier for the distribution from which this distribution was created, indicating the hierarchical relationship. |
| ParentDistributionNumber | Decimal | The number for the parent distribution, linking this distribution to the original one. |
| ReasonForChange | String | The reason for any changes made to the distribution, such as price adjustments or quantity changes. |
| RequisitionHeaderId | Long | The requisition header ID that links this distribution to a requisition. |
| Requisition | String | The requisition number associated with this distribution, helping to track the originating requisition. |
| RequisitionLineId | Long | The unique identifier for the requisition line related to this distribution. |
| RequisitionLine | Decimal | The line number in the requisition associated with this distribution. |
| RequisitionDistributionId | Long | The unique identifier for the requisition distribution related to this distribution. |
| RequisitionDistribution | Decimal | The distribution number associated with the requisition, linking the requisition to this distribution. |
| CreationDate | Datetime | The date and time when the distribution record was created. |
| CreatedBy | String | The user who created the distribution record, providing an audit trail for the creation of the distribution. |
| LastUpdateDate | Datetime | The date and time when the distribution record was last updated. |
| LastUpdatedBy | String | The user who last updated the distribution record, providing an audit trail for modifications. |
| UOMCode | String | An abbreviation for the unit of measure (UOM) used in the distribution, indicating how the item quantity is measured. |
| DFF | String | Descriptive flexfield (DFF) data for custom attributes related to the purchase order distribution. |
| projectDFF | String | DFF data for custom project-related attributes associated with the distribution. |
| globalDFFs | String | DFF data for global custom attributes associated with the distribution. |
| Finder | String | A search identifier used to locate specific distribution records within the system. |
| Intent | String | The intended action or purpose related to this distribution record, such as creating, reviewing, or updating a distribution. |
| SysEffectiveDate | String | The system’s effective date, indicating when the distribution record was created or last modified. |
| CUReferenceNumber | Int | An identifier used to link child aggregate records to their corresponding parent tables, ensuring data consistency. |
| EffectiveDate | Date | The effective date for the distribution, marking when the distribution is valid or active. |
Houses global descriptive flexfields on draft PO schedules, meeting organizational or geographic compliance needs.
| Name | Type | Description |
| DraftPurchaseOrdersPOHeaderId [KEY] | Long | The unique identifier for a draft purchase order header, linking it to the corresponding purchase order line schedule in the global descriptive flexfield (DFF). |
| LinesPOLineId [KEY] | Long | The unique identifier for the purchase order line, linking the DFF data to the relevant purchase order line schedule. |
| SchedulesLineLocationId [KEY] | Long | The identifier for the location associated with the purchase order schedule line, used to track where the schedule is to be fulfilled. |
| LineLocationId [KEY] | Long | The identifier for the specific purchase order line schedule, linking the schedule to the relevant line item. |
| _FLEX_Context | String | The context for the DFF data, which defines the specific data context for purchase order distributions in the global scope. |
| _FLEX_Context_DisplayValue | String | The display value for the DFF context, providing a human-readable name or description of the context for the purchase order distribution. |
| Finder | String | A search identifier used to locate specific DFF records for purchase order line schedules within the global context. |
| Intent | String | Describes the intended action or purpose related to the DFF, such as creating, reviewing, or updating purchase order schedule details. |
| POHeaderId | Long | The purchase order header ID that links the DFF data for the purchase order line schedule to the corresponding purchase order header. |
| SysEffectiveDate | String | The system’s effective date, indicating when the DFF record for the purchase order line schedule was created or last updated. |
| CUReferenceNumber | Int | An identifier used to map child aggregate records to their corresponding parent tables, ensuring consistency in hierarchical data. |
| EffectiveDate | Date | The effective date of the DFF data, marking when the schedule information becomes valid or active in relation to the purchase order. |
Summarizes high-level attributes of a draft purchase order, compiling data from all lines for review or analysis.
| Name | Type | Description |
| DraftPurchaseOrdersPOHeaderId [KEY] | Long | The unique identifier for a draft purchase order header, linking the purchase order to its summary attributes. |
| POHeaderId [KEY] | Long | The identifier for the purchase order header, linking the summary attributes to the specific purchase order. |
| DeliverToLocationCode | String | The code for the delivery location where the items or services in the purchase order will be shipped or provided. |
| DeliverToLocationId | Long | The unique identifier for the location where the purchased goods or services are to be delivered. |
| DeliverToSingleLocationFlag | Bool | A flag indicating whether the purchase order is to be delivered to a single location (true) or multiple locations (false). |
| DeliverToCustomerLocationId | Long | The unique identifier for the location at the customer's site where the items or services are to be delivered. |
| ProjectCostingDetailsCode | String | A code that links the purchase order to specific project costing details, aiding in financial tracking and resource allocation. |
| ProjectId | Decimal | The unique identifier for the project associated with the purchase order, allowing linkage to specific project resources or tasks. |
| ProjectNumber | String | The project number associated with the purchase order, providing an easy reference to the project's financial tracking. |
| ProjectName | String | The name of the project tied to the purchase order, offering a descriptive label for the project's scope. |
| RequesterId | String | The unique identifier for the person or department who made the request for the purchase, helping with internal tracking and approval. |
| SameRequesterIdFlag | Bool | A flag indicating whether the same requester ID is used across all lines in the purchase order (true) or if different requesters are involved (false). |
| Requester | String | The name of the person or department requesting the purchase order, useful for approval workflows and accountability. |
| RequestedDeliveryDate | Date | The date requested by the requester for the delivery of items or services associated with the purchase order. |
| SameRequestedDeliveryDateFlag | Bool | A flag indicating whether the same requested delivery date applies to all lines in the purchase order (true) or if there are multiple dates (false). |
| TaskNumber | String | The number assigned to the task associated with the purchase order, helping to link the order to specific activities or objectives. |
| TaskName | String | The name or description of the task associated with the purchase order, providing context for the purpose of the purchase. |
| ProjectsInformationAcrossLines | String | Information relevant to the project across all lines in the purchase order, used for project-wide tracking and reporting. |
| POChargeAccountId | Long | The unique identifier for the account that will be charged for the purchase order, relevant for cost allocation and financial tracking. |
| ChargeToSingleAccountFlag | Bool | A flag indicating whether all charges for the purchase order should be applied to a single account (true) or distributed across multiple accounts (false). |
| POChargeAccount | String | The account to be charged for the purchase, typically associated with the requisitioning business unit and project. |
| Ordered | Decimal | The total ordered quantity or value for the purchase order, representing the amount requested for the goods or services. |
| TotalTax | Decimal | The total tax amount applied to the purchase order, calculated based on applicable tax rates for the items or services ordered. |
| Total | Decimal | The total value of the purchase order, including both the cost of the goods/services and any applicable taxes or fees. |
| TaskId | Decimal | The unique identifier for the task associated with the purchase order, linking the purchase to a specific activity or milestone in the project. |
| DeliverToCustomerLocationAddress | String | The address for the customer location where the purchased items or services are to be delivered. |
| ChartOfAccountId | Decimal | The unique identifier for the chart of accounts that corresponds to the purchase order, used for financial reporting and classification. |
| Finder | String | A search identifier used to locate specific purchase order records within the system. |
| Intent | String | Describes the intended action or purpose for the purchase order, such as creating, updating, or reviewing. |
| SysEffectiveDate | String | The system’s effective date, marking when the purchase order record was created or last updated in the system. |
| CUReferenceNumber | Int | An identifier used to link child aggregate records with their corresponding parent tables, ensuring data consistency in hierarchical structures. |
| EffectiveDate | Date | The date on which the purchase order becomes effective, indicating when the order and its attributes are valid. |
Tracks supplier draft responses to negotiations (RFI, RFQ, auctions) before final submission, allowing iterative updates.
| Name | Type | Description |
| ResponseNumber [KEY] | Long | The unique identifier for the supplier's response, used to differentiate and reference individual responses in the negotiation. |
| ResponseDisplayName | String | A descriptive label for the response, such as 'Bid', 'Quote', or 'Response', providing context for the response's purpose. |
| ResponseIntent | String | Indicates whether the supplier's intent is to revise or copy an existing response. Accepted values are 'Copy' (to copy the existing response), 'Revise' (to update an existing response), and 'Null' (no change to the original response). |
| ResponseStatus | String | The current status of the response, such as 'Submitted', 'Under Review', or 'Closed', indicating the stage of the negotiation process. |
| PreviousResponseNumber | Long | The identifier for the previous response, used to default values from the earlier response into the current one, ensuring consistency in revisions. |
| OriginalResponseNumber | Long | The identifier for the original response in a series of revised bids, tracking the first submission in the sequence. |
| AuctionHeaderId | Long | The unique identifier for each negotiation, linking the response to a specific auction or negotiation event. |
| NegotiationTitle | String | The title given to the negotiation, defined by the category manager to summarize the purpose or scope of the negotiation. |
| Negotiation | String | The unique number that identifies the negotiation, allowing for tracking and referencing the negotiation across systems. |
| CloseDate | Datetime | The date when the negotiation stops accepting responses from suppliers, indicating the final deadline for submitting offers. |
| TimeRemaining | String | The remaining time until the negotiation is closed, typically displayed in days, hours, or minutes. |
| BuyerId | Long | The unique identifier for the user who created the negotiation, helping to link the negotiation to the buyer responsible for it. |
| Buyer | String | The name of the user who initiated the negotiation, providing accountability for the negotiation process. |
| BuyerEmail | String | The email address of the buyer who created the negotiation, used for communication and updates. |
| CompanyId | Long | The unique identifier for the buyer's company, linking the negotiation to the company responsible for it. |
| Company | String | The name of the company associated with the buyer, providing context for which organization is conducting the negotiation. |
| SupplierId | Long | The unique identifier for the supplier responding to the negotiation, helping to track which supplier provided the response. |
| Supplier | String | The name of the supplier who submitted the response to the negotiation, indicating the entity involved. |
| SupplierSiteId | Long | The identifier for the supplier site, allowing for differentiation between multiple locations of the same supplier. |
| SupplierSite | String | The name of the supplier site where the response originated, indicating the physical location of the supplier. |
| SupplierContactId | Long | The identifier for the supplier contact associated with the response, helping to track who from the supplier’s organization is responsible for the response. |
| SupplierContact | String | The name of the supplier contact who responded to the negotiation, used for follow-up communication. |
| TwoStageEvaluationFlag | Bool | Indicates whether a two-stage evaluation process is enabled for the negotiation. If true, it allows for both technical and commercial evaluation; if false, it is not enabled. |
| NegotiationDisplayName | String | A display name for the type of supplier negotiation, such as 'Solicitation' or 'Request for Proposals', providing a clear description of the negotiation type. |
| NegotiationCurrencyCode | String | The abbreviation of the currency used in the negotiation, such as 'USD' for US Dollars or 'EUR' for Euros. |
| NegotiationCurrency | String | The name of the currency used in the negotiation, for example, US Dollars or Euros. |
| ResponseAmount | Decimal | The total amount for all line items that the supplier offered prices for in their response, reflecting the total cost of their offer. |
| ResponseCurrencyCode | String | The abbreviation for the currency used in the supplier's response, indicating the currency in which the offer is made. |
| ResponseCurrency | String | The name of the currency used in the supplier’s response, such as US Dollars or Euros. |
| ResponseCurrencyPricePrecision | Decimal | The number of decimal places used for pricing in the response currency, specifying the precision of the supplier’s price. |
| ResponseValidUntilDate | Datetime | The date on which the supplier’s response expires, indicating the deadline for accepting the offer. |
| ResponseTypeCode | String | The abbreviation identifying the response type, such as primary or alternate. The list of valid values is available in the lookup table 'TYPE_OF_RESPONSE'. |
| ResponseType | String | The type of response submitted by the supplier, such as primary or alternate, defining whether the offer is the main or an alternative bid. |
| ReferenceNumber | String | An identification number used for the supplier's internal tracking of the response, helping the supplier reference the response internally. |
| NoteToBuyer | String | A message from the supplier to the buyer, typically containing additional context or clarifications regarding the response. |
| EvaluationStage | String | Indicates whether the response is part of the technical or commercial evaluation in a two-stage negotiation process. |
| PriceDecrement | Decimal | The minimum reduction in bid price required for a revised bid, ensuring that revised offers are lower than the original. |
| ProxyBidFlag | Bool | Indicates whether a proxy bid is allowed. If true, the system can automatically place bids on behalf of the supplier; if false, proxy bidding is not allowed. |
| ProxyDecrementType | String | The method by which the response price is reduced during the submission of a proxy bid, either by a flat amount or a percentage. |
| ProxyDecrementAmount | Decimal | The amount by which the response price is reduced during a proxy bid submission, based on the specified decrement type. |
| PartialResponseFlag | Bool | Indicates whether the supplier has submitted a partial response, meaning they did not bid on all lines or offered less than the requested quantity. |
| SurrogateResponseEnteredById | Long | The identifier for the buyer who created the surrogate response on behalf of the supplier, typically in situations where the supplier is unable to respond directly. |
| SurrogateResponseReceivedOn | Datetime | The timestamp when the buyer received the surrogate response from the supplier, such as via email or fax. |
| SurrogateResponseEntryDate | Datetime | The timestamp when the buyer entered the surrogate response into the system, representing when the response was formally recorded. |
| SurrogateResponseFlag | Bool | Indicates whether the buyer has entered a surrogate response on behalf of the supplier. If true, the response was entered by the buyer; if false, the supplier entered the response. |
| SurrogDraftLockPersonId | Long | The identifier for the buyer who locked the draft surrogate response for editing, preventing further changes until unlocked. |
| SurrogateDraftLockPerson | String | The name of the buyer who locked the draft surrogate response for editing, ensuring only authorized personnel can make changes. |
| SurrogDraftUnlockPersonId | Long | The identifier for the buyer who unlocked the draft surrogate response for editing, allowing further modifications. |
| SurrogateDraftUnlockPerson | String | The name of the buyer who unlocked the draft surrogate response for editing, enabling continued editing or final submission. |
| MethodOfResponseCode | String | An abbreviation that identifies the method by which the supplier submits the response, such as 'Fax', 'Email', or 'Online'. |
| MethodOfResponse | String | Specifies how the supplier submitted their response, with values like fax, email, or through an online portal. |
| DraftLocked | String | Indicates whether the draft response is locked for editing. If true, the response is locked; if false, the draft is unlocked for edits. |
| DraftLockedById | Long | The identifier for the supplier who locked the response draft, preventing further edits. |
| DraftLockedBy | String | The name of the supplier who locked the response draft, indicating who is responsible for the draft's final version. |
| DraftLockedByContactId | Long | The identifier for the supplier contact who locked the draft response, providing more specific details on who in the supplier organization is responsible. |
| DraftLockedByContact | String | The name of the supplier contact who locked the draft response, helping identify the point of contact for the response. |
| DraftLockedDate | Datetime | The date and time when the draft response was locked for editing, indicating when no further changes can be made. |
| DraftUnlockedById | Long | The identifier for the supplier who unlocked the previous draft response, allowing further edits. |
| DraftUnlockedBy | String | The name of the supplier who unlocked the previous draft response, indicating who authorized the edit. |
| DraftUnlockedByContactId | Long | The identifier for the supplier contact who unlocked the draft response, providing more details on who approved the unlocking. |
| DraftUnlockedByContact | String | The name of the supplier contact who unlocked the previous draft response, indicating the responsible person. |
| DraftUnlockedDate | Datetime | The date and time when the draft response was unlocked for editing, allowing modifications to be made before final submission. |
| CreatedBy | String | The user who created the row, providing accountability for data entry. |
| CreationDate | Datetime | The timestamp of when the row was created in the system, helping with audit tracking. |
| LastUpdateDate | Datetime | The timestamp of the last update to the row, used for tracking changes. |
| LastUpdatedBy | String | The user who last updated the row, providing accountability for changes made after the initial creation. |
| BidVisibilityCode | String | The abbreviation that specifies when the supplier can view competing response details. Values include 'Open', 'Sealed', or 'Blind', with accepted values defined in the lookup table. |
| ContractType | String | The type of contract associated with the negotiation, indicating whether it’s short-term or long-term. |
| DisplayBestPriceBlindFlag | Bool | Indicates whether the best price in blind negotiations can be displayed to suppliers. If true, the best price is visible; if false, it’s hidden. |
| RequirementInstructionText | String | Instructions for the supplier on how to respond to the requirements in the negotiation, helping ensure that the response aligns with expectations. |
| LinesInstructionText | String | Instructions for the supplier on how to respond to specific negotiation lines, providing additional guidance on the line items. |
| BuyerTransportFlag | Bool | Indicates whether the buying company is responsible for arranging transportation. If true, the buyer is responsible; if false, the supplier arranges transportation. |
| NegotiationType | String | The type of negotiation document, such as 'RFQ', 'RFI', or 'Auction', indicating the nature of the procurement process. |
| Finder | String | A search identifier used to locate specific supplier negotiation responses in the system. |
| EffectiveDate | Date | The date from which the negotiation response is considered effective, marking when it becomes valid for review or processing. |
Manages documents supporting a draft negotiation response (for example, quotes, clarifications) submitted by a supplier.
| Name | Type | Description |
| DraftSupplierNegotiationResponsesResponseNumber [KEY] | Long | The unique identifier for the negotiation response to which this attachment is related, allowing the attachment to be linked to the specific response. |
| AttachedDocumentId [KEY] | Long | The unique identifier for the attached document. This value is generated by the system when the document is uploaded and serves as a primary key. |
| LastUpdateDate | Datetime | The date and time when the attachment was last updated by the user, providing a record of the most recent changes. |
| LastUpdatedBy | String | The user who last updated the attachment, providing accountability for changes made to the attachment record. |
| DatatypeCode | String | An abbreviation that identifies the type of attachment data. Possible values include 'FILE', 'FOLDER', 'TEXT', or 'WEB_PAGE', representing different formats of attachments. |
| FileName | String | The name of the attached file, typically used to identify and reference the document. |
| DmFolderPath | String | The folder path where the attached document is stored in the document management system, providing the location of the file. |
| DmDocumentId | String | The unique identifier for the attached document within the document management system, allowing for its retrieval and management. |
| DmVersionNumber | String | The version number of the attached document, enabling version control and tracking changes to the document over time. |
| Url | String | The URI (Uniform Resource Identifier) that directly points to the location of the attachment, allowing users to access the document. |
| CategoryName | String | The category assigned to the attachment, used for classification. For example, 'From Supplier' for RFQs, or 'From Supplier: Technical' for technical evaluations. |
| UserName | String | The sign-in details (user login) used by the person who added or modified the attachment, providing identification of the responsible user. |
| Uri | String | The URI (Uniform Resource Identifier) that identifies the attachment, providing a reference for accessing the document. |
| FileUrl | String | The URL (Uniform Resource Locator) that provides direct access to download or view the attachment. |
| UploadedText | String | The text content of the attachment, which may be extracted if the attachment is a text-based document. |
| UploadedFileContentType | String | The content type of the attachment, indicating its format. |
| UploadedFileLength | Long | The size of the attached file, typically in bytes, indicating the file's size for storage and processing purposes. |
| UploadedFileName | String | The name of the file as it was uploaded, which may be different from the original file name if modified during upload. |
| ContentRepositoryFileShared | Bool | A flag indicating whether the attachment is shared (true) or not shared (false) in the content repository. By default, attachments are not shared. |
| Title | String | The title given to the attachment, providing a brief description or name for easy identification. |
| Description | String | A detailed description of the attachment, providing more context on its contents and purpose within the negotiation. |
| ErrorStatusCode | String | An error code identifying any issues encountered during the attachment process, allowing for quick identification of problems. |
| ErrorStatusMessage | String | The error message associated with any issues encountered during the attachment process, providing details about the problem. |
| CreatedBy | String | The user who created the attachment record, helping to track who initially uploaded the document. |
| CreationDate | Datetime | The date and time when the attachment record was created, helping to establish a timeline for the document. |
| FileContents | String | The content of the attachment, typically stored as text or Base64-encoded data, allowing for inspection or processing of the document's contents. |
| ExpirationDate | Datetime | The date when the attachment expires, indicating when the document is no longer considered valid or accessible. |
| LastUpdatedByUserName | String | The login details of the user who last updated the attachment, providing transparency on who made the last modification. |
| CreatedByUserName | String | The user name of the person who originally created the attachment, offering insight into who was responsible for uploading it. |
| AsyncTrackerId | String | An identifier used to track the status and progress of asynchronous file uploads, useful for large file handling. |
| FileWebImage | String | A Base64-encoded image of the attachment, displayed in .png format, particularly useful when the file source is an image that can be converted for viewing. |
| DownloadInfo | String | A JSON-formatted string containing information needed to programmatically retrieve large file attachments, useful for automated systems or integrations. |
| PostProcessingAction | String | The name of the action to be performed after the attachment is uploaded, such as validating the document or indexing it for future searches. |
| Finder | String | A search identifier used to locate specific attachments related to the supplier's response. |
| ResponseNumber | Long | The unique identifier for the supplier's response, linking the attachment to the correct response in the negotiation process. |
| EffectiveDate | Date | The date from which the attachment is considered effective, indicating when it is valid for use or review in the negotiation. |
Captures line-level information in a supplier’s draft response, including price, quantity, and delivery terms.
| Name | Type | Description |
| DraftSupplierNegotiationResponsesResponseNumber [KEY] | Long | The unique identifier for the negotiation response, linking the response to a specific negotiation line. |
| ResponseNumber [KEY] | Long | The identifier for the supplier's response, linking it to the original negotiation response. |
| AuctionHeaderId | Long | The unique identifier for the auction associated with the negotiation, allowing for tracking of responses in the auction context. |
| LineId [KEY] | Long | The identifier for the specific negotiation line within the response, allowing for detailed tracking of individual items or services in the negotiation. |
| Line | String | The line number that identifies a specific item or service within the negotiation response, helping to differentiate between multiple lines in the negotiation. |
| ParentLine | Decimal | The identifier for the parent line, used when the response is part of a hierarchical structure of negotiation lines. |
| LineTypeId | Long | The identifier for the line type, indicating whether the negotiation line is for goods (items) or services. |
| LineType | String | The name of the negotiation line type, indicating whether the line is for goods (for example, 'Fixed Price') or services (for example, 'Quantity'). |
| GroupTypeCode | String | An identifier for the type of negotiation line, indicating whether it’s a standard line, group, group line, lot, or lot line. Values are defined in the 'PON_GROUP_TYPE' lookup. |
| GroupType | String | The type of negotiation line, specifying whether it’s a standard line, a grouped line, or part of a larger lot. Values are defined in the 'PON_GROUP_TYPE' lookup. |
| ItemId | Long | The unique identifier for the inventory item associated with the negotiation line, helping to link the response to specific products. |
| Item | String | The name of the inventory item offered in the negotiation line, providing a description of the goods or services being bid on. |
| ItemRevision | String | The revision number of the inventory item in the negotiation line, helping to track changes or updates to the item. |
| LineDescription | String | A description of the line item, providing additional details about the goods or services being offered in the negotiation. |
| AlternateLineNumber | Decimal | An alternate line number offered by the supplier in response to a negotiation line, providing an alternative option for the buyer. |
| AlternateLineDescription | String | A description of the alternate line item offered by the supplier, detailing the alternative product or service provided. |
| SupplierId | Long | The unique identifier for the supplier responding to the negotiation, helping to track which supplier provided the offer. |
| Supplier | String | The name of the supplier submitting the response to the negotiation, identifying the supplier entity involved. |
| CategoryId | Long | The identifier for the purchasing category associated with the negotiation line, helping to categorize the goods or services being negotiated. |
| CategoryName | String | The name of the purchasing category for the negotiation line, providing context for the type of goods or services being offered. |
| StartPrice | Decimal | The highest price the buyer is willing to accept for the item in the negotiation line, setting an upper limit for the supplier's offer. |
| TargetPrice | Decimal | The price the procurement organization aims to achieve in the negotiation, representing the preferred cost for the negotiation line. |
| ResponsePrice | Decimal | The price quoted by the supplier for the negotiation line, indicating the amount the supplier is offering for the item or service. |
| BestResponsePrice | Decimal | The best price quoted for the line item across all supplier responses, representing the lowest price offered. |
| BestResponseScore | Decimal | The highest score achieved based on multiattribute scoring, indicating the best response among suppliers based on multiple evaluation criteria. |
| LineAttributeScore | Decimal | The total weighted score for the supplier’s response, calculated based on predefined attributes such as price, quality, or delivery time. |
| ProxyDecrement | Decimal | The minimum price reduction set by the supplier, below which the price will not be automatically reduced during proxy bidding. |
| ProxyMinimum | Decimal | The minimum price threshold set by the supplier, under which the system will not reduce the response price automatically in a proxy bid. |
| TargetQuantity | Decimal | The quantity proposed by the procurement organization for the negotiation line, indicating how much of the item is required. |
| ResponseQuantity | Decimal | The quantity proposed by the supplier for the negotiation line, indicating how much of the item the supplier is offering. |
| ResponseEstimatedQuantity | Decimal | The estimated quantity for the negotiation line, typically used in long-term or blanket agreements to estimate future requirements. |
| UOMCode | String | The unit of measure code for the negotiation line, specifying the measurement unit used for the item (for example, 'EA' for each, 'KG' for kilogram). |
| UOM | String | The name of the unit of measure for the item in the negotiation, providing clarity on how the item is measured. |
| LineCloseDate | Datetime | The date and time when the negotiation line closes, marking the final moment when bids can be submitted for that specific line. |
| LineTargetPrice | Decimal | The target price the buyer wants to achieve for the negotiation line, helping to guide supplier offers within an acceptable range. |
| LinePrice | Decimal | The price of the negotiation line item that will be used on the purchasing document, typically displayed in the negotiation's transactional currency. |
| LineAmount | Decimal | The total amount for the line, calculated as the price multiplied by the quantity, representing the total cost for that line item. |
| PricingBasisCode | String | An abbreviation for the pricing basis, which identifies how the price is calculated for the negotiation line, with values defined in the 'PON_PRICING_BASIS' lookup. |
| PricingBasis | String | The basis used to calculate the price for the negotiation line, such as 'Fixed Price' or 'Per Unit', defined in the 'PON_PRICING_BASIS' lookup. |
| TargetMinimumReleaseAmount | Decimal | The minimum amount the buyer wants to receive in response to the negotiation line, typically used in agreements that involve multiple releases or deliveries. |
| ResponseMinimumReleaseAmount | Decimal | The minimum release amount the supplier quotes in response to the negotiation line, indicating the lowest price acceptable for releasing the contract. |
| EstimatedTotalAmount | Decimal | The estimated total cost for a fixed price negotiation line, calculated based on the price and the estimated quantity of the items. |
| ShipToLocationId | Long | The unique identifier for the location to which the line item is to be shipped, ensuring correct delivery of goods. |
| ShipToLocation | String | The name of the location to which the line item should be shipped, helping to identify the destination for the goods. |
| RequestedDeliveryDate | Date | The date by which the buyer requests the supplier to deliver the goods or services associated with the negotiation line. |
| RequestedShipDate | Date | The date by which the supplier is requested to ship the goods associated with the negotiation line. |
| PromisedDeliveryDate | Date | The date on which the supplier promises to deliver the goods or services associated with the negotiation line. |
| PromisedShipDate | Date | The date on which the supplier promises to ship the goods, specified if Buyer Managed transportation is enabled in the negotiation terms. |
| NoteToBuyer | String | A note entered by the supplier for the buyer when responding to the negotiation, often used to clarify or provide additional context for the offer. |
| NoteToSupplier | String | A note entered by the buyer for the supplier when responding to the negotiation, often used to provide further instructions or clarification. |
| SuppliersCanModifyPriceBreaksFlag | Bool | A flag indicating whether price breaks can be modified by the supplier in their response. If true, the supplier can modify price breaks; if false, they cannot. |
| PriceBreakTypeCode | String | An abbreviation that identifies the type of price break offered by the supplier, with accepted values such as 'CUMULATIVE' or 'NONCUMULATIVE'. |
| PriceBreakType | String | The type of price break, indicating whether the price break applies to a single purchase order or all purchase orders for the agreement. |
| CreatedBy | String | The user who created the negotiation line, providing accountability for the creation of the item. |
| CreationDate | Datetime | The date and time when the negotiation line was created, helping to track when the item was first added to the negotiation. |
| LastUpdatedBy | String | The user who last updated the negotiation line, helping to track modifications to the item. |
| LastUpdateDate | Datetime | The date and time when the negotiation line was last updated, providing a timestamp for the most recent changes. |
| OrderTypeLookupCode | String | An abbreviation for the line type in the negotiation, such as 'QUANTITY' or 'FIXED PRICE', specifying how the price is determined. |
| IsResponseQuantityEditableFlag | Bool | A flag indicating whether the supplier can modify the response quantity. If true, the supplier can edit the quantity; if false, it cannot be changed. |
| PriceDisabledFlag | Bool | A flag indicating whether the price can be modified by the supplier in blind negotiations. If true, the price is locked and cannot be altered. |
| LineFilteringNumber | Long | The identifier for the negotiation line used in filtering responses, helping to manage and sort items in the negotiation. |
| Finder | String | A search identifier used to locate specific negotiation lines within the system. |
| EffectiveDate | Date | The effective date of the negotiation line, indicating when the terms of the line become applicable and valid. |
Stores supporting documents for each line of a supplier’s draft response, such as technical specifications or proposals.
| Name | Type | Description |
| DraftSupplierNegotiationResponsesResponseNumber [KEY] | Long | The unique identifier for the negotiation response, linking the attachment to a specific response within the negotiation. |
| LinesLineId [KEY] | Long | The unique identifier for the negotiation response line, allowing the attachment to be linked to a specific line within the response. |
| LinesResponseNumber [KEY] | Long | The identifier for the negotiation response, linking the attachment to the relevant response in the negotiation. |
| AttachedDocumentId [KEY] | Long | The unique identifier for the attached document. This value is generated by the system when the document is uploaded, serving as the primary key for the attachment. |
| LastUpdateDate | Datetime | The date and time when the attachment was last updated by a user, helping to track when changes were made. |
| LastUpdatedBy | String | The user who most recently updated the attachment, providing accountability for any modifications made to the attachment record. |
| DatatypeCode | String | An abbreviation that identifies the type of attachment data, such as 'FILE', 'FOLDER', 'TEXT', or 'WEB_PAGE', specifying the format of the attachment. |
| FileName | String | The name of the attachment file, used to identify the document in the system and by users. |
| DmFolderPath | String | The folder path in the document management system where the attachment is stored, helping to locate the file within the system. |
| DmDocumentId | String | The unique identifier for the document in the document management system, used for retrieval and management of the attachment. |
| DmVersionNumber | String | The version number of the attached document, enabling version control and tracking changes made to the attachment. |
| Url | String | The URI (Uniform Resource Identifier) that directly identifies the attachment's location, providing a link to access the file. |
| CategoryName | String | The category assigned to the attachment, such as 'From Supplier', 'From Supplier: Technical', or 'From Supplier: Commercial', categorizing the attachment based on its stage in the negotiation. |
| UserName | String | The sign-in details (user login) of the person who added or modified the attachment, used for accountability and auditing purposes. |
| Uri | String | The URI (Uniform Resource Identifier) that identifies the attachment in the system, providing a link to access it. |
| FileUrl | String | The URL (Uniform Resource Locator) for the attachment, allowing users to access or download the document. |
| UploadedText | String | The textual content of the attachment, applicable when the attachment is a text-based document. |
| UploadedFileContentType | String | The content type of the uploaded file, indicating its format. |
| UploadedFileLength | Long | The length (size) of the attached file, typically measured in bytes, indicating how large the file is. |
| UploadedFileName | String | The name of the uploaded file, which may be different from the original file name if modified during upload. |
| ContentRepositoryFileShared | Bool | A flag indicating whether the attachment is shared in the content repository. If true, the attachment is shared; if false, it is not. The default value is false. |
| Title | String | The title of the attachment, providing a brief description or name for easy identification. |
| Description | String | A detailed description of the attachment, providing context and explanation for its contents and purpose within the negotiation. |
| ErrorStatusCode | String | An error code identifying any issues encountered during the attachment process, providing a quick way to diagnose problems. |
| ErrorStatusMessage | String | The error message associated with any issues encountered during the attachment process, providing detailed information about the error. |
| CreatedBy | String | The user who created the attachment record, offering transparency and accountability for the creation of the file. |
| CreationDate | Datetime | The date and time when the attachment record was created, establishing a timeline for the document. |
| FileContents | String | The contents of the attachment, typically stored as text or Base64-encoded data, enabling inspection or processing of the attachment. |
| ExpirationDate | Datetime | The date when the attachment expires, indicating when the document will no longer be considered valid or accessible. |
| LastUpdatedByUserName | String | The login details of the user who last updated the attachment, providing transparency on who made the most recent changes. |
| CreatedByUserName | String | The user name of the person who created the attachment, providing context for who initially uploaded the document. |
| AsyncTrackerId | String | An identifier used for tracking the status and progress of asynchronous file uploads, helpful for handling large files. |
| FileWebImage | String | A Base64-encoded image of the attachment, displayed in .png format if the file source is an image that can be converted for viewing. |
| DownloadInfo | String | A JSON-formatted string containing information needed to programmatically retrieve a large file attachment, used in automated systems. |
| PostProcessingAction | String | The name of the action that should be performed after the attachment is uploaded, such as validation or indexing for future use. |
| Finder | String | A search identifier used to locate specific attachment records related to the negotiation response. |
| ResponseNumber | Long | The unique identifier for the supplier's response, linking the attachment to the corresponding response in the negotiation process. |
| EffectiveDate | Date | The effective date of the attachment, marking when the document is considered valid for use or review in the negotiation. |
Tracks additional cost details, such as freight and setup charges, in a supplier’s draft response to a negotiation line.
| Name | Type | Description |
| DraftSupplierNegotiationResponsesResponseNumber [KEY] | Long | The unique identifier for the negotiation response, linking the cost factor to a specific response within the negotiation. |
| LinesLineId [KEY] | Long | The unique identifier for the negotiation line, allowing the cost factor to be linked to a specific line item within the response. |
| LinesResponseNumber [KEY] | Long | The unique identifier for the response within the negotiation line, providing a direct reference to the response for the cost factor. |
| ResponseNumber [KEY] | Long | The identifier for the negotiation response, allowing for tracking and reference of the specific supplier response. |
| LineId [KEY] | Long | The identifier for the negotiation line, used to link the cost factor to the relevant line item in the response. |
| Line | String | The number that identifies the negotiation line, which helps differentiate between various lines in the negotiation response. |
| LineCostFactorId [KEY] | Long | The unique identifier for the cost factor sequence in the negotiation line, ensuring each cost factor is linked to its respective line. |
| CostFactorId | Long | The identifier for the cost factor itself, linking the factor to the specific negotiation line to which it applies. |
| CostFactor | String | The name of the cost factor, which describes the nature of the cost factor being applied to the negotiation line, such as 'Material Cost' or 'Labor Rate'. |
| Description | String | A detailed description of the cost factor, providing context and further explanation of what the factor represents in the negotiation. |
| TargetValue | Decimal | The target value set by the buyer for the cost factor, indicating the desired or benchmark value for the factor in the negotiation. |
| ResponseValue | Decimal | The value provided by the supplier in response to the cost factor, reflecting their offer or proposal for that particular factor. |
| PricingBasisCode | String | An abbreviation identifying the method used to calculate the cost factor. Accepted values are defined in the 'PON_PRICING_BASIS' lookup type. |
| PricingBasis | String | The basis used to calculate the cost factor, which could include options like 'Fixed Price' or 'Per Unit'. This is defined in the 'PON_PRICING_BASIS' lookup type. |
| DisplayTargetFlag | Bool | A flag indicating whether the supplier can see the target value for the cost factor. If true, the supplier can view it; if false, the target value is hidden from the supplier. |
| CreatedBy | String | The user who created the cost factor record, providing accountability for the data entry. |
| CreationDate | Datetime | The timestamp when the cost factor record was created, establishing when the data was first entered into the system. |
| LastUpdatedBy | String | The user who last updated the cost factor record, ensuring accountability for any subsequent changes made. |
| LastUpdateDate | Datetime | The timestamp of the last update to the cost factor record, helping to track changes made after the initial creation. |
| Finder | String | A search identifier used to locate specific cost factor records within the negotiation response. |
| EffectiveDate | Date | The date from which the cost factor is considered effective, marking when it starts to apply within the negotiation process. |
Groups negotiation line attributes (for example, color, model, capacity) in a supplier’s draft response, supporting complex bid details.
| Name | Type | Description |
| DraftSupplierNegotiationResponsesResponseNumber [KEY] | Long | The unique identifier for the negotiation response, linking it to a specific response within the negotiation. |
| LinesLineId [KEY] | Long | The unique identifier for the negotiation response line, allowing the attribute group to be linked to a specific line within the response. |
| LinesResponseNumber [KEY] | Long | The unique identifier for the response within the negotiation line, linking the attribute group to the correct response. |
| ResponseNumber | Long | The identification number used for the supplier's internal tracking of the response, helping to track and organize responses internally. |
| LineId | Decimal | The identifier for the negotiation line, linking the attribute group to a specific line item in the response. |
| Line | String | The number that identifies the negotiation line, used to differentiate between multiple lines in the response. |
| LineDescription | String | A description of the negotiation line item, providing additional context or details about the goods or services being offered. |
| GroupId [KEY] | Long | The unique identifier for the line attribute group, linking the group to the specific negotiation line and its attributes. |
| GroupName | String | The name of the attribute group, used to categorize and identify a set of related attributes for the negotiation line. |
| SupplierId | Long | The unique identifier for the supplier responding to the negotiation, helping to track which supplier provided the attribute group. |
| Supplier | String | The name of the supplier who responded to the negotiation, providing context for the supplier's offer. |
| CreatedBy | String | The user who created the row, ensuring accountability for the initial entry of the line attribute group data. |
| CreationDate | Datetime | The timestamp when the line attribute group record was created, helping to track when the information was first entered. |
| LastUpdatedBy | String | The user who last updated the row, providing accountability for any modifications made to the record. |
| LastUpdateDate | Datetime | The timestamp of the last update to the row, indicating when the record was most recently modified. |
| Finder | String | A search identifier used to locate specific line attribute group records in the system. |
| EffectiveDate | Date | The date from which the line attribute group becomes effective, marking when the data starts to apply within the negotiation process. |
Lists the individual attributes of a negotiation line within a supplier’s draft response, providing granular specification data.
| Name | Type | Description |
| DraftSupplierNegotiationResponsesResponseNumber [KEY] | Long | The unique identifier for the negotiation response, linking the attribute group to a specific response within the negotiation. |
| LinesLineId [KEY] | Long | The unique identifier for the negotiation response line, allowing the line attribute group to be associated with a specific line item in the response. |
| LinesResponseNumber [KEY] | Long | The unique identifier for the response within the negotiation line, linking the attribute group to the relevant response. |
| ResponseNumber [KEY] | Long | The identification number used for the supplier's internal tracking of the response, helping to organize and manage supplier responses. |
| LineId [KEY] | Long | The identifier for the negotiation line, linking the line attribute group to a specific line item within the negotiation response. |
| Line | String | The number that identifies the negotiation line, used to differentiate between multiple lines in the response. |
| LineDescription | String | A description of the line item, providing more context or details about the goods or services offered in the negotiation. |
| GroupId | Long | The unique identifier for the line attribute group, linking the group to a specific negotiation line and its associated attributes. |
| GroupName | String | The name of the line attribute group, used to categorize and identify related attributes within the negotiation line. |
| AttributeId [KEY] | Long | The unique identifier for the attribute, linking the specific attribute to the negotiation line and response. |
| AttributeName | String | The name or description of the attribute, providing clarity on what the attribute represents in the negotiation line. |
| SupplierId | Long | The unique identifier for the supplier responding to the negotiation, linking the attribute group to the specific supplier. |
| Supplier | String | The name of the supplier who provided the response for the negotiation line, identifying the entity involved. |
| ResponseTypeCode | String | An abbreviation that identifies whether a response is required for the line attribute. Valid values include 'REQUIRED', 'OPTIONAL', and 'DISPLAY_ONLY'. |
| ResponseType | String | Specifies whether the response for the line attribute is required ('REQUIRED'), optional ('OPTIONAL'), or not needed ('DISPLAY_ONLY'). Values are defined in the 'PON_ATTRIBUTE_RESPONSE_TYPE' lookup. |
| ValueTypeCode | String | An abbreviation that identifies the type of value for the attribute response. Valid values include 'TXT', 'NUM', 'DAT', and 'URL', specifying the data format for the response. |
| ValueType | String | The data type for the attribute response, such as text ('TXT'), number ('NUM'), date ('DAT'), or URL ('URL'), as defined in the 'PON_AUCTION_ATTRIBUTE_TYPE' lookup. |
| TargetDateValue | Date | The target value for the attribute when the value type is a date, representing the expected or desired date. |
| TargetNumberValue | Decimal | The target value for the attribute when the value type is a number, indicating the expected or preferred numerical value. |
| TargetTextValue | String | The target value for the attribute when the value type is text or URL, representing the expected or desired text or URL value. |
| ResponseDateValue | Date | The date value provided by the supplier in response to the attribute, used when the attribute value type is a date. |
| ResponseNumberValue | Decimal | The number value provided by the supplier in response to the attribute, used when the attribute value type is a number. |
| ResponseTextValue | String | The text value provided by the supplier in response to the attribute, used when the attribute value type is text. |
| Weight | Decimal | The importance or weight of the line attribute in relation to other attributes, used when calculating the overall score for the negotiation line. |
| CreatedBy | String | The user who created the line attribute group record, providing accountability for the data entry. |
| CreationDate | Datetime | The timestamp when the line attribute group record was created, establishing when the data was first entered into the system. |
| LastUpdatedBy | String | The user who last updated the line attribute group record, ensuring accountability for modifications. |
| LastUpdateDate | Datetime | The timestamp of the last update to the line attribute group record, tracking changes after the original creation. |
| Finder | String | A search identifier used to locate specific line attribute group records in the system. |
| EffectiveDate | Date | The date from which the line attribute group is considered effective, marking when it starts to apply within the negotiation process. |
Defines price variations based on location, volume, or date in a supplier’s draft negotiation response line.
| Name | Type | Description |
| DraftSupplierNegotiationResponsesResponseNumber [KEY] | Long | The unique identifier for the negotiation response, linking it to a specific response within the negotiation line. |
| LinesLineId [KEY] | Long | The unique identifier for the negotiation line, linking the price break to a specific line item within the response. |
| LinesResponseNumber [KEY] | Long | The identifier for the response within the negotiation line, allowing for the price break to be associated with the correct response. |
| ResponseNumber [KEY] | Long | The unique identifier for the supplier’s response, helping to track and manage the specific offer made by the supplier. |
| LineId [KEY] | Long | The identifier for the negotiation line, allowing the price break to be associated with a particular item or service in the negotiation. |
| Line | String | The number that identifies the negotiation line, providing an easy reference to the specific item or service being negotiated. |
| PriceBreakId [KEY] | Long | The unique identifier for the price break, which is used to track the specific price reduction or discount applied to the negotiation line. |
| ShipToOrganizationId | Long | The identifier for the inventory organization to which the supplier will ship the item, ensuring the correct recipient organization is associated with the price break. |
| ShipToOrganization | String | The name of the inventory organization to which the supplier will ship the item, providing clarity on the destination for the goods. |
| ShipToLocationId | Long | The identifier for the location within the inventory organization to which the item will be shipped, specifying where the goods will be delivered. |
| ShipToLocation | String | The name of the location within the organization where the supplier will ship the item, providing further details about the delivery point. |
| Quantity | Decimal | The quantity of items that the price break applies to, specifying the minimum or applicable amount for the discount or reduced price. |
| ResponseValue | Decimal | The supplier's response value for the price break, indicating the price offered by the supplier for the specified quantity. |
| TargetPrice | Decimal | The target price for the price break, representing the price that the buyer expects or desires for the item in the negotiation line. |
| PriceBreakStartDate | Date | The date when the price break goes into effect, marking when the discount or reduced price becomes applicable. |
| PriceBreakEndDate | Date | The date when the price break expires, indicating the last day the price break is valid for the specified quantity. |
| PricingBasisCode | String | An abbreviation that identifies the method used to calculate the price break. Accepted values are defined in the 'PON_SHIPMENT_PRICING_BASIS' lookup. |
| PricingBasis | String | The basis used to calculate the price break, such as 'Per Unit', 'Cumulative', or other criteria defined in the 'PON_SHIPMENT_PRICING_BASIS' lookup. |
| CreatedBy | String | The user who created the price break record, providing accountability for the initial entry of the price break details. |
| CreationDate | Datetime | The timestamp when the price break record was created, establishing when the price break was first entered into the system. |
| LastUpdatedBy | String | The user who last updated the price break record, ensuring accountability for subsequent changes made to the price break. |
| LastUpdateDate | Datetime | The timestamp of the last update to the price break record, tracking when the record was last modified. |
| Finder | String | A search identifier used to locate specific price break records in the system. |
| EffectiveDate | Date | The date from which the price break is considered effective, marking when it starts to apply within the negotiation process. |
Captures tiered pricing details for a supplier’s draft negotiation line, allowing discounted rates at higher order quantities.
| Name | Type | Description |
| DraftSupplierNegotiationResponsesResponseNumber [KEY] | Long | The unique identifier for the negotiation response, linking the price tier to a specific response within the negotiation. |
| LinesLineId [KEY] | Long | The unique identifier for the negotiation response line, associating the price tier with a particular line item in the response. |
| LinesResponseNumber [KEY] | Long | The unique identifier for the response within the negotiation line, linking the price tier to the correct supplier response. |
| ResponseNumber [KEY] | Long | The unique identifier for the supplier's response, helping to track and manage the specific offer made by the supplier. |
| LineId [KEY] | Long | The identifier for the negotiation line, associating the price tier with a specific line item within the negotiation response. |
| Line | String | The number that identifies the negotiation line, helping to differentiate between multiple lines in the response. |
| PriceTierId [KEY] | Long | The unique identifier for the price tier, linking the tier to the specific negotiation line and its quantity-based pricing structure. |
| MinimumQuantity | Decimal | The minimum number of units that qualifies for the price specified in the price tier, setting a threshold for the offer. |
| MaximumQuantity | Decimal | The maximum number of units covered by the price in the price tier, indicating the upper limit for the offer. |
| TargetPrice | Decimal | The target price for the price tier, reflecting the buyer's ideal price for the specified quantity range. |
| Price | Decimal | The price per unit offered by the supplier for the quantity range defined by the price tier, determining the cost for that tier. |
| CreatedBy | String | The user who created the price tier record, providing accountability for the initial entry of the pricing details. |
| CreationDate | Datetime | The timestamp when the price tier record was created, establishing when the price tier was first entered into the system. |
| LastUpdatedBy | String | The user who most recently updated the price tier record, ensuring accountability for any modifications made to the pricing details. |
| LastUpdateDate | Datetime | The timestamp of the last update to the price tier record, tracking when the record was last modified. |
| Finder | String | A search identifier used to locate specific price tier records in the system. |
| EffectiveDate | Date | The date from which the price tier is considered effective, indicating when the tier's pricing structure starts to apply in the negotiation process. |
Groups various sections (for example, commercial, technical) in a supplier's draft negotiation response, organizing requirements and replies.
| Name | Type | Description |
| DraftSupplierNegotiationResponsesResponseNumber [KEY] | Long | The unique identifier for the negotiation response, linking the section to a specific response within the negotiation. |
| ResponseNumber [KEY] | Long | The unique identifier for the supplier's response, helping to track and manage the specific offer made by the supplier. |
| SectionId [KEY] | Long | The unique identifier for the section, linking the section to a specific part of the negotiation. |
| SectionDisplayNumber | String | The display number assigned to the section, used to order multiple sections in the negotiation. For example, sections could be displayed as '10', '20', '30', and so on. |
| PricingSectionFlag | Bool | A flag indicating whether the pricing section is included in the negotiation. If true, the pricing section is included; if false, it is excluded. This flag is used when the Overall Ranking Method is Composite Scoring. The default value is false. |
| Section | String | The name or title of the requirement section, providing context for the type of information or criteria addressed in the section. |
| EvaluationStageCode | String | An abbreviation that identifies the evaluation stage in a two-stage RFQ. Accepted values are defined in the 'PON_TWO_PART_TYPE' lookup type, such as 'TECH' for technical or 'COM' for commercial. |
| EvaluationStage | String | The name of the evaluation stage in a two-stage RFQ, typically either 'Technical' or 'Commercial', as defined in the 'PON_TWO_PART_TYPE' lookup type. |
| CreatedBy | String | The user who created the section record, providing accountability for the entry of the section in the negotiation. |
| CreationDate | Datetime | The timestamp when the section record was created, establishing the date and time when the section was first entered into the system. |
| LastUpdatedBy | String | The user who last updated the section record, ensuring accountability for any modifications made to the section. |
| LastUpdateDate | Datetime | The timestamp of the last update to the section record, tracking when the section was most recently modified. |
| Finder | String | A search identifier used to locate specific section records within the system. |
| EffectiveDate | Date | The date from which the section is considered effective, marking when the section starts to apply in the negotiation process. |
Lists specific requirements or questions within each section, prompting suppliers to provide data or clarifications.
| Name | Type | Description |
| DraftSupplierNegotiationResponsesResponseNumber [KEY] | Long | The unique identifier for the negotiation response, linking the requirement section to a specific response within the negotiation. |
| SectionsResponseNumber [KEY] | Long | The unique identifier for the response within the section, linking the requirement section to a specific response in the negotiation. |
| SectionsSectionId [KEY] | Long | The unique identifier for the section in the response, linking the requirement section to a specific part of the negotiation. |
| ResponseNumber [KEY] | Long | The unique identifier for the supplier’s response, used to track and manage the specific offer made by the supplier for the requirement. |
| SectionId | Long | The unique identifier for the section, linking the requirement to the specific section within the negotiation response. |
| Section | String | The name of the requirement section, providing context for the group of requirements within the negotiation. |
| RequirementId [KEY] | Long | The unique identifier for the requirement, linking it to the specific element of the negotiation and its corresponding response. |
| ScoreId | Long | The unique identifier for the score associated with the requirement, providing a reference for the evaluation of the supplier’s response. |
| ParentType | String | The type of the requirement's parent. If the section is the parent of another requirement, the ParentType is SECTION. If not, it is SCORE. |
| RequirementLevel | Decimal | The level of the requirement in the hierarchy. Level 1 is for parent sections, while level 2 and beyond represent branching requirements with specific score-based responses. |
| RequirementNumber | String | The unique identifier for the requirement’s sequence, helping to order the requirements within the negotiation process. |
| QuestionId | Long | The unique identifier for the question associated with the requirement, linking the requirement to a predefined question. |
| QuestionRevisionNumber | Int | The revision number of the predefined question associated with the requirement, tracking updates or changes to the question over time. |
| Requirement | String | The name or title of the requirement, describing what the supplier needs to respond to in the negotiation. |
| RequirementText | String | The description of the requirement, providing detailed instructions or context to help the supplier understand the expectation. |
| Hint | String | Text that is displayed to the supplier to assist in responding to the requirement, offering guidance on how to meet the requirement. |
| LevelCode | String | An abbreviation that identifies the supplier level for the requirement. Values include 'Supplier' or 'Supplier Site', as defined in the 'PON_SUPPLIER_LEVEL' lookup. |
| Level | String | The supplier level for the requirement, indicating whether the requirement is for the supplier or the supplier site, as defined in the 'PON_SUPPLIER_LEVEL' lookup. |
| ResponseTypeCode | String | An abbreviation that specifies whether a response is required for the requirement. Values include 'Required', 'Optional', 'Display Only', or 'Internal', defined in the 'PON_HDR_ATTR_RESPONSE_TYPE' lookup. |
| ResponseType | String | Specifies whether a response for the requirement is required, optional, displayed only for reference, or internal for the negotiation process. Values are defined in the 'PON_HDR_ATTR_RESPONSE_TYPE' lookup. |
| RequirementTypeCode | String | An abbreviation that uniquely identifies the type of response required for the requirement. Values include 'Text Entry Box', 'Multiple Choice with Multiple Selections', and 'Multiple Choice with Single Selection', defined in the 'PON_REQUIREMENT_TYPE' lookup. |
| RequirementType | String | The type of response required for the negotiation, such as 'Text Entry Box' for open text, 'Multiple Choice with Multiple Selections', or 'Multiple Choice with Single Selection', defined in the 'PON_REQUIREMENT_TYPE' lookup. |
| ValueTypeCode | String | An abbreviation that identifies the type of value expected for the requirement. Accepted values are defined in the 'PON_REQ_RESPONSE_TYPE' lookup. |
| ValueType | String | The type of value expected for the requirement, such as 'Single Line Text', 'Multiple Line Text', 'Number', 'Date', 'Date and Time', or 'URL', as defined in the 'PON_REQ_RESPONSE_TYPE' lookup. |
| TargetTextValue | String | The target value for the requirement when the value type is text or URL, representing the desired response. |
| TargetNumberValue | Decimal | The target value for the requirement when the value type is a number, indicating the expected numerical response. |
| TargetDateValue | Date | The target value for the requirement when the value type is a date, specifying the desired date response. |
| TargetDateTimeValue | Datetime | The target value for the requirement when the value type is a date and time, specifying the expected datetime response. |
| Comments | String | Comments entered by the supplier in response to the requirement, providing additional context or explanations related to the requirement. |
| CreatedBy | String | The user who created the requirement record, providing accountability for the data entry. |
| CreationDate | Datetime | The timestamp when the requirement record was created, establishing when the information was first entered into the system. |
| LastUpdateDate | Datetime | The timestamp of the last update to the requirement record, tracking modifications made after the initial creation. |
| LastUpdatedBy | String | The user who most recently updated the requirement record, ensuring accountability for changes. |
| AllowAttachmentCode | String | A value that determines whether the supplier can add attachments with the requirement. Valid values are 'OPTIONAL', 'REQUIRED', and 'NON_ALLOWED'. The default is 'NON_ALLOWED'. |
| AllowCommentsFlag | Bool | A flag indicating whether the supplier is allowed to add comments with the requirement. If true, comments can be added; if false, comments are not allowed. The default value is false. |
| Finder | String | A search identifier used to locate specific requirement records within the system. |
| EffectiveDate | Date | The date from which the requirement is considered effective, marking when the requirement starts to apply within the negotiation process. |
Stores supporting files linked to a draft requirement, such as technical documents or references from the supplier.
| Name | Type | Description |
| DraftSupplierNegotiationResponsesResponseNumber [KEY] | Long | The unique identifier for the negotiation response, linking the attachment to a specific response within the negotiation. |
| SectionsResponseNumber [KEY] | Long | The unique identifier for the response within the section, linking the requirement attachment to the correct response. |
| SectionsSectionId [KEY] | Long | The unique identifier for the section in the response, associating the attachment with a specific section in the negotiation. |
| RequirementsRequirementId [KEY] | Long | The unique identifier for the requirement, linking the attachment to a specific requirement within the negotiation. |
| RequirementsResponseNumber [KEY] | Long | The unique identifier for the response within the requirement, linking the attachment to the specific supplier response for that requirement. |
| AttachedDocumentId [KEY] | Long | The unique identifier for the attachment, assigned by the system when the document is uploaded and linked to the negotiation. |
| LastUpdateDate | Datetime | The date and time when the attachment was last updated by the user, providing a record of the most recent changes. |
| LastUpdatedBy | String | The user who most recently updated the attachment, ensuring accountability for modifications made to the document. |
| DatatypeCode | String | An abbreviation identifying the data type of the attachment. Possible values include 'FILE', 'FOLDER', 'TEXT', or 'WEB_PAGE', denoting the format of the document. |
| FileName | String | The name of the attached file, used to identify the document in the system and by users. |
| DmFolderPath | String | The folder path within the document management system where the attachment is stored, specifying its location. |
| DmDocumentId | String | The unique identifier for the attached document in the document management system, allowing for its retrieval and management. |
| DmVersionNumber | String | The version number of the attached document, helping track changes or updates to the document over time. |
| Url | String | The URI (Uniform Resource Identifier) that points to the attachment, allowing access to the document. |
| CategoryName | String | The category assigned to the attachment, which helps identify its role in the negotiation process. Examples include 'From Supplier' or 'From Supplier: Technical'. |
| UserName | String | The sign-in credentials (user login) used by the person who added or modified the attachment, providing accountability for the attachment's entry. |
| Uri | String | The URI (Uniform Resource Identifier) for accessing the attachment, providing a direct reference to the document in the system. |
| FileUrl | String | The URL (Uniform Resource Locator) for the attachment, offering a direct link for users to view or download the document. |
| UploadedText | String | The textual content of the attachment, applicable when the attachment is a text-based document. |
| UploadedFileContentType | String | The content type of the attachment, indicating its format. |
| UploadedFileLength | Long | The size of the attached file, measured in bytes, providing information on the document's size. |
| UploadedFileName | String | The name of the uploaded file, which may be different from the original file name if modified during upload. |
| ContentRepositoryFileShared | Bool | A flag indicating whether the attachment is shared in the content repository. If true, the document is shared; if false, it is not. The default is false. |
| Title | String | The title of the attachment, used to provide a brief description or name for easy identification of the document. |
| Description | String | A detailed description of the attachment, providing additional context on the contents and purpose of the document. |
| ErrorStatusCode | String | The error code associated with the attachment, if any, providing a way to identify and address issues during the upload process. |
| ErrorStatusMessage | String | The error message describing any issues encountered during the attachment process, helping to diagnose problems. |
| CreatedBy | String | The user who created the attachment record, ensuring accountability for the document's initial upload. |
| CreationDate | Datetime | The date and time when the attachment record was created, establishing a timeline for the document's entry into the system. |
| FileContents | String | The contents of the attachment, typically stored as text or Base64-encoded data, allowing for inspection or processing of the document. |
| ExpirationDate | Datetime | The date when the attachment expires, indicating when the document is no longer considered valid or accessible. |
| LastUpdatedByUserName | String | The login details of the user who last updated the attachment, providing transparency on who made the most recent changes. |
| CreatedByUserName | String | The user name of the person who created the attachment record, offering context on the initial document upload. |
| AsyncTrackerId | String | An identifier used to track the status and progress of asynchronous file uploads, especially for large files. |
| FileWebImage | String | A Base64-encoded image of the attachment displayed in .png format if the file source is an image that can be converted for preview. |
| DownloadInfo | String | A JSON-formatted string containing information necessary to programmatically retrieve a large file attachment. |
| PostProcessingAction | String | The name of the action that can be performed after the attachment is uploaded, such as validating or indexing the document for future use. |
| Finder | String | A search identifier used to locate specific attachment records related to the negotiation response. |
| ResponseNumber | Long | The unique identifier for the supplier's response, linking the attachment to the corresponding response in the negotiation. |
| EffectiveDate | Date | The date from which the attachment is considered effective, marking when it is valid for use or review in the negotiation process. |
Holds the supplier's actual responses (text, numeric, date) for each requirement in a draft negotiation response.
| Name | Type | Description |
| DraftSupplierNegotiationResponsesResponseNumber [KEY] | Long | The unique identifier for the negotiation response, linking the response value to a specific response within the negotiation. |
| SectionsResponseNumber [KEY] | Long | The unique identifier for the response within the section, allowing the response value to be associated with a specific section in the negotiation. |
| SectionsSectionId [KEY] | Long | The unique identifier for the section in the response, linking the requirement response value to a specific section within the negotiation. |
| RequirementsRequirementId [KEY] | Long | The unique identifier for the requirement, linking the response value to a specific requirement within the negotiation. |
| RequirementsResponseNumber [KEY] | Long | The unique identifier for the response within the requirement, linking the response value to the supplier's response to that specific requirement. |
| ResponseNumber | Long | The unique identifier for the requirement response value, applicable for text entry box responses where no scoring is involved. |
| SectionId | Long | The unique identifier for the section, associating the requirement response value with a specific section of the negotiation. |
| Section | String | The name of the requirement section, providing context for the group of requirements in the negotiation. |
| RequirementId | Long | The unique identifier for the requirement, linking the response value to the specific requirement in the negotiation. |
| RequirementNumber | String | The unique identifier for the sequence of the requirement, helping to order and track individual requirements within the negotiation. |
| Requirement | String | The name of the requirement, describing what the supplier is asked to respond to in the negotiation. |
| RequirementLevel | Decimal | The hierarchical level at which the requirement is located, with Level 1 being the parent section and subsequent levels representing branching requirements with acceptable response scores. |
| RequirementValueId [KEY] | Long | The unique identifier for the response value, linking the specific value provided by the supplier to the requirement. |
| ScoreId | Long | The unique identifier for the response score, applicable for requirements such as 'Multiple Choice with Single Selection' or 'Multiple Choice with Multiple Selections'. |
| QuestionId | Long | The unique identifier for the requirement associated with a predefined question, linking the response value to the specific question. |
| ScoreDisplayNumber | String | The display number assigned to the score, helping to organize and identify the scores associated with multiple-choice responses or other numerical responses. |
| ResponseValueText | String | The response value for a requirement where the response type is text, providing the supplier's text-based answer. |
| ResponseValueNumber | Decimal | The response value for a requirement where the response type is a number, representing the numerical answer provided by the supplier. |
| ResponseValueDate | Date | The response value for a requirement where the response type is a date, representing the date provided by the supplier. |
| ResponseValueDateTime | Datetime | The response value for a requirement where the response type is date and time, representing the specific datetime provided by the supplier. |
| IsSelectedFlag | Bool | A flag indicating whether the response value is selected in 'Multiple Choice' requirements. If true, the response is selected; if false, it is not selected. |
| TargetTextValue | String | The target value set by the category manager for text or URL responses, providing the desired response for the requirement. |
| TargetNumberValue | Decimal | The target value set by the category manager for numerical responses, indicating the desired numerical answer for the requirement. |
| TargetDateValue | Date | The target value set by the category manager for date responses, specifying the desired date for the requirement. |
| TargetDatetimeValue | Datetime | The target value set by the category manager for date and time responses, specifying the desired datetime for the requirement. |
| CreatedBy | String | The user who created the response value record, providing accountability for the data entry. |
| CreationDate | Datetime | The timestamp when the response value record was created, establishing when the data was first entered into the system. |
| LastUpdateDate | Datetime | The timestamp of the last update to the response value record, tracking modifications after the initial creation. |
| LastUpdatedBy | String | The user who most recently updated the response value record, ensuring accountability for changes made. |
| AllowAttachmentCode | String | A value that determines whether the supplier can add attachments with the requirement responses. Valid values include 'OPTIONAL', 'REQUIRED', and 'NON_ALLOWED', with the default being 'NON_ALLOWED'. |
| attachments | String | A placeholder for attachment data, allowing the supplier to attach additional files or documents related to the requirement response. |
| Finder | String | A search identifier used to locate specific requirement response value records within the system. |
| EffectiveDate | Date | The date from which the requirement response value is considered effective, marking when it starts to apply in the negotiation process. |
Displays search finder names and corresponding attributes for a specific view, helping locate and filter procurement data.
ViewName is required to get the mapping FinderName and finder parameter column.
The ViewName column supports = and IN operators
SELECT * FROM Finders where viewname = 'Invoices'
SELECT * FROM Finders where viewname IN ('Invoices','InvoicesinvoiceLines')
| Name | Type | Description |
| ViewName | String | The name of the view that the finder should search within. |
| FinderName | String | The name assigned to the specific finder being used. |
| AttributeFinderColumn | String | The name of the column in the finder that represents the attribute being searched. |
| Type | String | The data type of the finder attribute, specifying the kind of data it holds (for example, string or integer). |
Retrieves descriptive flexfield contexts for extended data capture, customizing the procurement application's data structures.
| Name | Type | Description |
| ApplicationId [KEY] | Long | The unique identifier for the application in the FlexFndDffDescriptiveFlexfieldContexts table. |
| DescriptiveFlexfieldCode [KEY] | String | The code assigned to the descriptive flexfield, which identifies its type or purpose in the context of FlexFndDffDescriptiveFlexfieldContexts. |
| ContextCode [KEY] | String | The code associated with the specific context of the descriptive flexfield within the FlexFndDffDescriptiveFlexfieldContexts table. |
| Name | String | The name of the FlexFndDffDescriptiveFlexfieldContexts context, representing the specific descriptive flexfield context. |
| Description | String | A detailed description of the FlexFndDffDescriptiveFlexfieldContexts context, providing additional context and explanation. |
| EnabledFlag | String | Indicates whether the specific FlexFndDffDescriptiveFlexfieldContexts context is enabled or disabled. |
| Bind_ApplicationId | Long | The bound application identifier that associates a specific application to the FlexFndDffDescriptiveFlexfieldContexts context. |
| Bind_DescriptiveFlexfieldCode | String | The bound descriptive flexfield code that links a specific flexfield type to the context. |
| Finder | String | The finder function or mechanism used for retrieving the relevant data within the FlexFndDffDescriptiveFlexfieldContexts context. |
Exposes character-based values in a value set, letting users manage permissible entries for specific procurement fields.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for each record in the FlexFndPvsCharacterIdCharacterValues table. |
| Value | String | The specific value associated with the FlexFndPvsCharacterIdCharacterValues record. |
| Description | String | A detailed description of the character value in the FlexFndPvsCharacterIdCharacterValues record. |
| StartDateActive | Date | The start date when the FlexFndPvsCharacterIdCharacterValues record becomes active and valid. |
| EndDateActive | Date | The end date when the FlexFndPvsCharacterIdCharacterValues record becomes inactive or no longer valid. |
| EnabledFlag | String | Indicates whether the FlexFndPvsCharacterIdCharacterValues record is enabled or disabled for use. |
| SummaryFlag | String | Indicates if the FlexFndPvsCharacterIdCharacterValues record is considered a summary value. |
| ValueSetCode | String | The code representing the value set to which the FlexFndPvsCharacterIdCharacterValues record belongs. |
| Bind_DataSource | String | The data source that is bound to the FlexFndPvsCharacterIdCharacterValues record, indicating its origin. |
| Bind_FinderContext | String | The specific context in which the finder is used for the FlexFndPvsCharacterIdCharacterValues record. |
| Bind_FinderDateFlag | String | Indicates if the record is linked to a date-specific finder mechanism. |
| Bind_ValidationDate | Date | The date used for validating the FlexFndPvsCharacterIdCharacterValues record. |
| Finder | String | The finder function or mechanism used for retrieving specific FlexFndPvsCharacterIdCharacterValues records. |
| Flex_vst_bind1 | String | A binding parameter (Flex_vst_bind1) used in the context of FlexFndPvsCharacterIdCharacterValues for specific filtering. |
| Flex_vst_bind10 | String | A binding parameter (Flex_vst_bind10) used in the context of FlexFndPvsCharacterIdCharacterValues for specific filtering. |
| Flex_vst_bind11 | String | A binding parameter (Flex_vst_bind11) used in the context of FlexFndPvsCharacterIdCharacterValues for specific filtering. |
| Flex_vst_bind12 | String | A binding parameter (Flex_vst_bind12) used in the context of FlexFndPvsCharacterIdCharacterValues for specific filtering. |
| Flex_vst_bind13 | String | A binding parameter (Flex_vst_bind13) used in the context of FlexFndPvsCharacterIdCharacterValues for specific filtering. |
| Flex_vst_bind14 | String | A binding parameter (Flex_vst_bind14) used in the context of FlexFndPvsCharacterIdCharacterValues for specific filtering. |
| Flex_vst_bind15 | String | A binding parameter (Flex_vst_bind15) used in the context of FlexFndPvsCharacterIdCharacterValues for specific filtering. |
| Flex_vst_bind16 | String | A binding parameter (Flex_vst_bind16) used in the context of FlexFndPvsCharacterIdCharacterValues for specific filtering. |
| Flex_vst_bind17 | String | A binding parameter (Flex_vst_bind17) used in the context of FlexFndPvsCharacterIdCharacterValues for specific filtering. |
| Flex_vst_bind18 | String | A binding parameter (Flex_vst_bind18) used in the context of FlexFndPvsCharacterIdCharacterValues for specific filtering. |
| Flex_vst_bind19 | String | A binding parameter (Flex_vst_bind19) used in the context of FlexFndPvsCharacterIdCharacterValues for specific filtering. |
| Flex_vst_bind2 | String | A binding parameter (Flex_vst_bind2) used in the context of FlexFndPvsCharacterIdCharacterValues for specific filtering. |
| Flex_vst_bind20 | String | A binding parameter (Flex_vst_bind20) used in the context of FlexFndPvsCharacterIdCharacterValues for specific filtering. |
| Flex_vst_bind3 | String | A binding parameter (Flex_vst_bind3) used in the context of FlexFndPvsCharacterIdCharacterValues for specific filtering. |
| Flex_vst_bind4 | String | A binding parameter (Flex_vst_bind4) used in the context of FlexFndPvsCharacterIdCharacterValues for specific filtering. |
| Flex_vst_bind5 | String | A binding parameter (Flex_vst_bind5) used in the context of FlexFndPvsCharacterIdCharacterValues for specific filtering. |
| Flex_vst_bind6 | String | A binding parameter (Flex_vst_bind6) used in the context of FlexFndPvsCharacterIdCharacterValues for specific filtering. |
| Flex_vst_bind7 | String | A binding parameter (Flex_vst_bind7) used in the context of FlexFndPvsCharacterIdCharacterValues for specific filtering. |
| Flex_vst_bind8 | String | A binding parameter (Flex_vst_bind8) used in the context of FlexFndPvsCharacterIdCharacterValues for specific filtering. |
| Flex_vst_bind9 | String | A binding parameter (Flex_vst_bind9) used in the context of FlexFndPvsCharacterIdCharacterValues for specific filtering. |
Stores user-specific shopping lists containing favorite or frequently purchased items for quick requisition creation.
| Name | Type | Description |
| PersonalShoppingListHeaderId [KEY] | Long | The unique identifier for the header of the personal shopping list. |
| PersonalShoppingList | String | The name that uniquely identifies a specific personal shopping list. |
| CreatedBy | String | The identifier of the user who originally created the personal shopping list. |
| CreationDate | Datetime | The date and time when the personal shopping list was created. |
| LastUpdatedBy | String | The identifier of the user who last updated the personal shopping list. |
| LastUpdateDate | Datetime | The date and time when the personal shopping list was last updated. |
| ImageURL | String | The URL that points to the image representing the personal shopping list, typically used for visual identification. |
| Finder | String | The finder function or mechanism used to search for or retrieve the personal shopping list. |
Breaks down a personal shopping list into individual items or services, enabling faster selection during requisitioning.
| Name | Type | Description |
| PersonalShoppingListsPersonalShoppingListHeaderId [KEY] | Long | The unique identifier for the personal shopping list header associated with the shopping list line. |
| PersonalShoppingListLineId [KEY] | Long | The unique identifier for each individual line in the personal shopping list. |
| PersonalShoppingListHeaderId | Long | The unique identifier for the personal shopping list that the line belongs to. |
| PunchoutCatalogId | Long | The identifier for the punchout catalog referenced by the shopping list line, linking to an external catalog. |
| PunchoutCatalog | String | The name or identifier of the punchout catalog linked to the shopping list line. |
| ItemSource | String | Indicates the source of the item, such as a catalog or manual entry. |
| RequisitioningBUId | Long | The unique identifier for the requisitioning business unit related to the shopping list line. |
| RequisitioningBU | String | The name of the requisitioning business unit that created the shopping list line. |
| SourceAgreementHeaderId | Long | The identifier for the source agreement associated with the shopping list line, which contains terms for the purchase. |
| SourceAgreement | String | The number or code of the source agreement associated with the shopping list line. |
| SourceAgreementLineId | Long | The identifier for the line within the source agreement referenced by the shopping list line. |
| SourceAgreementLineNumber | Decimal | The specific line number within the source agreement that corresponds to the shopping list line. |
| ItemId | Long | The unique identifier for the item listed on the shopping list line. |
| Item | String | The name or abbreviation of the item listed on the shopping list line. |
| PublicShoppingListHeaderId | Long | The identifier for the public shopping list associated with the shopping list line. |
| SmartFormId | Long | The identifier for the smart form used for the shopping list line. |
| SmartFormName | String | The name of the smart form referenced for the shopping list line, often used for customized data entry. |
| ItemDescription | String | A detailed description of the item or service on the shopping list line. |
| LineTypeId | Long | The identifier for the type of line, indicating whether the item is a good or a service. |
| LineType | String | The type of item listed in the shopping list line, such as 'goods' or 'services'. |
| ItemRevision | String | The revision number or version identifier for the item listed on the shopping list line. |
| CategoryId | Long | The identifier for the purchasing category of the item on the shopping list line. |
| CategoryName | String | The name of the purchasing category of the item listed on the shopping list line. |
| UOMCode | String | The abbreviation for the unit of measure used for the item quantity on the shopping list line. |
| UOM | String | The unit of measure (for example, each, box, kg) for the quantity of the item. |
| UnitPrice | Decimal | The price per unit of the item on the shopping list line, in the currency of the buying company. |
| Amount | Decimal | The total amount for the shopping list line item, calculated as unit price multiplied by quantity, in the currency of the buying company. |
| SupplierId | Long | The unique identifier for the supplier providing the item or service on the shopping list line. |
| Supplier | String | The name of the supplier responsible for fulfilling the goods or services on the shopping list line. |
| SupplierSiteId | Long | The identifier for the supplier site from where the item or service is provided. |
| SupplierSite | String | The name or identifier of the supplier location from which the item or service is sourced. |
| SupplierContactId | Long | The unique identifier for the supplier contact person for the shopping list line. |
| SupplierContact | String | The name of the person representing the supplier for communication regarding the shopping list line. |
| SupplierContactEmail | String | The email address of the supplier contact for communication regarding the shopping list line. |
| SupplierContactPhone | String | The phone number of the supplier contact for communication regarding the shopping list line. |
| SupplierContactFax | String | The fax number of the supplier contact for communication regarding the shopping list line. |
| SuggestedSupplier | String | The name of a suggested new supplier for fulfilling the goods or services on the shopping list line. |
| SuggestedSupplierSite | String | The identifier or name of the suggested supplier site for fulfilling the goods or services. |
| SuggestedSupplierContact | String | The name of the person representing the suggested new supplier for the shopping list line. |
| SuggestedSupplierContactPhone | String | The phone number of the contact person at the suggested new supplier. |
| SuggestedSupplierContactFax | String | The fax number of the contact person at the suggested new supplier. |
| SuggestedSupplierContactEmail | String | The email address of the contact person at the suggested new supplier. |
| SuggestedSupplierItemNumber | String | The item number assigned by the suggested supplier for the item on the shopping list line. |
| ManufacturerId | Decimal | The unique identifier for the manufacturer of the item on the shopping list line. |
| ManufacturerName | String | The name of the manufacturer for the item on the shopping list line. |
| ManufacturerPartNumber | String | The part number assigned by the manufacturer for the item on the shopping list line. |
| NegotiationRequiredFlag | Bool | Indicates whether a request for quotation (RFQ) is required before placing the requisition on a purchase order (true or false). |
| NewSupplierFlag | Bool | Indicates whether the supplier on the shopping list line is a new supplier (true) or an existing supplier (false). |
| CurrencyCode | String | The abbreviation for the currency used in the shopping list line. |
| Currency | String | The name of the currency used for the shopping list line. |
| ConversionRateType | String | The type of exchange rate used for converting currencies in the purchase requisition. |
| ConversionRate | Decimal | The rate used to convert one currency to another for the shopping list line. |
| ConversionRateDate | Date | The date from which the specified conversion rate is valid. |
| NegotiatedByPreparerFlag | Bool | Indicates whether the price of the item was agreed upon in advance by the preparer (true or false). |
| BPAPriceUserOverrideFlag | Bool | Indicates whether the blanket purchase agreement (BPA) price has been manually overridden by the user (true or false). |
| CreatedBy | String | The identifier for the user who created the personal shopping list line. |
| CreationDate | Datetime | The date and time when the personal shopping list line was created. |
| LastUpdatedBy | String | The identifier for the user who last updated the personal shopping list line. |
| LastUpdateDate | Datetime | The date and time when the personal shopping list line was last updated. |
| InventoryOrganizationId | Long | The unique identifier for the inventory organization where the item for the shopping list line is stored. |
| InventoryOrganization | String | The name of the inventory organization that provides the item for the shopping list line. |
| InventoryOrganizationCode | String | The abbreviation or code that identifies the inventory organization for the shopping list line item. |
| LineImageURL | String | The URL for the image representing the specific shopping list line. |
| SuggestedQuantity | Decimal | The suggested default quantity for the personal shopping list line. |
| Finder | String | The finder function used to retrieve or search for personal shopping list lines. |
| PersonalShoppingList | String | The name or identifier of the personal shopping list to which the shopping list line belongs. |
Maintains records of users designated as procurement agents (buyers, supplier managers), defining their responsibilities and privileges.
| Name | Type | Description |
| AssignmentId [KEY] | Long | The unique identifier for the assignment of a procurement agent, linking the agent to their specific role and responsibilities. |
| Agent | String | The name of the procurement agent, formatted as Last Name, First Name. |
| AgentId | Long | The unique identifier assigned to the procurement agent. |
| AgentEmail | String | The email address of the procurement agent for communication purposes. |
| ProcurementBU | String | The name of the procurement business unit to which the agent is assigned, indicating where the agent works. |
| ProcurementBUId | Long | The unique identifier for the procurement business unit. |
| Status | String | The current status of the procurement agent. Valid values include 'Inactive' and 'Active', with 'Active' being the default. |
| StatusCode | String | The abbreviated status of the procurement agent. 'Y' indicates active status, while 'N' indicates inactive status. The default is 'Y'. |
| DefaultRequisitioningBU | String | The name of the default requisitioning business unit where the agent handles requisitions. |
| DefaultRequisitioningBUId | Long | The unique identifier for the default requisitioning business unit associated with the procurement agent. |
| DefaultPrinter | String | The default printer assigned to the procurement agent for printing documents. |
| ManageRequisitionsAllowedFlag | Bool | Indicates whether the procurement agent is allowed to manage purchase requisitions. 'True' means allowed, 'False' means not allowed. Default is 'False'. |
| AccessLevelToOtherAgentsRequisitions | String | The access level for managing requisitions owned by other agents. Possible values are 'None', 'View', and 'Full', with 'None' as the default. |
| ManageOrdersAllowedFlag | Bool | Indicates whether the procurement agent is allowed to manage purchase orders. 'True' means allowed, 'False' means not allowed. Default is 'False'. |
| AccessLevelToOtherAgentsOrders | String | The access level for managing orders owned by other agents. Valid values include 'None', 'View', and 'Full', with 'None' as the default. |
| ManageAgreementsAllowedFlag | Bool | Indicates whether the procurement agent is allowed to manage purchase agreements. 'True' means allowed, 'False' means not allowed. Default is 'False'. |
| AccessLevelToOtherAgentsAgreements | String | The access level for managing agreements owned by other agents. Valid values include 'None', 'View', and 'Full', with 'None' as the default. |
| ManageNegotiationsAllowedFlag | Bool | Indicates whether the procurement agent is allowed to manage negotiations. 'True' means allowed, 'False' means not allowed. Default is 'False'. |
| AccessLevelToOtherAgentsNegotiations | String | The access level for managing negotiations owned by other agents. Valid values include 'None', 'View', and 'Full', with 'None' as the default. |
| ManageSourcingProgramsAllowedFlag | Bool | Indicates whether the procurement agent is allowed to manage sourcing programs. 'True' means allowed, 'False' means not allowed. Default is 'False'. |
| AccessLevelToOtherAgentsSourcingPrograms | String | The access level for managing sourcing programs owned by other agents. Valid values include 'None', 'View', and 'Full', with 'None' as the default. |
| ManageCatalogContentAllowedFlag | Bool | Indicates whether the procurement agent is allowed to manage catalog content. 'True' means allowed, 'False' means not allowed. Default is 'False'. |
| ManageSuppliersAllowedFlag | Bool | Indicates whether the procurement agent is allowed to manage suppliers. 'True' means allowed, 'False' means not allowed. Default is 'False'. |
| ManageQualificationsAllowedFlag | Bool | Indicates whether the procurement agent is allowed to manage supplier qualifications. 'True' means allowed, 'False' means not allowed. Default is 'False'. |
| AccessLevelToOtherAgentsQualifications | String | The access level for managing qualifications owned by other procurement agents. Valid values include 'None', 'View', and 'Full', with 'None' as the default. |
| ManageAslAllowedFlag | Bool | Indicates whether the procurement agent is allowed to manage entries on the approved supplier list. 'True' means allowed, 'False' means not allowed. Default is 'False'. |
| AnalyzeSpendAllowedFlag | Bool | Indicates whether the procurement agent is allowed to analyze spend data. 'True' means allowed, 'False' means not allowed. Default is 'False'. |
| AccessLevelToOtherAgentsChecklists | String | The access level for managing compliance checklists owned by other agents. Valid values include 'None', 'View', and 'Full', with 'None' as the default. |
| ManageChecklistsAllowedFlag | Bool | Indicates whether the procurement agent is allowed to manage compliance checklists. 'True' means allowed, 'False' means not allowed. Default is 'False'. |
| Finder | String | The finder function or mechanism used to search for or retrieve procurement agent records. |
Tracks relationships between suppliers and the items or categories they’re approved to supply, ensuring compliance and vendor checks.
| Name | Type | Description |
| AslId [KEY] | Long | The unique identifier for each entry in the approved supplier list, linking it to a specific supplier and item. |
| ProcurementBUId | Long | The unique identifier for the business unit responsible for managing and owning the approved supplier list entry. |
| ProcurementBU | String | The name of the procurement business unit that owns and manages the approved supplier list entry. |
| AslScopeCode | String | A code that identifies whether the approved supplier list entry is specific to a particular ship-to organization or applicable to all organizations served by the procurement business unit. |
| Scope | String | Indicates whether the approved supplier list entry applies to a specific ship-to organization or to all ship-to organizations associated with the procurement business unit. |
| ShipToOrganizationId | Long | The unique identifier for the inventory organization that receives the goods supplied by the supplier. |
| ShipToOrganization | String | The name of the inventory organization that should receive the items supplied by the supplier. |
| Item | String | The goods, services, or products that the business makes, purchases, or sells, including components, subassemblies, finished products, or supplies. |
| ItemId | Long | The unique identifier for the item listed in the approved supplier list entry. |
| Supplier | String | The organization or individual that provides goods or services to the buying organization under a contractual obligation. |
| SupplierId | Long | The unique identifier for the supplier fulfilling the order, distinguishing them from other suppliers. |
| SupplierSite | String | The location or entity through which the buying organization conducts business with the supplier. |
| SupplierSiteId | Long | The unique identifier for the location from which the supplier fulfills the order. |
| PrimaryVendorItem | String | The item number assigned by the supplier for the item listed on the approved supplier list. |
| Status | String | The approval status of the approved supplier list entry, indicating whether the supplier is authorized to supply the specified item or items. |
| AslStatusId | Long | The unique identifier for the status of the approved supplier list entry. |
| ReviewDueDate | Date | The date by which the approved supplier list entry should be reviewed, typically for supplier recertification or approval renewal. |
| DisableFlag | Bool | Indicates whether the approved supplier list entry is still active or has been disabled and is no longer in use. |
| Comments | String | Any additional notes or comments related to the approved supplier list entry, typically entered during review or approval. |
| AslCreationDate | Datetime | The date and time when the approved supplier list entry was created. |
| PurchasingUOMCode | String | The code representing the unit of measure used for purchase orders derived from the approved supplier list entry. |
| PurchasingUOM | String | The unit of measure used for purchase orders placed using the approved supplier list entry (for example, each, box, kg). |
| CountryOfOriginCode | String | The code representing the country from which the goods are exported by the supplier. |
| CountryOfOrigin | String | The name of the country from which the goods are exported by the supplier. |
| MinimumOrderQuantity | Decimal | The minimum quantity that must be ordered from the supplier on purchase orders originating from the approved supplier list entry. |
| FixedLotMultiple | Decimal | The incremental order quantity that must be used for purchase orders sourced from the approved supplier list entry. |
| Finder | String | The function or mechanism used to search for approved supplier list entries. |
| EffectiveDate | Date | The date used to fetch resources that are effective as of this specified start date. |
Holds descriptive flexfields tied to approved supplier list entries, allowing additional data capture or custom validations.
| Name | Type | Description |
| ProcurementApprovedSupplierListEntriesAslId [KEY] | Long | The unique identifier for the approved supplier list entry, linking the entry to its corresponding supplier list. |
| AslId [KEY] | Long | The identifier for the approved supplier list entry within the ProcurementApprovedSupplierListEntriesDFF table. |
| _FLEX_Context | String | The FLEX context associated with the approved supplier list entry, providing information about the context in which the entry is being used or processed. |
| _FLEX_Context_DisplayValue | String | The prompt or display value for the FLEX context, providing a human-readable description of the context in which the entry is being used. |
| Finder | String | The function or mechanism used to search for approved supplier list entries, helping to retrieve specific entries based on search criteria. |
| EffectiveDate | Date | The date parameter used to filter and fetch resources that are effective as of the specified start date, ensuring data accuracy over time. |
Supports lookups of employees or individuals who can create or approve requisitions, ensuring authorized procurement actions.
| Name | Type | Description |
| PersonId [KEY] | Long | The unique identifier for the person in the ProcurementPersonsLOV table, linking to the individual within the procurement system. |
| DisplayName | String | The display name of the person in the ProcurementPersonsLOV table, typically presented in a 'First Name Last Name' format. |
| String | The email address of the person, used for communication within the procurement system. | |
| Job | String | The job title or role of the person within the procurement organization, describing their position or responsibilities. |
| Department | String | The department to which the person belongs within the procurement organization, indicating their area of expertise or responsibility. |
| PersonNumber | String | The unique employee number or identifier assigned to the person within the organization, used for internal tracking. |
| LocationId | Long | The unique identifier for the location where the person is based, linking them to a specific office or site within the organization. |
| Finder | String | The function or mechanism used to search for or retrieve person records in the ProcurementPersonsLOV table. |
| SearchTerm | String | A term or keyword used to search for persons within the ProcurementPersonsLOV, typically based on their attributes like name, job, or department. |
Represents items included in a publicly accessible shopping list, shared across multiple users or business units.
| Name | Type | Description |
| ProcurementBUId | Long | The unique identifier for the procurement business unit where the public shopping list is created, linking it to the respective business unit. |
| ProcurementBU | String | The name of the procurement business unit in which the public shopping list is created, indicating the specific business unit responsible for the list. |
| PublicShoppingListHeaderId | Long | The unique identifier for the public shopping list header, linking it to the overall shopping list. |
| PublicShoppingList | String | The name of the public shopping list, used to identify it in the procurement system. |
| PublicShoppingListDescription | String | A description of the public shopping list, providing additional details about its purpose or contents. |
| PublicShoppingListEndDate | Date | The end date when the public shopping list is no longer valid or accessible for new additions or updates. |
| PublicShoppingListStartDate | Date | The start date when the public shopping list becomes available or active for use. |
| PublicShoppingListLineId [KEY] | Long | The unique identifier for each line within the public shopping list, linking it to a specific item or service. |
| Sequence | Decimal | The order or position in which items appear on the public shopping list, determining how they are displayed to users. |
| LineType | String | The type of line, indicating whether the item on the public shopping list is a product or service. |
| ItemId | Long | The unique identifier for the item listed on the public shopping list line. |
| Item | String | The name or identifier of the item listed on the public shopping list line. |
| ItemRevision | String | The revision number or version of the item listed on the public shopping list line, showing any updates or changes. |
| ItemDescription | String | A description of the item listed on the public shopping list line, explaining what it is and its purpose. |
| CategoryName | String | The name of the category to which the item belongs on the public shopping list, organizing the list by item types. |
| CategoryId | String | The identifier for the category of the item on the public shopping list, used for organizational purposes. |
| SuggestedQuantity | Decimal | The quantity suggested by the catalog administrator for the item on the public shopping list, guiding the preparer or requester. |
| UOM | String | The unit of measure (for example, each, box, kg) used for the item quantity on the public shopping list. |
| Price | Decimal | The price of the item on the public shopping list line, typically in the currency of the buyer's organization. |
| CurrencyCode | String | The currency code representing the currency used for the item price on the public shopping list. |
| Amount | Decimal | The total amount for the item on the public shopping list line, calculated as price times quantity. |
| Supplier | String | The name of the supplier providing the item or service on the public shopping list. |
| SupplierItem | String | The item number or identifier assigned by the supplier for the item listed on the public shopping list. |
| AgreementLineId | Long | The unique identifier for the line of the source agreement associated with the public shopping list item. |
| Agreement | String | The number or code of the source agreement that the public shopping list item references. |
| AgreementLine | Decimal | The specific line number within the source agreement that corresponds to the item on the public shopping list. |
| Buyer | String | The name of the buyer responsible for procuring the item listed on the public shopping list. |
| NegotiatedFlag | Bool | Indicates whether the item price has been negotiated by the buyer (true) or is at standard pricing (false). |
| NegotiationRequiredFlag | Bool | Indicates whether negotiation is required before placing the item on a purchase order (true) or not (false). |
| CreatedBy | String | The name of the person or system that created the public shopping list line. |
| CreationDate | Datetime | The date and time when the public shopping list line was created. |
| LastUpdateDate | Datetime | The date and time when the public shopping list line was last updated. |
| LastUpdatedBy | String | The name of the person or system that last updated the public shopping list line. |
| InventoryOrganizationId | Long | The unique identifier for the inventory organization associated with the public shopping list line. |
| InventoryOrganization | String | The name of the inventory organization that is responsible for fulfilling the public shopping list item. |
| IndexSyncPendingFlag | Bool | Indicates whether the item on the public shopping list line is pending synchronization with the indexing system (true or false). |
| Finder | String | The function or mechanism used to search for or retrieve public shopping list lines, facilitating item discovery. |
| EffectiveDate | Date | The date parameter used to filter resources and fetch those that are effective as of this specified start date, ensuring accurate and timely data. |
Defines public shopping list headers, grouping related items for streamlined requisition or bulk purchasing.
| Name | Type | Description |
| PublicShoppingListHeaderId [KEY] | Long | The unique identifier for the header of the public shopping list, linking it to the overall shopping list structure. |
| PublicShoppingList | String | The name of the public shopping list, used to identify it within the procurement system. |
| ProcurementBUId | Long | The unique identifier for the procurement business unit that is responsible for creating the public shopping list. |
| ProcurementBU | String | The name of the procurement business unit where the public shopping list is created, indicating the business unit responsible for managing the list. |
| PublicShoppingListDescription | String | A detailed description of the public shopping list, explaining its purpose and contents. |
| PublicShoppingListEndDate | Date | The date and time when the public shopping list becomes inactive, indicating that no further modifications or additions can be made. |
| PublicShoppingListStartDate | Date | The date and time when the public shopping list becomes active, making it available for use and updates. |
| ImageURL | String | The URL that links to the image representing the public shopping list, typically used for visual identification. |
| CreatedBy | String | The name of the person or system that created the public shopping list. |
| CreationDate | Datetime | The date and time when the public shopping list was created. |
| LastUpdateDate | Datetime | The date and time when the public shopping list was last updated, indicating when changes were made. |
| LastUpdatedBy | String | The name of the person or system that last updated the public shopping list. |
| Finder | String | The function or mechanism used to search for or retrieve public shopping lists, assisting in the discovery of specific lists based on criteria. |
| SysEffectiveDate | String | The system's effective date, used to capture when the record is valid within the context of the system's operations. |
| EffectiveDate | Date | The date parameter used to filter and fetch resources that are effective as of this specified start date, ensuring accurate and timely data retrieval. |
Manages URL redirections for punchout catalogs, integrating external supplier catalogs into the procurement flow.
| Name | Type | Description |
| CatalogId [KEY] | Long | The unique identifier for the catalog associated with the punchout connection, linking it to a specific catalog in the system. |
| CatalogName | String | The name of the catalog associated with the punchout connection, used for identifying and managing the catalog. |
| PunchoutItemId [KEY] | Decimal | The unique identifier for the specific item within the catalog that is being connected through the punchout connection. |
| PunchoutRedirectionURL | String | The URL that redirects the user to the external punchout catalog, where they can view and select items for purchase. |
| Finder | String | The function or mechanism used to search for or retrieve punchout connections, allowing for quick access to the relevant connection records. |
| SourceApplication | String | The name of the source application initiating the punchout connection, indicating the system or platform from which the connection originates. |
Facilitates bulk import of procurement documents (for example, blanket purchase agreements), verifying and loading them into the system.
| Name | Type | Description |
| InterfaceHeaderId [KEY] | Long | The unique identifier for the interface header, linking the import request to the overall interface process. |
| InterfaceHeaderKey | String | The key that uniquely identifies the interface header, used for tracking and processing the request. |
| ActionCode | String | The code that identifies the action to be performed, such as create, update, or delete for the purchase agreement. |
| BatchId | Decimal | The unique identifier for the batch of import requests, used to group related transactions for processing. |
| ImportSource | String | The source application from which the purchase agreement document was imported, helping to trace the origin of the data. |
| ApprovalActionCode | String | Indicates whether the approval process should be bypassed during submission, affecting how the agreement is processed. |
| AgreementHeaderId | Long | The unique identifier for the purchase agreement header, linking the agreement to its details and related documents. |
| AgreementNumber | String | The number that uniquely identifies the purchase agreement within the sold-to legal entity, used for reference and tracking. |
| DocumentTypeCode | String | The code identifying the document type, typically associated with a change order template or other document types. |
| StyleId | Long | The identifier for the purchasing document style, allowing the organization to control the parameters and values displayed for purchasing documents. |
| Style | String | The name of the purchasing document style, which determines the layout and parameters used in the purchase agreement. |
| ProcurementBUId | Long | The unique identifier for the business unit responsible for managing and owning the purchasing document. |
| ProcurementBU | String | The name of the procurement business unit that owns and manages the purchase agreement. |
| BuyerId | Long | The unique identifier for the buyer responsible for managing the purchase agreement. |
| Buyer | String | The name of the person responsible for overseeing and managing the purchase agreement. |
| CurrencyCode | String | The code representing the currency used in the purchase agreement, ensuring proper financial transactions and conversions. |
| Description | String | A description for the line item in the purchase agreement, providing context or details for the items being purchased. |
| SupplierId | Long | The unique identifier for the supplier fulfilling the items or services on the purchase agreement. |
| Supplier | String | The name of the supplier who provides the goods or services specified in the purchase agreement. |
| SupplierSiteId | Long | The unique identifier for the location or site from which the supplier fulfills the purchase agreement. |
| SupplierSite | String | The name or identifier of the location from where the supplier provides the goods or services. |
| SupplierContactId | Long | The unique identifier for the contact person at the supplier organization. |
| SupplierContact | String | The name of the person representing the supplier for communication regarding the purchase agreement. |
| FOB | String | Freight On Board location, which indicates where ownership of the item transfers from the supplier to the buyer. |
| CarrierId | Long | The unique identifier for the carrier company responsible for transporting the item from the supplier to the buyer. |
| Carrier | String | The name of the company responsible for the transportation of the items specified in the purchase agreement. |
| FreightTerms | String | The terms that describe the responsibility for paying freight charges, determining who covers the cost of transportation. |
| PayOnReceiptFlag | Bool | Indicates whether payment for the purchase order is due upon receipt of the goods (true) or at a later time (false). |
| PaymentTermsId | Long | The unique identifier for the payment terms associated with the purchase agreement, specifying when payments are due. |
| PaymentTerms | String | The terms under which payments are scheduled, including due dates, discounts, and other relevant payment conditions. |
| ChangeOrderDescription | String | A description of any changes made to the purchase agreement, often used for modifications or amendments. |
| ChangeOrderInitiatingParty | String | The role of the user who initiated the change order, indicating who proposed or requested the modification. |
| RequiredAcknowledgmentCode | String | Indicates whether a supplier acknowledgment is required for the document, and if so, specifies the level of acknowledgment needed. |
| SupplierOrder | String | The supplier's order number, which may be referenced for cross-checking or communication purposes. |
| AcknowledgmentWithinDays | Decimal | The number of days within which the supplier must decide whether to accept or reject the purchase order or agreement. |
| SupplierCommunicationMethodCode | String | The code identifying the method of communication to be used with the supplier, such as email, fax, or phone. |
| SupplierFax | String | The fax number to which the purchase agreement will be communicated after approval, if applicable. |
| SupplierEmailAddress | String | The email address to which the purchase agreement will be communicated after approval, for faster processing. |
| ConfirmingOrderFlag | Bool | Indicates whether the document is confirming an order the supplier may already be aware of, providing clarity on the status of the order. |
| AgreementAmount | Decimal | The total amount agreed upon for a line in the purchase agreement, specifying the monetary value of the agreement. |
| AmountLimit | Decimal | The amount limit on the agreement, beyond which additional releases or orders cannot be created. |
| MinimumReleaseAmount | Decimal | The minimum amount that can be released for a blanket or planned purchase order under the terms of the agreement. |
| StartDate | Date | The date when the purchase agreement becomes effective, marking the beginning of its validity. |
| EndDate | Date | The expiration date after which the purchase agreement is no longer valid for new orders or releases. |
| NoteToSupplier | String | A note or instruction to the supplier, providing additional context or details for the supplier's action. |
| NoteToReceiver | String | Special instructions for the receiver, typically used for guidance during the receipt and inspection process. |
| AutomaticallyGenerateOrdersFlag | Bool | Indicates whether purchase orders should be automatically created for requisition lines referencing the agreement. |
| AutomaticallySubmitForApprovalFlag | Bool | Indicates whether the document should be automatically submitted for approval upon creation. |
| GroupRequisitionsFlag | Bool | Indicates whether requisition lines from different requisitions referencing the same agreement line should be grouped together when creating an order. |
| GroupRequisitionLinesFlag | Bool | Indicates whether requisition lines referencing the same agreement line should be grouped together when creating an order. |
| UseShipToOrganizationAndLocationFlag | Bool | Indicates whether item descriptions can be updated on document lines, allowing changes to item details as necessary. |
| UseNeedByDateFlag | Bool | Indicates whether the 'need by' date specified on requisition lines should be used when grouping requisitions for order creation. |
| CatalogAdministratorAuthoringFlag | Bool | Indicates whether the catalog administrator has authorization to author or make changes to the purchase agreement. |
| ApplyPriceUpdatesToExistingOrdersFlag | Bool | Indicates whether retroactive price updates should only affect open, unfulfilled orders that reference the agreement. |
| CommunicatePriceUpdatesFlag | Bool | Indicates whether repriced orders due to price changes on the agreement should be communicated to the supplier. |
| BuyerEmailAddress | String | The email address of the buyer, used for communication and correspondence related to the purchase agreement. |
| ModeOfTransportCode | String | The code representing the mode of transportation used to ship the goods, such as air, sea, or land. |
| ModeOfTransport | String | The specific mode of transport, such as truck, air, or boat, used to deliver the item from supplier to buyer. |
| ServiceLevelCode | String | The code identifying the priority level of transportation, determining how quickly the goods are shipped. |
| ServiceLevel | String | The service level indicating how quickly goods need to be transported, such as standard or expedited. |
| AgingOnsetPointCode | String | The code that identifies the agreed-upon point when consigned materials begin to age, such as upon receipt or shipment. |
| AgingPeriodDays | Int | The maximum number of days that consigned material may be kept before it is considered aged and may require action. |
| ConsumptionAdviceFrequencyCode | String | The frequency with which consumption advice for consigned inventory will be generated, such as daily, weekly, or monthly. |
| ConsumptionAdviceSummaryCode | String | The summary level for consumption advice frequency, helping determine how often consumption data is communicated to the supplier. |
| DefaultConsignmentLinesFlag | Bool | Indicates whether consignment lines are included in the blanket purchase agreement and related purchase orders. Default is false. |
| PayOnUseFlag | Bool | Indicates whether invoices should be generated automatically when supplier-owned material stocked in the buyer's location is consumed. |
| BillingCycleClosingDate | Date | The date that marks the end of the current billing period for the purchase agreement. |
| ConfigurationOrderingEnabledFlag | Bool | Indicates whether the agreement supports ordering configurations, allowing the purchase of model items and their options. |
| UseCustomerSalesOrderFlag | Bool | Indicates whether requisition lines should be grouped by sales order number to create distinct purchase orders. |
| BuyerManagedTransportFlag | Bool | Indicates whether the buyer is responsible for arranging transportation, from pickup to delivery. |
| AllowOrderingFromUnassignedSitesFlag | Bool | Indicates whether the agreement allows orders from supplier sites that are not listed as approved purchasing sites. |
| OutsideProcessEnabledFlag | Bool | Indicates whether the document style allows for outside processing, such as external work or services not performed by the supplier. |
| MasterContractNumber | String | The number that identifies the associated enterprise contract for the purchase agreement. |
| MasterContractId | Long | The unique identifier for the master contract associated with the purchase agreement. |
| MasterContractTypeId | Long | The unique identifier for the type of master contract associated with the purchase agreement. |
| MasterContractType | String | The classification of the master contract that determines contract functionality, including terms and conditions. |
| UseOrderDateForOrderPricingFlag | Bool | Indicates whether the order date should be used for pricing when creating orders referencing the agreement. |
| AttributeCategory | String | The category segment for the purchase agreement header's descriptive flexfield, allowing additional data customization. |
| Attribute1 | String | Custom segment for additional information within the purchase agreement header's descriptive flexfield. |
| Attribute2 | String | Custom segment for additional information within the purchase agreement header's descriptive flexfield. |
| Attribute3 | String | Custom segment for additional information within the purchase agreement header's descriptive flexfield. |
| Attribute4 | String | Custom segment for additional information within the purchase agreement header's descriptive flexfield. |
| Attribute5 | String | Custom segment for additional information within the purchase agreement header's descriptive flexfield. |
| Attribute6 | String | Custom segment for additional information within the purchase agreement header's descriptive flexfield. |
| Attribute7 | String | Custom segment for additional information within the purchase agreement header's descriptive flexfield. |
| Attribute8 | String | Custom segment for additional information within the purchase agreement header's descriptive flexfield. |
| Attribute9 | String | Custom segment for additional information within the purchase agreement header's descriptive flexfield. |
| Attribute10 | String | Custom segment for additional information within the purchase agreement header's descriptive flexfield. |
| Attribute11 | String | Custom segment for additional information within the purchase agreement header's descriptive flexfield. |
| Attribute12 | String | Custom segment for additional information within the purchase agreement header's descriptive flexfield. |
| Attribute13 | String | Custom segment for additional information within the purchase agreement header's descriptive flexfield. |
| Attribute14 | String | Custom segment for additional information within the purchase agreement header's descriptive flexfield. |
| Attribute15 | String | Custom segment for additional information within the purchase agreement header's descriptive flexfield. |
| Attribute16 | String | Custom segment for additional information within the purchase agreement header's descriptive flexfield. |
| Attribute17 | String | Custom segment for additional information within the purchase agreement header's descriptive flexfield. |
| Attribute18 | String | Custom segment for additional information within the purchase agreement header's descriptive flexfield. |
| Attribute19 | String | Custom segment for additional information within the purchase agreement header's descriptive flexfield. |
| Attribute20 | String | Custom segment for additional information within the purchase agreement header's descriptive flexfield. |
| AttributeDate1 | Date | Custom date segment for the purchase agreement header's descriptive flexfield. |
| AttributeDate2 | Date | Custom date segment for the purchase agreement header's descriptive flexfield. |
| AttributeDate3 | Date | Custom date segment for the purchase agreement header's descriptive flexfield. |
| AttributeDate4 | Date | Custom date segment for the purchase agreement header's descriptive flexfield. |
| AttributeDate5 | Date | Custom date segment for the purchase agreement header's descriptive flexfield. |
| AttributeDate6 | Date | Custom date segment for the purchase agreement header's descriptive flexfield. |
| AttributeDate7 | Date | Custom date segment for the purchase agreement header's descriptive flexfield. |
| AttributeDate8 | Date | Custom date segment for the purchase agreement header's descriptive flexfield. |
| AttributeDate9 | Date | Custom date segment for the purchase agreement header's descriptive flexfield. |
| AttributeDate10 | Date | Custom date segment for the purchase agreement header's descriptive flexfield. |
| AttributeNumber1 | Decimal | Custom number segment for the purchase agreement header's descriptive flexfield. |
| AttributeNumber2 | Decimal | Custom number segment for the purchase agreement header's descriptive flexfield. |
| AttributeNumber3 | Decimal | Custom number segment for the purchase agreement header's descriptive flexfield. |
| AttributeNumber4 | Decimal | Custom number segment for the purchase agreement header's descriptive flexfield. |
| AttributeNumber5 | Decimal | Custom number segment for the purchase agreement header's descriptive flexfield. |
| AttributeNumber6 | Decimal | Custom number segment for the purchase agreement header's descriptive flexfield. |
| AttributeNumber7 | Decimal | Custom number segment for the purchase agreement header's descriptive flexfield. |
| AttributeNumber8 | Decimal | Custom number segment for the purchase agreement header's descriptive flexfield. |
| AttributeNumber9 | Decimal | Custom number segment for the purchase agreement header's descriptive flexfield. |
| AttributeNumber10 | Decimal | Custom number segment for the purchase agreement header's descriptive flexfield. |
| AttributeTimestamp1 | Datetime | Custom timestamp segment for the purchase agreement header's descriptive flexfield. |
| AttributeTimestamp2 | Datetime | Custom timestamp segment for the purchase agreement header's descriptive flexfield. |
| AttributeTimestamp3 | Datetime | Custom timestamp segment for the purchase agreement header's descriptive flexfield. |
| AttributeTimestamp4 | Datetime | Custom timestamp segment for the purchase agreement header's descriptive flexfield. |
| AttributeTimestamp5 | Datetime | Custom timestamp segment for the purchase agreement header's descriptive flexfield. |
| AttributeTimestamp6 | Datetime | Custom timestamp segment for the purchase agreement header's descriptive flexfield. |
| AttributeTimestamp7 | Datetime | Custom timestamp segment for the purchase agreement header's descriptive flexfield. |
| AttributeTimestamp8 | Datetime | Custom timestamp segment for the purchase agreement header's descriptive flexfield. |
| AttributeTimestamp9 | Datetime | Custom timestamp segment for the purchase agreement header's descriptive flexfield. |
| AttributeTimestamp10 | Datetime | Custom timestamp segment for the purchase agreement header's descriptive flexfield. |
| CreatedBy | String | The name of the person or system that created the purchase agreement import request. |
| CreationDate | Datetime | The date and time when the purchase agreement import request was created. |
| LastUpdatedBy | String | The name of the person or system that last updated the purchase agreement import request. |
| LastUpdateDate | Datetime | The date and time when the purchase agreement import request was last updated. |
| ProcessCode | String | The code identifying the processing method for the import request, indicating how the request should be handled. |
| RequestId | Long | The unique identifier for the purchase agreement import request, used for tracking and processing. |
| Finder | String | The function or mechanism used to search for or retrieve purchase agreement import requests. |
Defines which requisitioning business units can leverage an imported purchase agreement, enabling multi-BU procurement sharing.
| Name | Type | Description |
| PurchaseAgreementImportRequestsInterfaceHeaderId [KEY] | Long | The unique identifier for the interface header related to the purchase agreement import request business unit access assignment. |
| InterfaceBUAssignmentId [KEY] | Long | The unique identifier for the business unit access assignment associated with the purchase agreement import request. |
| InterfaceHeaderId | Long | The unique identifier for the interface header that links the business unit access assignment to the overall agreement. |
| InterfaceHeaderKey | String | A key that uniquely identifies the interface header for the business unit access assignment, used for tracking and processing. |
| InterfaceBUAssignmentKey | String | A key that uniquely identifies the business unit access assignment for the purchase agreement, used for referencing specific assignments. |
| RequisitioningBUId | Long | The unique identifier for the business unit that made the requisition, requesting the goods or services specified in the purchase agreement. |
| RequisitioningBU | String | The name of the business unit that created the requisition for the purchase order, initiating the request for goods or services. |
| OrderLocallyFlag | Bool | Indicates whether the order should be routed to local supplier sites maintained by the client. 'True' means the order will be routed to local sites, while 'False' means it won't. |
| PurchasingSiteId | Long | The unique identifier for the supplier site that handles the purchasing operating unit for the agreement. |
| PurchasingSite | String | The name or identifier of the supplier site where the purchase order is managed and processed within the purchasing operating unit. |
| ShipToLocationId | Long | The unique identifier for the location where the supplier is instructed to ship the items from the purchase agreement. |
| ShipToLocation | String | The name of the location where the supplier ships the items specified in the purchase agreement, such as a warehouse or store. |
| BillToBUId | Long | The unique identifier for the business unit responsible for processing supplier invoices related to the purchase order. |
| BillToBU | String | The name of the business unit that processes the supplier invoices for the purchasing document, ensuring timely payment. |
| BillToLocationId | Long | The unique identifier for the location where the supplier should send the invoice for payment. |
| BillToLocation | String | The name or identifier of the bill-to location where the supplier sends invoices for processing and payment. |
| EnabledFlag | Bool | Indicates whether the business unit assignment for the purchase agreement is enabled ('True') or disabled ('False'). |
| CreatedBy | String | The name of the person or system that created the business unit access assignment for the purchase agreement. |
| CreationDate | Datetime | The date and time when the business unit access assignment for the purchase agreement was created. |
| LastUpdatedBy | String | The name of the person or system that last updated the business unit access assignment for the purchase agreement. |
| LastUpdateDate | Datetime | The date and time when the business unit access assignment for the purchase agreement was last updated. |
| ProcessCode | String | A code that identifies the process or action that is being executed for the business unit access assignment. |
| Finder | String | The function or mechanism used to search for or retrieve business unit access assignments for purchase agreement import requests. |
Specifies goods or services from the imported agreement, listing line details without delivery schedules or discrete distributions.
| Name | Type | Description |
| PurchaseAgreementImportRequestsInterfaceHeaderId [KEY] | Long | The unique identifier for the interface header related to the purchase agreement import request lines. |
| InterfaceLineId [KEY] | Long | The unique identifier for the interface line, used to distinguish individual line items within the purchase agreement import request. |
| InterfaceHeaderKey | String | A key that uniquely identifies the header record, providing a reference for the load request to track the import. |
| InterfaceLineKey | String | A key that uniquely identifies the interface line, enabling precise tracking and management of individual line items. |
| ActionCode | String | Indicates the action to be performed on the record, such as create or update, based on the provided data. |
| LineNumber | Decimal | The unique identifier for the purchase order or agreement line, typically used to reference and order line items within the agreement. |
| LineType | String | The type of line on the purchasing document, distinguishing between product, service, or other categories. |
| LineTypeId | Long | The unique identifier for the line type, enabling specific classification of line items within the purchase agreement. |
| Item | String | The abbreviation or code that uniquely identifies the item listed on the purchase order or agreement line. |
| ItemId | Long | The unique identifier for the item on the purchase agreement, linking the line item to its catalog or database entry. |
| ItemRevision | String | The revision number or version of the item, identifying the specific iteration or update of the product listed on the agreement line. |
| Category | String | The category to which the item belongs, helping to organize and classify items within the purchase agreement. |
| CategoryId | Long | The unique identifier for the purchasing category associated with the line item, facilitating item classification and tracking. |
| ItemDescription | String | A detailed description of the item on the agreement line, providing additional context or specifications for the purchase. |
| AgreementAmount | Decimal | The agreed-upon amount for the line item in the purchase agreement, specifying the monetary value of the purchase. |
| UOM | String | The abbreviation for the unit of measure used on the agreement line, such as 'each,' 'box,' or 'kg.' |
| UOMCode | String | The code representing the unit of measure, used for consistency in the purchase order and agreement lines. |
| Price | Decimal | The unit price for the line item, indicating how much each item costs based on the purchase agreement terms. |
| Amount | Decimal | The total value of the line item on the agreement, typically calculated as price multiplied by quantity. |
| AllowPriceOverrideFlag | Bool | Indicates whether the price on release shipments can be overridden by the buyer. 'True' allows overrides, while 'False' prevents them. |
| NotToExceedPrice | Decimal | The maximum price allowed for the line item, ensuring that the price for a release shipment doesn't exceed this limit. |
| SupplierItem | String | The supplier's unique item number, used to cross-reference the item in the supplier's catalog or inventory. |
| NegotiatedFlag | Bool | Indicates whether the price was negotiated between the buyer and supplier before the purchase. 'True' means negotiated, 'False' means not negotiated. |
| NoteToReceiver | String | Special instructions provided to the receiver of the items, offering guidance on how to handle the goods during receipt. |
| NoteToSupplier | String | A note directed to the supplier, often providing instructions or additional details about the order or requirements. |
| MinimumReleaseAmount | Decimal | The minimum amount that can be released for a blanket or planned purchase order, ensuring that minimum purchase thresholds are met. |
| SupplierPartAuxiliaryId | String | An identifier used to cross-reference the item with additional supplier-specific data, such as auxiliary parts or components. |
| SupplierReferenceNumber | String | A reference number used by the supplier to identify related models, options, or submodels associated with the item. |
| AgingPeriodDays | Int | The maximum number of days the material can remain on consignment before it is considered aged, requiring action from the buyer or supplier. |
| ConsignmentLineFlag | Bool | Indicates whether the agreement includes consignment lines. 'True' means consignment lines are included in the blanket purchase agreement and the purchase order. 'False' (the default) means they are not. |
| UnitWeight | Decimal | The weight of one unit of the item, used for shipping and inventory management. |
| WeightUOMCode | String | The code representing the unit of measure for the weight, such as 'kg' or 'lbs.' |
| WeightUOMName | String | The name of the unit of measure for the weight, providing a readable format for understanding the weight of items. |
| UnitVolume | Decimal | The volume of one unit of the item, often used for shipping and storage calculations. |
| VolumeUOMCode | String | The code that identifies the unit of measure for the volume, such as 'm3' or 'liters.' |
| VolumeUOMName | String | The name of the unit of measure for volume, providing a human-readable format for understanding the item’s volume. |
| ParentItem | String | The identifier for the parent item or option class associated with the line item, often used for configurable products or product families. |
| ParentItemId | Long | The unique identifier for the parent item or model, linking the line item to its parent product in the catalog. |
| TopModel | String | The identifier for the top model associated with the option class or submodel, often used for high-level product categorization. |
| TopModelId | Long | The unique identifier for the top model, used to connect the item to its broader product family or model grouping. |
| SupplierParentItem | String | The supplier’s identification number for the option class or model associated with the item. |
| SupplierTopModel | String | The supplier’s identifier for the top model related to the option class or submodel of the item. |
| PriceBreakType | String | The type of pricing scheme applied to the price breaks for this line item, specifying how discounts or price tiers are structured. |
| AllowDescriptionUpdateFlag | Bool | Indicates whether the description of the item can be updated on document lines. 'True' allows updates, 'False' prevents them. |
| AttributeCategory | String | The category segment for the purchase agreement line's descriptive flexfield, allowing for custom data fields to be added. |
| LineAttribute1 | String | Custom data field for the purchase agreement line's descriptive flexfield, allowing for additional line-specific details. |
| LineAttribute2 | String | Custom data field for the purchase agreement line's descriptive flexfield. |
| LineAttribute3 | String | Custom data field for the purchase agreement line's descriptive flexfield. |
| LineAttribute4 | String | Custom data field for the purchase agreement line's descriptive flexfield. |
| LineAttribute5 | String | Custom data field for the purchase agreement line's descriptive flexfield. |
| LineAttribute6 | String | Custom data field for the purchase agreement line's descriptive flexfield. |
| LineAttribute7 | String | Custom data field for the purchase agreement line's descriptive flexfield. |
| LineAttribute8 | String | Custom data field for the purchase agreement line's descriptive flexfield. |
| LineAttribute9 | String | Custom data field for the purchase agreement line's descriptive flexfield. |
| LineAttribute10 | String | Custom data field for the purchase agreement line's descriptive flexfield. |
| LineAttribute11 | String | Custom data field for the purchase agreement line's descriptive flexfield. |
| LineAttribute12 | String | Custom data field for the purchase agreement line's descriptive flexfield. |
| LineAttribute13 | String | Custom data field for the purchase agreement line's descriptive flexfield. |
| LineAttribute14 | String | Custom data field for the purchase agreement line's descriptive flexfield. |
| LineAttribute15 | String | Custom data field for the purchase agreement line's descriptive flexfield. |
| Attribute16 | String | Custom data field for the purchase agreement line's descriptive flexfield. |
| Attribute17 | String | Custom data field for the purchase agreement line's descriptive flexfield. |
| Attribute18 | String | Custom data field for the purchase agreement line's descriptive flexfield. |
| Attribute19 | String | Custom data field for the purchase agreement line's descriptive flexfield. |
| Attribute20 | String | Custom data field for the purchase agreement line's descriptive flexfield. |
| AttributeDate1 | Date | Date segment for the purchase agreement line's descriptive flexfield. |
| AttributeDate2 | Date | Date segment for the purchase agreement line's descriptive flexfield. |
| AttributeDate3 | Date | Date segment for the purchase agreement line's descriptive flexfield. |
| AttributeDate4 | Date | Date segment for the purchase agreement line's descriptive flexfield. |
| AttributeDate5 | Date | Date segment for the purchase agreement line's descriptive flexfield. |
| AttributeDate6 | Date | Date segment for the purchase agreement line's descriptive flexfield. |
| AttributeDate7 | Date | Date segment for the purchase agreement line's descriptive flexfield. |
| AttributeDate8 | Date | Date segment for the purchase agreement line's descriptive flexfield. |
| AttributeDate9 | Date | Date segment for the purchase agreement line's descriptive flexfield. |
| AttributeDate10 | Date | Date segment for the purchase agreement line's descriptive flexfield. |
| AttributeNumber1 | Decimal | Number segment for the purchase agreement line's descriptive flexfield. |
| AttributeNumber2 | Decimal | Number segment for the purchase agreement line's descriptive flexfield. |
| AttributeNumber3 | Decimal | Number segment for the purchase agreement line's descriptive flexfield. |
| AttributeNumber4 | Decimal | Number segment for the purchase agreement line's descriptive flexfield. |
| AttributeNumber5 | Decimal | Number segment for the purchase agreement line's descriptive flexfield. |
| AttributeNumber6 | Decimal | Number segment for the purchase agreement line's descriptive flexfield. |
| AttributeNumber7 | Decimal | Number segment for the purchase agreement line's descriptive flexfield. |
| AttributeNumber8 | Decimal | Number segment for the purchase agreement line's descriptive flexfield. |
| AttributeNumber9 | Decimal | Number segment for the purchase agreement line's descriptive flexfield. |
| AttributeNumber10 | Decimal | Number segment for the purchase agreement line's descriptive flexfield. |
| AttributeTimestamp1 | Datetime | Timestamp segment for the purchase agreement line's descriptive flexfield. |
| AttributeTimestamp2 | Datetime | Timestamp segment for the purchase agreement line's descriptive flexfield. |
| AttributeTimestamp3 | Datetime | Timestamp segment for the purchase agreement line's descriptive flexfield. |
| AttributeTimestamp4 | Datetime | Timestamp segment for the purchase agreement line's descriptive flexfield. |
| AttributeTimestamp5 | Datetime | Timestamp segment for the purchase agreement line's descriptive flexfield. |
| AttributeTimestamp6 | Datetime | Timestamp segment for the purchase agreement line's descriptive flexfield. |
| AttributeTimestamp7 | Datetime | Timestamp segment for the purchase agreement line's descriptive flexfield. |
| AttributeTimestamp8 | Datetime | Timestamp segment for the purchase agreement line's descriptive flexfield. |
| AttributeTimestamp9 | Datetime | Timestamp segment for the purchase agreement line's descriptive flexfield. |
| AttributeTimestamp10 | Datetime | Timestamp segment for the purchase agreement line's descriptive flexfield. |
| InterfaceHeaderId | Long | The unique identifier for the interface header linked to the purchase agreement import request lines. |
| CreatedBy | String | The name of the person or system that created the purchase agreement import request line. |
| CreationDate | Datetime | The date and time when the purchase agreement import request line was created. |
| LastUpdatedBy | String | The name of the person or system that last updated the purchase agreement import request line. |
| LastUpdateDate | Datetime | The date and time when the purchase agreement import request line was last updated. |
| ProcessCode | String | The code identifying the process or action being performed on the purchase agreement import request line. |
| ExpirationDate | Date | The date after which the item on this line can no longer be ordered, marking the expiration of the agreement for that item. |
| AgreementQuantity | Decimal | The total quantity agreed upon for the item or line in the purchase agreement. |
| Finder | String | The search function used to retrieve or filter purchase agreement import request lines based on specific criteria. |
Captures extended item data, like manufacturer part numbers or supplier URLs, during purchase agreement imports.
| Name | Type | Description |
| PurchaseAgreementImportRequestsInterfaceHeaderId [KEY] | Long | The unique identifier for the interface header related to the purchase agreement import request item attributes. |
| LinesInterfaceLineId [KEY] | Long | The unique identifier for the interface line associated with the purchase agreement import request item attributes. |
| InterfaceAttributeId [KEY] | Long | The unique identifier for the interface line item attribute, linking it to a specific attribute of an item on the agreement. |
| InterfaceLineId | Long | The unique identifier for the interface line related to the item attribute, helping to track individual line items in the purchase agreement. |
| InterfaceHeaderId | Long | The unique identifier for the interface header, which contains details of the entire purchase agreement import request. |
| InterfaceLineKey | String | A key that uniquely identifies the interface line for the item attribute, allowing precise tracking of item-specific data. |
| InterfaceAttributeKey | String | A key that uniquely identifies the interface line item attribute, providing a reference to the specific attribute for the item. |
| ThumbnailImageURL | String | The URL location for the small version of a larger image file associated with the item on the purchase agreement, often used for quick previews. |
| ImageURL | String | The URL of the full-sized image file associated with the item listed on the purchase agreement line, typically used for detailed item visuals. |
| ManufacturerPartNumber | String | The part number used by the manufacturer to identify the item specified on the blanket purchase agreement line, allowing cross-referencing with the manufacturer's catalog. |
| RoundingFactor | Decimal | An attribute indicating how to round the quantity on requisition orders when converting between different units of measure for the item. |
| Availability | String | The current availability status of the item from the supplier, indicating whether the item is in stock, out of stock, or on backorder. |
| LeadTime | Decimal | The number of days required for the item, specified on the blanket purchase agreement, to be delivered after an order is placed. |
| UNSPSC | String | The United Nations Standard Products and Services Code (UNSPSC) for the item, used for classification and categorization of products and services. |
| AttachmentURL | String | The URL for any attachment associated with the item, providing additional documentation or resources related to the item on the purchase agreement. |
| SupplierURL | String | The URL for the supplier's organization, providing a link to their website for additional product information or support. |
| ManufacturerURL | String | The URL for the manufacturer of the item, used to link to the manufacturer's website for further details about the item or its specifications. |
| PackagingString | String | A string describing how the item is packaged by the supplier, providing context for shipping and handling requirements. |
| AttributeCategory | String | The category segment for the purchase agreement item attributes descriptive flexfield, allowing custom attributes for better classification. |
| Attribute1 | String | Custom segment for additional descriptive information within the purchase agreement line item attributes flexfield. |
| Attribute2 | String | Custom segment for additional descriptive information within the purchase agreement line item attributes flexfield. |
| Attribute3 | String | Custom segment for additional descriptive information within the purchase agreement line item attributes flexfield. |
| Attribute4 | String | Custom segment for additional descriptive information within the purchase agreement line item attributes flexfield. |
| Attribute5 | String | Custom segment for additional descriptive information within the purchase agreement line item attributes flexfield. |
| Attribute6 | String | Custom segment for additional descriptive information within the purchase agreement line item attributes flexfield. |
| Attribute7 | String | Custom segment for additional descriptive information within the purchase agreement line item attributes flexfield. |
| Attribute8 | String | Custom segment for additional descriptive information within the purchase agreement line item attributes flexfield. |
| Attribute9 | String | Custom segment for additional descriptive information within the purchase agreement line item attributes flexfield. |
| Attribute10 | String | Custom segment for additional descriptive information within the purchase agreement line item attributes flexfield. |
| Attribute11 | String | Custom segment for additional descriptive information within the purchase agreement line item attributes flexfield. |
| Attribute12 | String | Custom segment for additional descriptive information within the purchase agreement line item attributes flexfield. |
| Attribute13 | String | Custom segment for additional descriptive information within the purchase agreement line item attributes flexfield. |
| Attribute14 | String | Custom segment for additional descriptive information within the purchase agreement line item attributes flexfield. |
| Attribute15 | String | Custom segment for additional descriptive information within the purchase agreement line item attributes flexfield. |
| Attribute16 | String | Custom segment for additional descriptive information within the purchase agreement line item attributes flexfield. |
| Attribute17 | String | Custom segment for additional descriptive information within the purchase agreement line item attributes flexfield. |
| Attribute18 | String | Custom segment for additional descriptive information within the purchase agreement line item attributes flexfield. |
| Attribute19 | String | Custom segment for additional descriptive information within the purchase agreement line item attributes flexfield. |
| Attribute20 | String | Custom segment for additional descriptive information within the purchase agreement line item attributes flexfield. |
| AttributeDate1 | Date | Date segment for the purchase agreement item attributes descriptive flexfield, providing specific date information related to the item. |
| AttributeDate10 | Date | Date segment for the purchase agreement item attributes descriptive flexfield, providing specific date information related to the item. |
| AttributeDate2 | Date | Date segment for the purchase agreement item attributes descriptive flexfield, providing specific date information related to the item. |
| AttributeDate3 | Date | Date segment for the purchase agreement item attributes descriptive flexfield, providing specific date information related to the item. |
| AttributeDate4 | Date | Date segment for the purchase agreement item attributes descriptive flexfield, providing specific date information related to the item. |
| AttributeDate5 | Date | Date segment for the purchase agreement item attributes descriptive flexfield, providing specific date information related to the item. |
| AttributeDate6 | Date | Date segment for the purchase agreement item attributes descriptive flexfield, providing specific date information related to the item. |
| AttributeDate7 | Date | Date segment for the purchase agreement item attributes descriptive flexfield, providing specific date information related to the item. |
| AttributeDate8 | Date | Date segment for the purchase agreement item attributes descriptive flexfield, providing specific date information related to the item. |
| AttributeDate9 | Date | Date segment for the purchase agreement item attributes descriptive flexfield, providing specific date information related to the item. |
| AttributeNumber1 | Decimal | Number segment for the purchase agreement item attributes descriptive flexfield, allowing for numerical values to be assigned to attributes. |
| AttributeNumber10 | Decimal | Number segment for the purchase agreement item attributes descriptive flexfield, allowing for numerical values to be assigned to attributes. |
| AttributeNumber2 | Decimal | Number segment for the purchase agreement item attributes descriptive flexfield, allowing for numerical values to be assigned to attributes. |
| AttributeNumber3 | Decimal | Number segment for the purchase agreement item attributes descriptive flexfield, allowing for numerical values to be assigned to attributes. |
| AttributeNumber4 | Decimal | Number segment for the purchase agreement item attributes descriptive flexfield, allowing for numerical values to be assigned to attributes. |
| AttributeNumber5 | Decimal | Number segment for the purchase agreement item attributes descriptive flexfield, allowing for numerical values to be assigned to attributes. |
| AttributeNumber6 | Decimal | Number segment for the purchase agreement item attributes descriptive flexfield, allowing for numerical values to be assigned to attributes. |
| AttributeNumber7 | Decimal | Number segment for the purchase agreement item attributes descriptive flexfield, allowing for numerical values to be assigned to attributes. |
| AttributeNumber8 | Decimal | Number segment for the purchase agreement item attributes descriptive flexfield, allowing for numerical values to be assigned to attributes. |
| AttributeNumber9 | Decimal | Number segment for the purchase agreement item attributes descriptive flexfield, allowing for numerical values to be assigned to attributes. |
| AttributeTimestamp1 | Datetime | Timestamp segment for the purchase agreement item attributes descriptive flexfield, allowing for date and time information related to the item. |
| AttributeTimestamp10 | Datetime | Timestamp segment for the purchase agreement item attributes descriptive flexfield, allowing for date and time information related to the item. |
| AttributeTimestamp2 | Datetime | Timestamp segment for the purchase agreement item attributes descriptive flexfield, allowing for date and time information related to the item. |
| AttributeTimestamp3 | Datetime | Timestamp segment for the purchase agreement item attributes descriptive flexfield, allowing for date and time information related to the item. |
| AttributeTimestamp4 | Datetime | Timestamp segment for the purchase agreement item attributes descriptive flexfield, allowing for date and time information related to the item. |
| AttributeTimestamp5 | Datetime | Timestamp segment for the purchase agreement item attributes descriptive flexfield, allowing for date and time information related to the item. |
| AttributeTimestamp6 | Datetime | Timestamp segment for the purchase agreement item attributes descriptive flexfield, allowing for date and time information related to the item. |
| AttributeTimestamp7 | Datetime | Timestamp segment for the purchase agreement item attributes descriptive flexfield, allowing for date and time information related to the item. |
| AttributeTimestamp8 | Datetime | Timestamp segment for the purchase agreement item attributes descriptive flexfield, allowing for date and time information related to the item. |
| AttributeTimestamp9 | Datetime | Timestamp segment for the purchase agreement item attributes descriptive flexfield, allowing for date and time information related to the item. |
| CreatedBy | String | The name of the person or system that created the purchase agreement import request item attribute. |
| CreationDate | Datetime | The date and time when the purchase agreement import request item attribute was created. |
| LastUpdatedBy | String | The name of the person or system that last updated the purchase agreement import request item attribute. |
| LastUpdateDate | Datetime | The date and time when the purchase agreement import request item attribute was last updated. |
| ProcessCode | String | The code identifying the process or action being executed for the purchase agreement import request item attribute. |
| Finder | String | The search function used to retrieve or filter purchase agreement import request item attributes based on specific criteria. |
Handles bulk or location-based pricing discounts in imported agreements, detailing cost variations for different purchase conditions.
| Name | Type | Description |
| PurchaseAgreementImportRequestsInterfaceHeaderId [KEY] | Long | The unique identifier for the interface header related to the purchase agreement import request price breaks. |
| LinesInterfaceLineId [KEY] | Long | The unique identifier for the interface line associated with the price break of the purchase agreement. |
| InterfaceLineLocationId [KEY] | Long | The unique identifier for the agreement line's interface price break, linking it to the specific location of the price break. |
| InterfaceLineKey | String | The key that uniquely identifies the agreement line's interface price break, providing a reference for processing the price break data. |
| InterfaceLineLocationKey | String | A unique identifier for the price break record, used to track and manage the specific price break for the load request. |
| PriceBreakNumber | Decimal | The number that uniquely identifies the price break for the line item, helping to distinguish between multiple price breaks on the same line. |
| ShipToLocation | String | The name of the location where the supplier ships the item, providing context for logistics and shipping. |
| ShipToLocationId | Long | The unique identifier for the location where the supplier is instructed to ship the item specified on the purchase agreement. |
| ShipToOrganizationCode | String | The name of the inventory organization that receives the item, specifying where the goods should be sent within the organization. |
| ShipToOrganizationId | Long | The unique identifier for the organization responsible for receiving the shipment, distinguishing between different locations or entities. |
| Quantity | Decimal | The quantity of items that triggers the price break, indicating when the price reduction becomes applicable for the agreement line. |
| Price | Decimal | The unit price for the item or service on the purchase agreement line, after applying the price break discount. |
| DiscountPercent | Decimal | The discount percentage applied to the price, reducing the cost of the item or service based on the price break. |
| StartDate | Date | The date when the price break becomes effective, marking the start of the discount for the agreement line. |
| EndDate | Date | The date when the price break expires, after which the discount is no longer applicable for the agreement line. |
| Attribute1 | String | Custom segment for the price break's descriptive flexfield, used to store additional attribute data specific to the agreement line. |
| Attribute10 | String | Custom segment for the price break's descriptive flexfield, used to store additional attribute data specific to the agreement line. |
| Attribute11 | String | Custom segment for the price break's descriptive flexfield. |
| Attribute12 | String | Custom segment for the price break's descriptive flexfield. |
| Attribute13 | String | Custom segment for the price break's descriptive flexfield. |
| Attribute14 | String | Custom segment for the price break's descriptive flexfield. |
| Attribute15 | String | Custom segment for the price break's descriptive flexfield. |
| Attribute16 | String | Custom segment for the price break's descriptive flexfield. |
| Attribute17 | String | Custom segment for the price break's descriptive flexfield. |
| Attribute18 | String | Custom segment for the price break's descriptive flexfield. |
| Attribute19 | String | Custom segment for the price break's descriptive flexfield. |
| Attribute2 | String | Custom segment for the price break's descriptive flexfield. |
| Attribute20 | String | Custom segment for the price break's descriptive flexfield. |
| Attribute3 | String | Custom segment for the price break's descriptive flexfield. |
| Attribute4 | String | Custom segment for the price break's descriptive flexfield. |
| Attribute5 | String | Custom segment for the price break's descriptive flexfield. |
| Attribute6 | String | Custom segment for the price break's descriptive flexfield. |
| Attribute7 | String | Custom segment for the price break's descriptive flexfield. |
| Attribute8 | String | Custom segment for the price break's descriptive flexfield. |
| Attribute9 | String | Custom segment for the price break's descriptive flexfield. |
| AttributeCategory | String | The category segment for the purchase agreement line price breaks descriptive flexfield, allowing for classification of additional attributes. |
| AttributeDate1 | Date | Date segment for the price break's descriptive flexfield, allowing date-based attributes to be added. |
| AttributeDate10 | Date | Date segment for the price break's descriptive flexfield. |
| AttributeDate2 | Date | Date segment for the price break's descriptive flexfield. |
| AttributeDate3 | Date | Date segment for the price break's descriptive flexfield. |
| AttributeDate4 | Date | Date segment for the price break's descriptive flexfield. |
| AttributeDate5 | Date | Date segment for the price break's descriptive flexfield. |
| AttributeDate6 | Date | Date segment for the price break's descriptive flexfield. |
| AttributeDate7 | Date | Date segment for the price break's descriptive flexfield. |
| AttributeDate8 | Date | Date segment for the price break's descriptive flexfield. |
| AttributeDate9 | Date | Date segment for the price break's descriptive flexfield. |
| AttributeNumber1 | Decimal | Number segment for the price break's descriptive flexfield, allowing numeric attributes to be added for further classification. |
| AttributeNumber10 | Decimal | Number segment for the price break's descriptive flexfield. |
| AttributeNumber2 | Decimal | Number segment for the price break's descriptive flexfield. |
| AttributeNumber3 | Decimal | Number segment for the price break's descriptive flexfield. |
| AttributeNumber4 | Decimal | Number segment for the price break's descriptive flexfield. |
| AttributeNumber5 | Decimal | Number segment for the price break's descriptive flexfield. |
| AttributeNumber6 | Decimal | Number segment for the price break's descriptive flexfield. |
| AttributeNumber7 | Decimal | Number segment for the price break's descriptive flexfield. |
| AttributeNumber8 | Decimal | Number segment for the price break's descriptive flexfield. |
| AttributeNumber9 | Decimal | Number segment for the price break's descriptive flexfield. |
| AttributeTimestamp1 | Datetime | Timestamp segment for the price break's descriptive flexfield, allowing for date and time-based attributes to be added. |
| AttributeTimestamp10 | Datetime | Timestamp segment for the price break's descriptive flexfield. |
| AttributeTimestamp2 | Datetime | Timestamp segment for the price break's descriptive flexfield. |
| AttributeTimestamp3 | Datetime | Timestamp segment for the price break's descriptive flexfield. |
| AttributeTimestamp4 | Datetime | Timestamp segment for the price break's descriptive flexfield. |
| AttributeTimestamp5 | Datetime | Timestamp segment for the price break's descriptive flexfield. |
| AttributeTimestamp6 | Datetime | Timestamp segment for the price break's descriptive flexfield. |
| AttributeTimestamp7 | Datetime | Timestamp segment for the price break's descriptive flexfield. |
| AttributeTimestamp8 | Datetime | Timestamp segment for the price break's descriptive flexfield. |
| AttributeTimestamp9 | Datetime | Timestamp segment for the price break's descriptive flexfield. |
| InterfaceHeaderId | Long | The unique identifier for the interface header, linking the price break data to the overall purchase agreement import request. |
| InterfaceLineId | Long | The unique identifier for the interface line, connecting the price break to a specific line item in the purchase agreement. |
| CreatedBy | String | The name of the person or system that created the price break record for the purchase agreement import request. |
| CreationDate | Datetime | The date and time when the price break record for the purchase agreement import request was created. |
| LastUpdatedBy | String | The name of the person or system that last updated the price break record for the purchase agreement import request. |
| LastUpdateDate | Datetime | The date and time when the price break record for the purchase agreement import request was last updated. |
| ProcessCode | String | The code identifying the process or action being executed for the purchase agreement import request price breaks. |
| Finder | String | The search function used to retrieve or filter the price break records for purchase agreement import requests. |
Records translation-specific item attributes for multilingual or localized agreement data imports.
| Name | Type | Description |
| PurchaseAgreementImportRequestsInterfaceHeaderId [KEY] | Long | The unique identifier for the interface header related to the purchase agreement import request translation item attributes. |
| LinesInterfaceLineId [KEY] | Long | The unique identifier for the interface line associated with the translation item attribute, linking it to a specific line on the purchase agreement. |
| InterfaceAttributeTlpId [KEY] | Long | The unique identifier for the translation of the item attribute on the interface line, helping to manage multilingual data. |
| InterfaceLineId | Long | The unique identifier for the interface line, used to track the translation attributes for each item on the purchase agreement. |
| InterfaceHeaderId | Long | The unique identifier for the interface header, linking the translation item attributes to the overall purchase agreement import request. |
| InterfaceLineKey | String | A key that uniquely identifies the interface line for the translation item attribute, ensuring each translation can be traced to its corresponding line. |
| InterfaceAttributeTlpKey | String | A key that uniquely identifies the translated item attribute, distinguishing the translated data from the original. |
| Description | String | A description for the line item, typically providing additional details about the item as it appears on the purchase agreement. |
| Manufacturer | String | The name of the manufacturer of the item specified on the blanket purchase agreement line, providing clarity on the item’s origin. |
| Alias | String | An alternate identifier for the item specified on the blanket purchase agreement line, often used when items have multiple identifiers. |
| Comments | String | Additional comments or notes related to the item, offering extra context or instructions for the purchase agreement line. |
| LongDescription | String | A more detailed text description of the item specified on the blanket purchase agreement line, providing further insights into its specifications or features. |
| Language | String | The language code that indicates the language into which the contents of the translatable columns are converted. The maximum length of the language code is 4. |
| CreatedBy | String | The name of the person or system that created the translation item attribute for the purchase agreement import request. |
| CreationDate | Datetime | The date and time when the translation item attribute was created, providing a record of when the translation data was entered into the system. |
| LastUpdatedBy | String | The name of the person or system that last updated the translation item attribute for the purchase agreement import request. |
| LastUpdateDate | Datetime | The date and time when the translation item attribute was last updated, helping to track the most recent changes to the translation. |
| ProcessCode | String | The code identifying the process or action being performed for the purchase agreement import request translation item attributes. |
| Finder | String | The function or mechanism used to search for or retrieve translation item attributes associated with the purchase agreement import requests. |
Describes goods or services in a purchase agreement, excluding delivery or fulfillment specifics, to outline negotiated items.
| Name | Type | Description |
| AgreementLineId [KEY] | Long | The unique identifier for the agreement line within the purchase agreement, linking it to specific terms and conditions. |
| LineNumber | Decimal | The unique line number within the purchase agreement, used to track and organize line items for the agreement. |
| AgreementHeaderId | Long | The unique identifier for the purchase agreement header, linking all lines to the overall agreement. |
| AgreementNumber | String | The unique identifier (number) for the purchase agreement, used for reference and tracking across systems. |
| ProcurementBUId | Long | The unique identifier for the procurement business unit responsible for the purchase agreement, linking it to the managing business unit. |
| ProcurementBU | String | The name of the procurement business unit that owns and manages the purchase agreement. |
| SupplierId | Long | The unique identifier for the supplier associated with the purchase agreement line, allowing easy identification of the supplying company. |
| Supplier | String | The name of the supplier providing the goods or services on the purchase agreement. |
| SupplierSiteId | Long | The unique identifier for the supplier site from where the goods or services are fulfilled, ensuring accurate delivery and inventory management. |
| SupplierSite | String | The name or identifier of the location where the supplier fulfills the purchase agreement. |
| LineTypeId | Long | The unique identifier for the line type in the purchase agreement, distinguishing between product, service, or other item categories. |
| LineType | String | The type of line item in the purchase agreement, such as goods, services, or labor, used to classify the line. |
| ItemId | Long | The unique identifier for the item being purchased in the agreement line, linking it to inventory and catalog data. |
| Item | String | The name or code of the item being purchased on the agreement line, often used for identification and ordering. |
| ItemRevision | String | The revision or version number of the item, used to track changes or updates to the product being purchased. |
| Description | String | A description of the purchase agreement line item, providing additional context about the item or service being procured. |
| SupplierItem | String | The unique item identifier assigned by the supplier to the product being purchased, used for tracking and cataloging. |
| CategoryId | Long | The unique identifier for the category to which the item belongs, helping with item organization and reporting. |
| CategoryCode | String | The code for the category under which the item is classified, aiding in cataloging and reporting within the purchasing system. |
| Category | String | The name of the category for the item, helping to group similar items together in the procurement system. |
| StatusCode | String | The status code for the purchase agreement line, indicating its current status (for example, active, pending, or canceled). |
| Status | String | The human-readable status of the purchase agreement line, such as 'Active,' 'Closed,' or 'Pending,' providing clarity on the agreement line's lifecycle. |
| UOMCode | String | The unit of measure code for the item on the purchase agreement line, defining the measurement unit (for example, 'EA' for each, 'KG' for kilogram). |
| UOM | String | The unit of measure for the item on the purchase agreement line, indicating how the item is measured (for example, 'each,' 'box,' 'kilogram'). |
| Price | Decimal | The unit price for the item or service on the purchase agreement line, representing the agreed cost per unit. |
| Amount | Decimal | The total amount for the purchase agreement line, typically calculated as price times quantity. |
| CurrencyCode | String | The currency code for the purchase agreement line, representing the currency in which the price is stated (for example, USD, EUR). |
| Currency | String | The name of the currency for the purchase agreement line, providing clarity on the pricing currency. |
| ConsignmentLineFlag | Bool | Indicates whether the agreement line involves consignment. 'True' means the line is for consignment, 'False' means it is not. |
| NoteToSupplier | String | A note to the supplier, providing additional instructions or information related to the purchase agreement line. |
| AllowItemDescriptionUpdateFlag | Bool | Indicates whether item descriptions can be updated on the agreement line. 'True' allows updates, 'False' prevents them. |
| PriceLimit | Decimal | The maximum price allowed for the agreement line, ensuring that purchases do not exceed the agreed limit. |
| AllowPriceOverrideFlag | Bool | Indicates whether the price for the agreement line can be overridden. 'True' allows overrides, 'False' does not. |
| NegotiatedFlag | Bool | Indicates whether the price for the agreement line has been negotiated with the supplier. 'True' means it was negotiated, 'False' means it was not. |
| ExpirationDate | Date | The date after which the purchase agreement line is no longer valid, marking its expiration. |
| MinimumReleaseAmount | Decimal | The minimum amount that can be released against a blanket or planned purchase order for the agreement line. |
| AgreementAmount | Decimal | The total amount agreed upon for the agreement line, representing the full cost or value of the line item. |
| AgreementQuantity | Decimal | The total quantity agreed upon for the item or service on the agreement line, specifying how many units are to be purchased. |
| ReleasedAmount | Decimal | The total amount released or invoiced against the agreement line, representing how much has been fulfilled or billed. |
| PriceBreakTypeCode | String | The code representing the type of price break applied to the agreement line, specifying how price reductions are structured. |
| SupplierItemAuxiliaryIdentifier | String | An additional identifier used by the supplier for the item, often representing a subpart or additional categorization. |
| ParentItemId | Long | The unique identifier for the parent item or product that the current line item is part of, often used for bundled or configurable items. |
| SupplierParentItem | String | The supplier’s identifier for the parent item or product associated with the current line item. |
| TopModelId | Long | The unique identifier for the top model of the item, typically used in product families or configurable items to group related products. |
| SupplierTopModel | String | The supplier’s identifier for the top model associated with the item on the purchase agreement line. |
| UnNumberId | Long | The unique identifier for the UN number (hazard classification) of the item, providing a standardized identifier for hazardous materials. |
| UnNumber | String | The UN number for the item, used for identifying hazardous materials during shipping and handling. |
| UNNumberDescription | String | A description of the UN number, providing more context on the classification of hazardous materials. |
| HazardClassId | Long | The unique identifier for the hazard class of the item, indicating its potential risks and classification for safety and shipping purposes. |
| HazardClassCode | String | The code representing the hazard class for the item, used to categorize the material for transportation and safety requirements. |
| HazardClass | String | The name or description of the hazard class for the item, providing details on the item's potential risks and necessary precautions. |
| AgingPeriodDays | Int | The maximum number of days the material may be stored or consigned before it is considered aged and requires action. |
| CreatedBy | String | The name of the person or system that created the purchase agreement line, helping to trace the origin of the agreement. |
| CreationDate | Datetime | The date and time when the purchase agreement line was created, used for historical tracking and auditing purposes. |
| LastUpdatedBy | String | The name of the person or system that last updated the purchase agreement line, providing accountability for changes. |
| LastUpdateDate | Datetime | The date and time when the purchase agreement line was last updated, ensuring that the most recent data is available. |
| Finder | String | The search function or query mechanism used to locate specific purchase agreement lines based on criteria like supplier, item, or status. |
Contains auxiliary item data in a purchase agreement (supplier part number, manufacturer info) to ensure accurate fulfillment.
| Name | Type | Description |
| PurchaseAgreementLinesAgreementLineId [KEY] | Long | The unique identifier for the agreement line in the purchase agreement, linking the item attributes to a specific line in the agreement. |
| AttributeValuesId [KEY] | Long | The unique identifier for the set of attribute values associated with the purchase agreement line item, enabling the storage and retrieval of item-specific details. |
| AttributeValuesTlpId | Long | The unique identifier for the translation of attribute values, used to track multilingual attribute data for the purchase agreement line item. |
| LongDescription | String | A detailed description of the purchase agreement line item, providing comprehensive information about the item’s features and specifications. |
| SupplierURL | String | The URL for the supplier’s website, providing direct access to the supplier's online presence for more information about the item or their services. |
| Manufacturer | String | The name of the manufacturer for the item specified on the purchase agreement line, indicating the origin or creator of the item. |
| ManufacturerURL | String | The URL for the manufacturer’s website, offering access to the manufacturer's online resources, product catalogs, and support services. |
| ManufacturerPartNumber | String | The part number assigned by the manufacturer to the item specified on the purchase agreement line, used for cataloging and identification. |
| AttachmentURL | String | The URL for any attachments related to the item, such as product manuals, specifications, or certification documents. |
| Alias | String | An alternative identifier for the item specified on the purchase agreement line, providing flexibility in referencing the item under different naming conventions. |
| LeadTimeDays | Decimal | The number of days required for the item to be delivered once ordered, helping to manage and plan for the item’s arrival and integration into the procurement process. |
| UNSPSC | String | The United Nations Standard Products and Services Code (UNSPSC) for the item, used for consistent classification and categorization of products and services in global trade. |
| ImageURL | String | The URL for an image of the item, providing a visual representation of the item specified on the purchase agreement line. |
| ThumbnailImageURL | String | The URL for a smaller version of the image file, typically used for quick previews or in product listings to minimize load times. |
| Availability | String | The status of the item’s availability from the supplier, indicating whether the item is in stock, out of stock, or available for backorder. |
| RoundingFactor | Double | An attribute indicating how the quantity for the item should be rounded during internal requisitioning, particularly when converting between different units of measure. |
| PackagingString | String | A string that describes how the item is packaged by the supplier, providing essential information for handling, storage, and shipping. |
| CreatedBy | String | The name of the person or system that created the item attributes for the purchase agreement line, providing accountability for the entry. |
| CreationDate | Datetime | The date and time when the item attributes for the purchase agreement line were created, providing historical context for the data entry. |
| LastUpdateDate | Datetime | The date and time when the item attributes for the purchase agreement line were last updated, ensuring the most recent data is available. |
| LastUpdatedBy | String | The name of the person or system that last updated the item attributes for the purchase agreement line, providing accountability for modifications. |
| AgreementLineId | Long | The unique identifier for the agreement line in the purchase agreement, connecting the item attributes to the specific line for tracking and processing. |
| Finder | String | The function or mechanism used to search for or retrieve the item attributes associated with the purchase agreement line, helping to locate specific data based on criteria. |
Displays volume-based or location-based price variations for each agreement line, providing cost details beyond the base unit price.
| Name | Type | Description |
| PurchaseAgreementLinesAgreementLineId [KEY] | Long | The unique identifier for the agreement line in the purchase agreement, linking the price break to a specific item or service. |
| PriceBreakId [KEY] | Long | The unique identifier for the price break record, distinguishing different price breaks applied to the agreement line. |
| PriceBreakNumber | Decimal | The number assigned to the price break, helping to identify and order multiple price breaks within the same agreement line. |
| LineNumber | Decimal | The line number within the purchase agreement associated with the price break, helping to track and organize the price breaks on individual lines. |
| ShipToOrganizationId | Long | The unique identifier for the organization that will receive the item, ensuring correct shipping and logistics for the price break. |
| ShipToOrganizationCode | String | The code identifying the ship-to organization, used for internal classification and processing of shipping information. |
| ShipToOrganization | String | The name of the organization receiving the shipment, clarifying where the items covered by the price break will be delivered. |
| LocationId | Long | The unique identifier for the location where the item covered by the price break will be delivered, aiding in shipping and inventory management. |
| LocationCode | String | The code for the location receiving the shipment, used to manage shipping and ensure items are delivered to the correct destination. |
| Location | String | The name of the location where the item is delivered, providing a clear description of the delivery site for the price break. |
| Quantity | Decimal | The quantity of items required to trigger the price break, indicating the minimum number of units that must be purchased to receive the discount. |
| UOMCode | String | The unit of measure code for the price break, indicating how the quantity is measured (for example, 'EA' for each, 'KG' for kilogram). |
| UOM | String | The unit of measure for the price break, specifying how the quantity of items is quantified (for example, 'each,' 'kg,' 'box'). |
| Price | Decimal | The unit price for the item after the price break has been applied, indicating the discounted price that will be charged. |
| DiscountPercent | Decimal | The percentage discount applied to the original price of the item, reflecting the savings gained through the price break. |
| StartDate | Date | The date on which the price break becomes effective, indicating when the discount will start to apply. |
| EndDate | Date | The date after which the price break expires, indicating when the discount will no longer be valid for the agreement line. |
| CurrencyCode | String | The currency code in which the price and discount are stated, ensuring consistency in financial terms for the price break. |
| Currency | String | The name of the currency in which the price and discount are expressed, making the terms more understandable (for example, USD, EUR). |
| CreatedBy | String | The name of the person or system that created the price break record, providing accountability for the entry. |
| CreationDate | Datetime | The date and time when the price break record was created, providing a historical record for tracking and auditing. |
| LastUpdatedBy | String | The name of the person or system that last updated the price break record, ensuring accountability for changes made. |
| LastUpdateDate | Datetime | The date and time when the price break record was last updated, helping to track the most recent changes. |
| AgreementLineId | Long | The unique identifier for the agreement line associated with the price break, linking the price break to the specific item or service in the purchase agreement. |
| Finder | String | The search function or query used to retrieve or filter price break records based on specified criteria such as quantity, price, or location. |
Holds purchase agreement headers (quantity- or value-based) with negotiated terms, used by subsequent POs or contracts.
| Name | Type | Description |
| AgreementHeaderId [KEY] | Long | The unique identifier for the purchase agreement header, linking all agreement lines and related information to the overall purchase agreement. |
| AgreementNumber | String | The number assigned to the purchase agreement that uniquely identifies it within the sold-to legal entity, used for reference and tracking. |
| ProcurementBUId | Long | The unique identifier for the procurement business unit that manages and owns the purchase agreement, helping to associate it with the relevant business unit. |
| ProcurementBU | String | The name of the procurement business unit responsible for managing and overseeing the purchase agreement. |
| BuyerId | Long | The unique identifier for the buyer handling the purchase agreement, used for accountability and to link the agreement to the responsible individual. |
| Buyer | String | The name of the person responsible for managing the purchase agreement, typically the procurement officer or purchasing manager. |
| DocumentStyleId | Long | The unique identifier for the purchasing document style, used to control and customize the display parameters of the purchase agreement document. |
| DocumentStyle | String | The name of the purchasing document style, specifying how the purchase agreement document is structured and displayed in the system. |
| StatusCode | String | A code representing the status of the purchase agreement header, indicating its current state in the agreement lifecycle (for example, 'Active,' 'Closed'). |
| Status | String | The status of the purchase agreement, providing a human-readable representation of its lifecycle (for example, 'Active,' 'Pending,' 'Completed'). |
| SupplierId | Long | The unique identifier for the supplier associated with the purchase agreement, used to track the party providing the goods or services. |
| Supplier | String | The name of the supplier providing the goods or services on the purchase agreement, enabling easy identification of the supplier. |
| SupplierSiteId | Long | The unique identifier for the supplier site, representing the location where the supplier fulfills the order specified in the purchase agreement. |
| SupplierSite | String | The name or identifier of the supplier site where the purchase order will be fulfilled, ensuring accurate delivery and site-specific details. |
| SupplierContactId | Long | The unique identifier for the supplier contact, used to link to the person who communicates with the buyer regarding the purchase agreement. |
| SupplierContact | String | The name of the person at the supplier organization responsible for managing communications with the buyer about the purchase agreement. |
| SupplierCommunicationMethodCode | String | The code that identifies the method of communication between the supplier and the buyer, such as email, phone, or fax. |
| SupplierEmailAddress | String | The email address provided for the supplier, used for sending documents or communication after the purchase agreement has been approved. |
| SupplierFax | String | The fax number provided for the supplier, used for sending or receiving official documents after the purchase agreement is approved. |
| StartDate | Date | The date when the purchase agreement becomes effective, indicating when the terms of the agreement are officially valid and enforceable. |
| EndDate | Date | The date when the purchase agreement expires, marking the end of its validity and the point after which the agreement is no longer applicable. |
| AgreementAmount | Decimal | The total amount agreed upon for the purchase agreement, representing the monetary value of the agreement between the buyer and supplier. |
| CurrencyCode | String | The code representing the currency used in the purchase agreement, such as USD for US Dollar or EUR for Euro. |
| Currency | String | The name of the currency used in the purchase agreement, providing clarity on the financial terms (for example, 'US Dollar,' 'Euro'). |
| AmountLimit | Decimal | The maximum amount limit for the purchase agreement, beyond which no additional releases or orders can be made against it. |
| MinimumReleaseAmount | Decimal | The minimum amount that can be released from the purchase agreement when converting requisition lines into purchase orders. |
| ReleasedAmount | Decimal | The total amount released against the purchase agreement, representing the sum of all amounts for approved purchase orders. |
| Description | String | A detailed description of the purchase agreement, summarizing its purpose, terms, and other key aspects for easy reference. |
| DocumentTypeCode | String | The code representing the type of document associated with a change order template, helping to classify the type of document within the system. |
| MasterContractId | Long | The unique identifier for the master contract associated with the purchase agreement, linking it to overarching contract terms and conditions. |
| MasterContractNumber | String | The number assigned to the master contract, providing a reference to a higher-level contract that governs the terms of the purchase agreement. |
| MasterContractTypeId | Long | The unique identifier for the master contract type, used to categorize the contract based on its functionality or purpose. |
| MasterContractType | String | The name of the master contract type, representing the classification that determines the functionality and terms for the contract. |
| ConversionRateTypeCode | String | The code representing the type of conversion rate applied to currency exchanges in the purchase agreement (for example, 'Spot,' 'Forward'). |
| ConversionRateDate | Date | The date used for determining the applicable conversion rate, specifying which exchange rate is applied based on the transaction date. |
| ConversionRate | Decimal | The actual conversion rate used to convert the purchase agreement amount from one currency to another, based on the applicable rate. |
| RevisionNumber | Decimal | The revision number of the purchase agreement, indicating changes or updates made to the original document over time. |
| SupplierAgreement | String | The number provided by the supplier to identify the supplier’s version of the agreement, used for cross-reference and audit purposes. |
| ReferenceNumber | String | A reference number used for the EDI (Electronic Data Interchange) transaction audit trail, ensuring traceability for electronic communication. |
| ClosedDate | Date | The date when the purchase agreement was closed, marking the point at which no further changes or releases can be made. |
| RequiredAcknowledgmentCode | String | Indicates whether an acknowledgment from the supplier is required for the purchase agreement, and if so, the level of acknowledgment needed. |
| RequiredAcknowledgment | String | The specific acknowledgment required from the supplier, such as 'Document' for acknowledging the purchase agreement or 'Schedule' for acknowledging specific schedules within the agreement. |
| AcknowledgmentDueDate | Date | The date by which the supplier is required to acknowledge the purchase agreement, ensuring timely confirmation of the terms. |
| AcknowledgmentWithinDays | Decimal | The number of days within which the supplier must decide to accept or reject the purchase agreement document. |
| PaymentTermsId | Long | The unique identifier for the payment terms associated with the purchase agreement, detailing how and when payments are to be made. |
| PaymentTerms | String | The payment terms for the purchase agreement, specifying the conditions under which payments are to be scheduled, including due dates and discount conditions. |
| CarrierId | Long | The unique identifier for the carrier transporting the item, linking the purchase agreement to the logistics provider responsible for delivery. |
| Carrier | String | The name of the carrier responsible for transporting the item specified in the purchase agreement, ensuring coordination of delivery logistics. |
| ModeOfTransportCode | String | The code identifying the mode of transport used to move the goods, such as land, sea, or air. |
| ModeOfTransport | String | The name of the mode of transport (for example, truck, ship, air) used to deliver the item specified in the purchase agreement. |
| ServiceLevelCode | String | The code identifying the level of service required for the transportation of goods, affecting delivery speed and conditions. |
| ServiceLevel | String | The description of the service level for transport, indicating how urgently goods must be delivered (for example, 'Standard,' 'Expedited'). |
| FreightTermsCode | String | The code representing the type of freight terms for the purchase agreement, specifying who is responsible for transportation charges. |
| FreightTerms | String | The terms that describe who bears the responsibility for freight charges, such as 'FOB' or 'CIF,' affecting the cost structure for transportation. |
| FOBCode | String | The code identifying the type of free-on-board (FOB) terms applied to the purchase agreement, which determines when ownership and risk transfer. |
| FOB | String | The description of the free-on-board (FOB) terms for the purchase agreement, indicating when ownership and responsibility for the goods shift from the supplier to the buyer. |
| RequiresSignatureFlag | Bool | Indicates whether signatures are required on the purchase document before it can be implemented. 'Yes' means signatures are required, 'No' means they are not. |
| BuyerManagedTransportFlag | Bool | Indicates whether the buying company is responsible for arranging transportation. 'True' means the buyer arranges the transport, 'False' means the supplier handles it. |
| PayOnReceiptFlag | Bool | Indicates whether invoices should be automatically generated when supplier-owned material is consumed by the buying organization. 'True' means invoices are generated upon receipt. |
| ConfirmingOrderFlag | Bool | Indicates whether the purchase agreement is a confirmation of an order that the supplier may already be aware of. 'True' means it's a confirmation, 'False' means it's not. |
| ConsumptionAdviceFrequencyCode | String | The code indicating the frequency of consumption advice for the purchase agreement, helping to manage inventory and supply chain needs. |
| ConsumptionAdviceFrequency | String | The value identifying the frequency at which consumption advice is generated for consigned inventory under the agreement, such as 'Daily,' 'Weekly,' or 'Monthly.' |
| ConsumptionAdviceSummaryCode | String | The code indicating the frequency of consumption advice summaries, which helps consolidate information for the supplier. |
| ConsumptionAdviceSummary | String | The value identifying the default frequency for generating consumption advice summaries, including options like 'Daily,' 'Weekly,' or 'Monthly.' |
| AgingOnsetPointCode | String | The code identifying when the aging of consigned material begins, which determines the duration for which inventory can be held before aging. |
| AgingOnsetPoint | String | The event point agreed upon for when consigned material starts to age, with options like 'None,' 'Receipt,' or 'Shipment.' |
| AgingPeriodDays | Int | The number of days consigned material can remain in inventory before it is considered aged, after which action may be required. |
| NoteToReceiver | String | Special instructions for the receiver, providing guidance on how to handle the goods upon receipt in the docking area. |
| NoteToSupplier | String | A note to the supplier, detailing important information or requests related to the purchase agreement. |
| AutomaticallyGenerateOrdersFlag | Bool | Indicates whether orders should be automatically generated for requisition lines referencing the purchase agreement. 'True' means automatic order creation is enabled. |
| AutomaticallySubmitForApprovalFlag | Bool | Indicates whether the purchase agreement document can be automatically submitted for approval. 'True' means automatic submission is enabled. |
| GroupRequisitionsFlag | Bool | Indicates whether requisition lines from different requisitions referencing the same agreement line should be grouped when creating an order. |
| UseCustomerSalesOrderFlag | Bool | Indicates whether requisition lines should be grouped by sales order number to create distinct purchase orders. 'True' means they should be grouped. |
| UseShipToLocationFlag | Bool | Indicates whether requisitions should be grouped by ship-to location when creating orders. 'True' means grouping by location is enabled. |
| GroupRequisitionLinesFlag | Bool | Indicates whether requisition lines referencing the same agreement line should be grouped together when creating an order. 'True' means they will be grouped. |
| UseRequestedDateFlag | Bool | Indicates whether the requested delivery date on requisition lines should be used when grouping requisitions. 'True' enables grouping by requested date. |
| UseShipToOrganizationAndLocationFlag | Bool | Indicates whether item descriptions can be updated on the document lines. 'True' means updates are allowed. |
| AllowUnassignedSitesFlag | Bool | Indicates whether the agreement can be used to order from supplier sites that are not listed as purchasing sites in the agreement's business unit assignments. |
| EnableRetroactivePricingFlag | Bool | Indicates whether retroactive pricing updates should be applied to orders. 'True' means open orders will be repriced when price changes are made. |
| InitiateRetroactivePricingUponApprovalFlag | Bool | Indicates whether retroactive price updates should be initiated upon agreement approval. 'True' means updates are triggered after approval. |
| RepriceOpenOrdersFlag | Bool | Indicates whether only open unfulfilled orders should be repriced due to a retroactive price update. 'True' enables repricing for open orders. |
| CommunicateRepricedOrdersFlag | Bool | Indicates whether orders that were repriced due to a price change should be communicated to the supplier. 'True' enables communication. |
| PunchoutRequestsOnlyFlag | Bool | Indicates whether automatic document sourcing is restricted to punchout requisition lines. 'True' means only punchout requisition lines will source from the agreement. |
| UseOrderDateForOrderPricingFlag | Bool | Indicates whether the order date should be used to derive the price for orders referencing the agreement. 'True' uses the order date, 'False' uses the requested delivery date. |
| Priority | Int | The priority assigned to the purchase agreement, affecting the urgency and processing order of the associated orders. |
| Checklist | String | The unique identifier for the checklist associated with the purchase agreement, providing additional instructions or requirements for processing. |
| CreationDate | Datetime | The date and time when the purchase agreement was created, providing context for its entry into the system. |
| CreatedBy | String | The name of the person or system that created the purchase agreement, ensuring accountability for its creation. |
| LastUpdateDate | Datetime | The date and time when the purchase agreement was last updated, indicating the most recent modifications. |
| LastUpdatedBy | String | The name of the person or system that last updated the purchase agreement, ensuring accountability for changes. |
| Finder | String | The search function used to locate the purchase agreement, based on criteria like supplier, status, or agreement number. |
| EffectiveDate | Date | The date on which the purchase agreement becomes effective, specifying the date from which its terms and conditions are valid. |
Specifies which business units can use a purchase agreement, enabling enterprise-wide or localized access to negotiated terms.
| Name | Type | Description |
| PurchaseAgreementsAgreementHeaderId [KEY] | Long | The unique identifier for the purchase agreement header, linking all business unit access records and related information to the overall agreement. |
| OrganizationAssignmentId [KEY] | Long | The unique identifier for the procurement agent assignment, indicating the person or system responsible for managing the business unit access within the purchase agreement. |
| RequisitioningBUId | Long | The unique identifier for the business unit that requested the goods or services being purchased, helping to track which business unit initiated the purchase. |
| RequisitioningBU | String | The name of the business unit that creates the requisition for the goods or services, ensuring clarity on which department is responsible for the request. |
| OrderLocallyFlag | Bool | Indicates whether the client's order should be routed to local supplier sites maintained by the client. 'True' means the order will go to local sites, 'False' means it won't. No default value is provided. |
| PurchasingSiteId | Long | The unique identifier for the supplier site associated with the purchasing operating unit, used for routing purchase orders to the correct fulfillment site. |
| PurchasingSite | String | The name or identifier of the supplier site where goods are sourced from in the purchasing operating unit, providing context for the logistics of procurement. |
| ShipToLocationId | Long | The unique identifier for the location where the supplier will ship the goods or services, helping to track delivery destinations. |
| ShipToLocationCode | String | An abbreviation identifying the location where the supplier ships the item, used for efficient routing and inventory management. |
| ShipToLocation | String | The name of the location where the supplier ships the goods, providing clarity for shipping and delivery coordination. |
| BilltoBUId | Long | The unique identifier for the business unit responsible for processing supplier invoices for the purchase order, ensuring accurate billing and financial tracking. |
| BillToBU | String | The name of the business unit that processes supplier invoices for the purchasing document, providing accountability for financial operations. |
| BillToLocationId | Long | The unique identifier for the bill-to location, ensuring proper invoice processing by indicating where the invoice should be sent. |
| BillToLocation | String | The name or identifier of the location where the supplier sends the invoice, aiding in correct financial and accounting processes. |
| EnabledFlag | Bool | Indicates whether the business unit access record for the purchase agreement is active or disabled. 'True' means it is enabled, 'False' means it is disabled. No default value is provided. |
| CreatedBy | String | The name of the user who created the business unit access record for the purchase agreement, ensuring accountability for data entry. |
| CreationDate | Datetime | The date and time when the business unit access record for the purchase agreement was created, providing a historical record of the assignment. |
| LastUpdatedBy | String | The name of the user who last updated the business unit access record for the purchase agreement, ensuring accountability for changes made. |
| LastUpdateDate | Datetime | The date and time when the business unit access record was last updated, providing a clear record of recent modifications. |
| AgreementHeaderId | Long | The unique identifier for the purchase agreement header, used to link this record to the purchase agreement's overall terms and conditions. |
| Finder | String | The search function or query mechanism used to locate or filter business unit access records associated with the purchase agreement. |
| EffectiveDate | Date | The date used to fetch business unit access records that are effective as of this date, ensuring that the correct version of the record is retrieved. |
Defines the line items (goods/services) under a purchase agreement, detailing negotiated prices and quantities.
| Name | Type | Description |
| PurchaseAgreementsAgreementHeaderId [KEY] | Long | The unique identifier for the purchase agreement header, linking all the purchase agreement lines to the overall agreement. |
| AgreementLineId [KEY] | Long | The unique identifier for the specific purchase agreement line, used to distinguish individual items or terms within the agreement. |
| LineNumber | Decimal | The line number within the purchase agreement, used to organize and reference individual items or services in the agreement. |
| AgreementHeaderId | Long | The unique identifier for the purchase agreement header, linking the agreement line to the overall purchase agreement. |
| AgreementNumber | String | The number assigned to the purchase agreement, uniquely identifying it within the sold-to legal entity, for easy reference and tracking. |
| ProcurementBUId | Long | The unique identifier for the business unit responsible for managing and owning the purchase agreement, ensuring proper handling and compliance. |
| ProcurementBU | String | The name of the business unit responsible for managing and overseeing the purchase agreement. |
| SupplierId | Long | The unique identifier for the supplier fulfilling the purchase agreement line, ensuring proper supplier identification and tracking. |
| Supplier | String | The name of the supplier who provides the goods or services specified in the purchase agreement line. |
| SupplierSiteId | Long | The unique identifier for the supplier site where goods or services are delivered, ensuring accuracy in shipping and logistics. |
| SupplierSite | String | The name or identifier of the supplier site where the goods or services will be delivered or fulfilled. |
| LineTypeId | Long | The unique identifier for the line type in the purchase agreement, used to categorize the line as either goods, services, or other types. |
| LineType | String | The type of line item in the purchase agreement (for example, goods, services, or labor), which classifies the nature of the procurement. |
| ItemId | Long | The unique identifier for the item specified in the purchase agreement line, allowing easy identification and tracking of the item. |
| Item | String | The abbreviated name or identifier for the item specified in the purchase agreement line. |
| ItemRevision | String | The revision number of the item, used to track and manage different versions or updates of the item. |
| Description | String | A detailed description of the item or service specified in the purchase agreement line, providing additional context and specifications. |
| SupplierItem | String | The unique item number assigned by the supplier, used to track the product or service as identified by the supplier. |
| CategoryId | Long | The unique identifier for the purchasing category associated with the item, used for classification and reporting purposes. |
| CategoryCode | String | The abbreviation for the category under which the item is classified, helping to organize procurement categories. |
| Category | String | The name or description of the purchasing category associated with the item in the agreement line. |
| StatusCode | String | The code representing the status of the agreement line, indicating whether the line is active, pending, or closed. |
| Status | String | The human-readable status of the agreement line, reflecting its current stage in the procurement lifecycle (for example, 'Active,' 'Closed'). |
| UOMCode | String | The unit of measure code used for the item in the agreement line, providing standardization for quantity measurement (for example, 'EA' for each, 'KG' for kilograms). |
| UOM | String | The unit of measure for the item on the purchase agreement line, indicating how quantities are measured (for example, 'each,' 'kg'). |
| Price | Decimal | The unit price for the item specified in the agreement line, representing the agreed cost per unit of the item or service. |
| Amount | Decimal | The total amount for the purchase agreement line, typically calculated as the price multiplied by the quantity of items ordered. |
| CurrencyCode | String | The currency code representing the currency used for the price and amount in the agreement line (for example, USD, EUR). |
| Currency | String | The name of the currency used for the price and amount in the agreement line, helping to clarify the financial terms (for example, 'US Dollar,' 'Euro'). |
| ConsignmentLineFlag | Bool | Indicates whether the agreement line involves consignment stock. 'True' means the line involves consignment, 'False' means it does not. |
| NoteToSupplier | String | A note to the supplier, providing additional instructions or clarifications related to the purchase agreement line. |
| AllowItemDescriptionUpdateFlag | Bool | Indicates whether the item description can be updated on the agreement line. 'True' means updates are allowed, 'False' means they are not. |
| PriceLimit | Decimal | The maximum price allowed for the item on the agreement line, ensuring that releases do not exceed the predefined limit. |
| AllowPriceOverrideFlag | Bool | Indicates whether the price for the item can be overridden during release or invoicing. 'True' allows overrides, 'False' prevents them. |
| NegotiatedFlag | Bool | Indicates whether the price for the agreement line has been negotiated with the supplier. 'True' means it was negotiated, 'False' means it was not. |
| ExpirationDate | Date | The date after which the agreement line expires and is no longer valid for placing orders or making releases against it. |
| MinimumReleaseAmount | Decimal | The minimum amount that can be released against a blanket or planned purchase order for the agreement line. |
| AgreementAmount | Decimal | The total amount agreed upon for the purchase agreement line, representing the monetary value agreed between the buyer and supplier. |
| AgreementQuantity | Decimal | The total quantity agreed upon for the item or service in the agreement line, specifying the amount to be procured. |
| ReleasedAmount | Decimal | The amount already released or invoiced against the agreement line, representing the sum of all approved purchase order amounts. |
| PriceBreakTypeCode | String | The code representing the pricing scheme applied to the agreement line for price breaks, such as volume discounts or tiered pricing. |
| SupplierItemAuxiliaryIdentifier | String | An additional identifier provided by the supplier for the item, used to reference specific details or versions of the item. |
| ParentItemId | Long | The unique identifier for the parent item, used for tracking items in bundles or configurations that are sold together. |
| SupplierParentItem | String | The supplier's identifier for the parent item associated with the current item in the purchase agreement line. |
| TopModelId | Long | The unique identifier for the top model associated with the item or product, often used in product families or configurations. |
| SupplierTopModel | String | The supplier's identifier for the top model associated with the item, used to track and reference the model for complex items or configurations. |
| UnNumberId | Long | The unique identifier for the UN number, used to identify hazardous materials as per United Nations regulations. |
| UnNumber | String | The UN number associated with hazardous materials, used to ensure proper handling and transportation of hazardous items. |
| UNNumberDescription | String | The description of the UN number, providing additional details about the hazardous material classification. |
| HazardClassId | Long | The unique identifier for the hazard class of the item, used to classify items based on their level of risk. |
| HazardClassCode | String | The code for the hazard class, representing the level of danger posed by the item, such as 'flammable' or 'corrosive'. |
| HazardClass | String | The name or description of the hazard class, providing context for handling and transport safety. |
| AgingPeriodDays | Int | The maximum number of days the consigned material can remain in inventory before it is considered aged and must be returned or disposed of. |
| CreatedBy | String | The name of the user or system that created the purchase agreement line, providing accountability for the data entry. |
| CreationDate | Datetime | The date and time when the purchase agreement line was created, providing historical context for tracking and auditing. |
| LastUpdatedBy | String | The name of the user or system that last updated the purchase agreement line, ensuring accountability for any changes made. |
| LastUpdateDate | Datetime | The date and time when the purchase agreement line was last updated, ensuring that the most recent changes are available for reference. |
| Finder | String | The search function used to retrieve specific purchase agreement lines based on criteria such as status, supplier, or item. |
| EffectiveDate | Date | The date used to retrieve purchase agreement lines that are effective as of this specified date, ensuring accurate data retrieval based on the agreement's active period. |
Carries supplemental item information on a purchase agreement line, such as manufacturer details or supplier item reference.
| Name | Type | Description |
| PurchaseAgreementsAgreementHeaderId [KEY] | Long | The unique identifier for the purchase agreement header, linking all item attributes and related information to the overall purchase agreement. |
| LinesAgreementLineId [KEY] | Long | The unique identifier for the agreement line, used to distinguish individual items or terms within the purchase agreement. |
| AttributeValuesId [KEY] | Long | The unique identifier for the extended item attributes in the purchase agreement line, serving as the primary key for the Purchasing Attribute Values view object. |
| AttributeValuesTlpId | Long | The unique identifier for the item translation attributes in the purchase agreement line, serving as the primary key for the Purchasing Attribute Values Translation view object. |
| LongDescription | String | A detailed text description of the item specified in the blanket purchase agreement line, providing comprehensive details on the item’s features and specifications. |
| SupplierURL | String | The URL for the supplier's organization, offering a direct link to their website for more information about their products and services. |
| Manufacturer | String | The name of the manufacturer for the item specified in the blanket purchase agreement line, identifying the entity responsible for producing the item. |
| ManufacturerURL | String | The URL for the manufacturer’s website, providing access to their online resources and product catalogs. |
| ManufacturerPartNumber | String | The part number assigned by the manufacturer to the item specified in the blanket purchase agreement line, used for cataloging and identification. |
| AttachmentURL | String | The URL for any attachment associated with the item, such as product manuals, specifications, or certification documents. |
| Alias | String | An alternate identifier for the item specified in the blanket purchase agreement line, providing flexibility in referencing the item under different naming conventions. |
| LeadTimeDays | Decimal | The number of days required for the item to be delivered once ordered, helping to manage and plan for the item’s arrival and integration into the procurement process. |
| UNSPSC | String | The United Nations Standard Products and Services Code (UNSPSC) for the item, used for consistent classification and categorization of products and services in global trade. |
| ImageURL | String | The URL for an image of the item, providing a visual representation of the item specified in the blanket purchase agreement line. |
| ThumbnailImageURL | String | The URL for a smaller version of the image file, typically used for quick previews or in product listings to minimize load times. |
| Availability | String | The status of the item’s availability from the supplier, indicating whether the item is in stock, out of stock, or available for backorder. |
| RoundingFactor | Double | An attribute indicating how the quantity on an internal requisition should be rounded during conversions between the requisition line unit of measure and the item’s unit of issue. |
| PackagingString | String | A string describing how the item is packed by the supplier, providing essential information for handling, storage, and shipping. |
| CreatedBy | String | The name of the person or system that created the item attributes for the purchase agreement line, ensuring accountability for the data entry. |
| CreationDate | Datetime | The date and time when the item attributes for the purchase agreement line were created, providing a historical record for tracking and auditing. |
| LastUpdateDate | Datetime | The date and time when the item attributes for the purchase agreement line were last updated, ensuring the most recent data is available. |
| LastUpdatedBy | String | The name of the person or system that last updated the item attributes for the purchase agreement line, ensuring accountability for modifications. |
| AgreementHeaderId | Long | The unique identifier for the agreement header, used to link this record to the purchase agreement’s overall terms and conditions. |
| Finder | String | The search function or query used to locate or filter item attributes associated with the purchase agreement line, helping to find specific data based on criteria. |
| EffectiveDate | Date | The date used to retrieve item attributes that are effective as of this specified date, ensuring the correct version of the record is retrieved. |
Captures location- or quantity-based price adjustments for agreement lines, ensuring appropriate pricing for each scenario.
| Name | Type | Description |
| PurchaseAgreementsAgreementHeaderId [KEY] | Long | The unique identifier for the purchase agreement header, linking all price breaks and related information to the overall agreement. |
| LinesAgreementLineId [KEY] | Long | The unique identifier for the specific agreement line, used to distinguish individual items or terms within the purchase agreement related to price breaks. |
| PriceBreakId [KEY] | Long | The unique identifier for the price break record, allowing it to be differentiated and managed separately in the context of the agreement line. |
| PriceBreakNumber | Decimal | The number assigned to the price break on the agreement line, used to reference specific discounts or price reductions available under the agreement. |
| LineNumber | Decimal | The line number within the purchase agreement associated with the price break, used to track and organize price breaks on individual lines. |
| ShipToOrganizationId | Long | The unique identifier for the ship-to organization, ensuring that the price break is applied to the correct receiving organization for the goods. |
| ShipToOrganizationCode | String | The abbreviation identifying the ship-to organization, helping to manage multiple receiving organizations within a larger procurement framework. |
| ShipToOrganization | String | The name of the inventory organization that receives the goods or services, providing context for where the price break applies. |
| LocationId | Long | The unique identifier for the location where the goods or services covered by the price break will be shipped, helping with logistics and shipping management. |
| LocationCode | String | The abbreviation identifying the location where the supplier ships the items, allowing for efficient routing and inventory management. |
| Location | String | The name of the location where the supplier ships the goods, helping clarify the shipping destination and ensuring accurate delivery. |
| Quantity | Decimal | The minimum quantity of items required to trigger the price break, helping to manage discounts based on volume or bulk purchasing. |
| UOMCode | String | The unit of measure code for the price break, indicating how the quantity is measured (for example, 'EA' for each, 'KG' for kilogram). |
| UOM | String | The unit of measure for the price break, specifying how the quantity of items is quantified (for example, 'each,' 'kg,' 'box'). |
| Price | Decimal | The unit price for the item after applying the price break, representing the discounted price that will be charged per unit. |
| DiscountPercent | Decimal | The percentage discount applied to the original price of the item for the agreement line, reflecting the savings gained through the price break. |
| StartDate | Date | The date when the price break becomes effective, indicating the start date from which the discount will apply to the purchase agreement line. |
| EndDate | Date | The date after which the price break expires, indicating the end date for when the discount will no longer be available for purchase orders. |
| CurrencyCode | String | The currency code used to express the price and discount for the price break, ensuring that the financial terms are clear and standardized (for example, USD, EUR). |
| Currency | String | The name of the currency used for the price break, helping to clarify the financial terms (for example, 'US Dollar,' 'Euro'). |
| CreatedBy | String | The name of the person or system that created the price break record, ensuring accountability for the entry. |
| CreationDate | Datetime | The date and time when the price break record was created, providing a historical record of when the price break became active. |
| LastUpdatedBy | String | The name of the person or system that last updated the price break record, ensuring accountability for changes made. |
| LastUpdateDate | Datetime | The date and time when the price break record was last updated, providing a clear record of recent modifications. |
| AgreementHeaderId | Long | The unique identifier for the purchase agreement header, linking the price break to the specific purchase agreement. |
| Finder | String | The search function or query used to locate or filter price break records, helping to retrieve specific price break details based on defined criteria. |
| EffectiveDate | Date | The date used to retrieve price break records that are effective as of this date, ensuring that the correct version of the price break is applied based on the agreement's active period. |
Configures alerts (for example, expiration, usage threshold) for purchase agreements, notifying stakeholders of key milestones.
| Name | Type | Description |
| PurchaseAgreementsAgreementHeaderId [KEY] | Long | The unique identifier for the purchase agreement header, linking all notification control records to the overall purchase agreement. |
| NotificationId [KEY] | Long | The unique identifier for the notification control associated with the purchase agreement, used to manage and track notifications. |
| ConditionCode | String | The notification type for the purchase agreement, specifying the condition or event that triggers the notification (for example, 'Reminder,' 'Expiration'). |
| Percentage | Decimal | The percentage of the purchase agreement document total that the notification is based on, used to calculate the notification value. |
| Amount | Decimal | The specific monetary amount of the purchase agreement document total that the notification applies to, often used for threshold-based notifications. |
| StartDate | Date | The effective date from which the notification becomes active, indicating when the terms of the notification should start being applied. |
| EndDate | Date | The expiration date of the notification, marking the last day on which the notification control is valid and should be considered for the purchase agreement. |
| ReminderDays | Decimal | The number of days before the expiration event that the reminder notification should be triggered, helping to provide timely alerts before critical dates. |
| CreatedBy | String | The name of the user or system responsible for creating the notification control on the purchase agreement, ensuring accountability for data entry. |
| CreationDate | Datetime | The date and time when the notification control for the purchase agreement was created, providing a historical record of when the control was implemented. |
| LastUpdatedBy | String | The name of the user or system responsible for the last update made to the notification control of the purchase agreement, ensuring accountability for changes. |
| LastUpdateDate | Datetime | The date and time when the notification control for the purchase agreement was last updated, reflecting the most recent changes to the notification terms. |
| AgreementHeaderId | Long | The unique identifier for the purchase agreement header, linking this notification control record to the corresponding agreement. |
| Finder | String | The search function or query used to locate or filter notification controls associated with the purchase agreement, allowing for easy retrieval based on criteria. |
| EffectiveDate | Date | The date used to fetch notification control records that are effective as of the specified start date, ensuring accurate data retrieval based on the active period. |
Represents finalized purchase orders for goods or services from external suppliers, capturing key terms and statuses.
| Name | Type | Description |
| POHeaderId [KEY] | Long | The unique identifier for the purchase order header, linking all details of the purchase order to its overall record. |
| OrderNumber | String | The unique order number assigned to the purchase order, used for tracking and referencing the order within the procurement process. |
| SoldToLegalEntityId | Long | The unique identifier for the legal entity to which the purchase order is billed, ensuring accurate invoicing and financial processing. |
| SoldToLegalEntity | String | The name of the legal entity to which the purchase order is billed, providing clarity for financial operations and legal records. |
| StatusCode | String | The status code representing the current state of the purchase order, such as 'Open,' 'Closed,' 'Pending.' |
| Status | String | The human-readable status of the purchase order, reflecting its current stage in the procurement and approval process. |
| ProcurementBUId | Long | The unique identifier for the procurement business unit responsible for managing and overseeing the purchase order. |
| ProcurementBU | String | The name of the procurement business unit that owns and manages the purchase order, ensuring proper oversight and management. |
| RequisitioningBUId | Long | The unique identifier for the business unit that initiated the purchase requisition, linking the order to the requesting department. |
| RequisitioningBU | String | The name of the business unit that created the requisition, providing context for which department initiated the purchase. |
| BillToBUId | Long | The unique identifier for the business unit responsible for processing supplier invoices for the purchase order. |
| BillToBU | String | The name of the business unit responsible for processing the invoices for the purchase order, ensuring proper financial accountability. |
| Revision | Decimal | The revision number of the purchase order, used to track changes or updates to the original order. |
| BuyerId | Long | The unique identifier for the buyer managing the purchase order, ensuring accountability for the procurement process. |
| Buyer | String | The name of the buyer responsible for managing and overseeing the purchase order, ensuring proper execution of procurement tasks. |
| SupplierId | Long | The unique identifier for the supplier providing the goods or services, ensuring accurate supplier tracking and relations. |
| Supplier | String | The name of the supplier fulfilling the purchase order, providing clarity on who is responsible for delivery. |
| SupplierSiteId | Long | The unique identifier for the supplier site from which goods or services are provided, ensuring proper delivery and fulfillment. |
| SupplierSite | String | The name or identifier of the supplier site, providing context for the logistics of fulfilling the purchase order. |
| SupplierContactId | Long | The unique identifier for the supplier contact person, ensuring direct communication with the appropriate representative. |
| SupplierContact | String | The name of the supplier's contact person, ensuring clear communication with the right individual at the supplier organization. |
| BillToLocationId | Long | The unique identifier for the location where invoices for the purchase order should be sent, ensuring proper financial processing. |
| BillToLocation | String | The name or identifier of the location where supplier invoices for the purchase order should be directed. |
| ConversionRateType | String | The type of conversion rate applied to the purchase order, used for currency exchange between different financial systems or entities. |
| Ordered | Decimal | The total number of items ordered in the purchase order, used to track quantity and manage procurement. |
| OrderedAmountBeforeAdjustments | Decimal | The total amount of the order before any adjustments, such as discounts or taxes, are applied. |
| CreditAmount | Decimal | The total amount of credit applied to the purchase order, often due to returns, overpayments, or negotiated discounts. |
| DiscountAmount | Decimal | The total discount amount applied to the purchase order, providing financial relief or savings on the order. |
| CurrencyCode | String | The currency code used for the purchase order, indicating which currency the financial amounts are represented in (for example, USD, EUR). |
| Currency | String | The name of the currency used for the purchase order, providing clarity on the currency type in use for the transaction. |
| TotalTax | Decimal | The total tax amount applied to the purchase order, ensuring compliance with local tax regulations and financial reporting. |
| Total | Decimal | The total value of the purchase order, including items, taxes, and any applicable discounts or adjustments. |
| Description | String | A brief description of the purchase order, summarizing the nature of the purchase or purpose of the order. |
| MasterContractId | Long | The unique identifier for the master contract associated with the purchase order, linking the order to a broader contractual agreement. |
| MasterContractNumber | String | The number associated with the master contract, used to reference and manage the overarching contractual terms. |
| MasterContractTypeId | Long | The unique identifier for the type of master contract, used to classify the nature of the agreement (for example, blanket, framework). |
| MasterContractType | String | The type of master contract associated with the purchase order, indicating the contract's structure and terms (for example, 'Framework,' 'Blanket'). |
| RequiredAcknowledgmentCode | String | The code indicating whether a supplier acknowledgment is required for the purchase order, and if so, at what level (for example, header, item). |
| RequiredAcknowledgment | String | The acknowledgment requirement for the supplier, indicating if the supplier must confirm receipt or terms of the purchase order. |
| SupplierOrder | String | The order number assigned by the supplier for the goods or services being provided, used to track the supplier’s fulfillment. |
| ReferenceNumber | String | A reference number used for external tracking or for communication with suppliers, often used in EDI or for audit purposes. |
| AcknowledgmentDueDate | Date | The date by which the supplier is required to acknowledge receipt or acceptance of the purchase order. |
| PaymentTermsId | Long | The unique identifier for the payment terms associated with the purchase order, used for scheduling payments. |
| PaymentTerms | String | The payment terms specified in the purchase order, indicating the conditions under which payment is due (for example, 'Net 30'). |
| CarrierId | Long | The unique identifier for the carrier responsible for delivering the goods in the purchase order, ensuring proper logistics tracking. |
| Carrier | String | The name of the carrier responsible for the delivery of goods under the purchase order, providing context for shipping logistics. |
| ModeOfTransportCode | String | The code representing the mode of transport used to deliver the goods (for example, 'Air,' 'Sea,' 'Land'). |
| ModeOfTransport | String | The mode of transport used for delivering the goods or services under the purchase order, clarifying shipping logistics (for example, 'Air,' 'Truck'). |
| ServiceLevelCode | String | The code representing the level of service for the delivery, such as 'Expedited,' 'Standard.' |
| ServiceLevel | String | The description of the service level for the delivery, indicating the speed and quality of the transportation service (for example, 'Overnight,' '2-Day'). |
| ShippingMethod | String | The method used for shipping the goods under the purchase order, providing clarity on the delivery method. |
| FreightTermsCode | String | The code representing the freight terms for the order, specifying the responsibility for shipping costs (for example, 'FOB'). |
| FreightTerms | String | The freight terms for the order, describing who pays for shipping (for example, 'FOB Origin,' 'Prepaid'). |
| FOBCode | String | The code representing the freight on board (FOB) terms, defining the point at which ownership of goods transfers from seller to buyer. |
| FOB | String | The description of the freight on board (FOB) terms, indicating when the risk and ownership of the goods are transferred (for example, 'FOB Origin'). |
| RequiresSignatureFlag | Bool | Indicates whether a signature is required upon delivery of the goods, providing security and confirmation of receipt. |
| AcknowledgeWithinDays | Decimal | The number of days within which the supplier is required to acknowledge the purchase order, ensuring timely responses. |
| BuyerManagedTransportFlag | Bool | Indicates whether the buying company is responsible for arranging transportation, ensuring clarity on who handles logistics. |
| PayOnReceiptFlag | Bool | Indicates whether payment for the order should be made upon receipt of the goods, helping manage financial terms. |
| ConfirmingOrderFlag | Bool | Indicates whether the purchase order is a confirmation of a previous order, helping to track order statuses. |
| NoteToSupplier | String | A note or special instruction directed to the supplier, providing additional context or requests related to the purchase order. |
| NoteToReceiver | String | Special instructions for the receiving party, helping to clarify handling, inspection, or any other special requirements for the received goods. |
| CreationDate | Datetime | The date and time when the purchase order was created, providing a historical record of when the order was initiated. |
| CreatedBy | String | The name of the user or system that created the purchase order, ensuring accountability for the data entry. |
| LastUpdateDate | Datetime | The date and time when the purchase order was last updated, ensuring that the most recent changes are reflected. |
| LastUpdatedBy | String | The name of the user or system that last updated the purchase order, ensuring accountability for any modifications. |
| ImportSourceCode | String | The code representing the source from which the purchase order was imported, such as an external system or manual entry. |
| OverridingApproverId | Long | The unique identifier for the user responsible for overriding approval processes for the purchase order. |
| OverridingApprover | String | The name of the user responsible for overriding the approval processes for the purchase order, ensuring accountability for exceptions. |
| SupplierCommunicationMethodCode | String | The code representing the method of communication with the supplier (for example, 'Email,' 'Fax'). |
| SupplierBccEmailAddress | String | The email address to which a blind carbon copy (BCC) of the purchase order will be sent for supplier communication. |
| SupplierEmailAddress | String | The email address to which the purchase order will be sent for supplier communication, ensuring direct contact. |
| SupplierFax | String | The fax number to which the purchase order can be sent for supplier communication, in case of manual order processing. |
| SupplierCcEmailAddress | String | The email address to which a carbon copy (CC) of the purchase order will be sent for supplier communication. |
| OverrideB2BCommunicationFlag | Bool | Indicates whether business-to-business communication settings should be overridden for this purchase order. |
| AdditionalContactEmail | String | The email address of an additional contact person related to the purchase order, providing an alternative method of communication. |
| SpecialHandlingType | String | The type of special handling required for the goods under the purchase order, such as 'Fragile' or 'Temperature Sensitive.' |
| SpecialHandlingTypeCode | String | The code representing the special handling type for the purchase order, ensuring proper treatment of the goods during shipping. |
| ConversionRate | Decimal | The conversion rate applied to the purchase order for currency exchange, ensuring the correct value is calculated when multiple currencies are involved. |
| ConversionRateDate | Date | The date used to determine the applicable conversion rate for the purchase order, reflecting the correct rate based on the date of the order. |
| Requisition | String | The requisition number associated with the purchase order, linking it to the original requisition request. |
| SourceAgreement | String | The source agreement number from which the purchase order is derived, helping to track the agreement's origin. |
| SalesOrder | String | The sales order number associated with the purchase order, linking it to the sales process and tracking. |
| Negotiation | String | The negotiation identifier associated with the purchase order, providing a reference to the terms negotiated. |
| ShipToLocationId | Long | The unique identifier for the location where goods are delivered as part of the purchase order, helping with logistics. |
| ShipToLocationCode | String | The code for the location where goods are shipped, ensuring proper delivery tracking. |
| ShipToLocationAddress | String | The address of the location where goods are shipped, providing full details for shipping. |
| RequesterId | Long | The unique identifier for the person who requested the purchase order, ensuring accountability for the request. |
| RequesterDisplayName | String | The name of the person who requested the purchase order, providing clarity for tracking purposes. |
| BuyerDisplayName | String | The name of the buyer responsible for processing the purchase order, ensuring accountability for purchase order management. |
| SupplierCommunicationMethod | String | The method of communication used to contact the supplier regarding the purchase order (for example, 'Email,' 'Fax'). |
| SupplierContactDisplayName | String | The name of the supplier's contact person for the purchase order, providing a clear point of contact for communication. |
| DocumentStyleId | Long | The unique identifier for the document style associated with the purchase order, ensuring consistency in formatting and terms. |
| ProgressPaymentFlag | Bool | Indicates whether the purchase order involves progress payments, providing a flag for payment tracking. |
| PurchaseBasis | String | The basis on which the purchase order is made (for example, 'Fixed Price,' 'Time and Materials'), defining the procurement model. |
| DocumentStyle | String | The style used for the purchase order document, ensuring consistent formatting and layout across orders. |
| OverridingApproverDisplayName | String | The name of the approver responsible for overriding approval workflows for the purchase order, ensuring transparency. |
| ConsignmentTermsFlag | Bool | Indicates whether the purchase order follows consignment terms, providing flags for inventory and payment control. |
| Finder | String | The search function or query used to locate or filter purchase orders, helping to retrieve specific data based on criteria. |
| Intent | String | The intent of the purchase order, indicating whether it’s for immediate purchase, a request for quote, or another purpose. |
| SysEffectiveDate | String | The system effective date used to determine the active records at the time of the query, ensuring accurate data retrieval. |
| EffectiveDate | Date | The date from which the purchase order is effective, ensuring proper tracking and management of the order’s lifecycle. |
Stores documents (for example, contracts, specifications) linked to a purchase order, enhancing detail for audits or approvals.
| Name | Type | Description |
| PurchaseOrdersPOHeaderId [KEY] | Long | The unique identifier for the purchase order header, linking the attachment record to the associated purchase order. |
| AttachedDocumentId [KEY] | Long | The unique identifier for the document that is attached to the purchase order, providing a reference to the attached file or document. |
| LastUpdateDate | Datetime | The date and time when the attachment record was last updated, ensuring that the latest changes are reflected in the system. |
| LastUpdatedBy | String | The name of the user who last updated the attachment record, ensuring accountability for changes made to the attachment. |
| DatatypeCode | String | A code indicating the data type of the attachment, such as 'PDF,' 'image,' or 'text,' providing context for handling the file. |
| FileName | String | The name of the attachment file, used for identification and organization of the attached document. |
| DmFolderPath | String | The folder path from which the attachment was created, providing context for the file’s storage location in the document management system. |
| DmDocumentId | String | The document ID from which the attachment was created, used to track the source document in the document management system. |
| DmVersionNumber | String | The version number of the document from which the attachment was created, ensuring that the correct version is referenced. |
| Url | String | The URL of a web page attachment, used when the attachment is a web-based document or link. |
| CategoryName | String | The category or classification of the attachment, helping to organize and sort attachments based on their purpose or content. |
| UserName | String | The login credentials of the user who created the attachment, ensuring accountability for the upload process. |
| Uri | String | The URI for Topology Manager type attachments, providing a unique identifier for the attachment in the system. |
| FileUrl | String | The URI of the file, allowing direct access to the attachment for download or viewing. |
| UploadedText | String | The text content of a new text attachment, used when the attachment is plain text rather than a file. |
| UploadedFileContentType | String | The content type of the uploaded attachment, indicating its format. |
| UploadedFileLength | Long | The size of the attachment file in bytes, providing information on the file's storage requirements. |
| UploadedFileName | String | The name assigned to the newly uploaded attachment file, used for identification and management within the system. |
| ContentRepositoryFileShared | Bool | Indicates whether the attachment is shared with other users or systems, allowing for collaborative access. |
| Title | String | The title of the attachment, typically used for quick identification of the attachment's purpose or content. |
| Description | String | A detailed description of the attachment, providing context and information about the file’s contents or significance. |
| ErrorStatusCode | String | The error code associated with the attachment, if any, providing insight into issues encountered during the attachment process. |
| ErrorStatusMessage | String | The error message associated with the attachment, if any, offering details about why the attachment failed or encountered an issue. |
| CreatedBy | String | The name of the user who created the attachment record, ensuring accountability for the upload process. |
| CreationDate | Datetime | The date and time when the attachment record was created, providing a historical record of when the file was added to the system. |
| FileContents | String | The contents of the attachment, used when the attachment is text-based or to hold metadata about the file. |
| ExpirationDate | Datetime | The expiration date of the attachment’s contents, indicating when the attachment should no longer be considered valid or active. |
| LastUpdatedByUserName | String | The username of the person who last updated the attachment record, providing transparency regarding changes. |
| CreatedByUserName | String | The username of the person who originally created the attachment record, ensuring tracking of the file’s origin. |
| AsyncTrackerId | String | An attribute provided for the exclusive use by the Attachment UI components to assist in uploading files asynchronously. |
| FileWebImage | String | The Base64 encoded image of the file, displayed in PNG format if the source is a convertible image, providing a visual representation of the attachment. |
| DownloadInfo | String | A JSON object represented as a string, containing information necessary for programmatically retrieving the file attachment. |
| PostProcessingAction | String | The name of the action that can be performed after the attachment is uploaded, such as 'Process' or 'Notify.' |
| Finder | String | The search function or query used to locate or filter attachment records, helping to retrieve specific attachments based on defined criteria. |
| Intent | String | The intent of the attachment, providing context on how the attachment is to be used or processed (for example, 'Invoice,' 'PO Document'). |
| POHeaderId | Long | The purchase order header ID that links this attachment to a specific purchase order, ensuring that the attachment is correctly associated with the order. |
| SysEffectiveDate | String | The system effective date used to determine the active version of the attachment, ensuring that the correct version is retrieved based on its effective date. |
| EffectiveDate | Date | The date used to fetch attachment records that are effective as of this date, ensuring accurate data retrieval based on the active period. |
Manages delivery schedules within a purchase order, tracking ship-to locations, dates, and associated quantities.
| Name | Type | Description |
| SoldToLegalEntityId | Long | The unique identifier for the legal entity that the purchase order is billed to, ensuring proper invoicing and legal alignment. |
| POHeaderId | Long | The unique identifier for the purchase order header, linking the purchase order schedule to its associated header. |
| OrderNumber | String | The unique order number associated with the purchase order, used for tracking and reference in procurement processes. |
| BuyerId | Long | The unique identifier for the buyer handling the purchase order schedule, ensuring accountability for procurement activities. |
| POLineId | Long | The unique identifier for the purchase order line, linking the schedule to a specific item or service on the purchase order. |
| ItemDescription | String | A detailed description of the item or service associated with the purchase order schedule, providing context for procurement. |
| ItemId | Long | The unique identifier for the item associated with the purchase order schedule, ensuring accurate tracking and fulfillment. |
| LineNumber | Decimal | The line number for the item or service in the purchase order schedule, used for sorting and tracking within the order. |
| UOMCode | String | The unit of measure code used for the item or service in the purchase order schedule, ensuring consistency in how quantities are measured. |
| SupplierItem | String | The identifier assigned by the supplier for the item, allowing for matching between the buyer's order and the supplier's catalog. |
| CategoryId | Long | The unique identifier for the purchasing category associated with the item in the purchase order schedule, aiding in classification. |
| LineLocationId [KEY] | Long | The unique identifier for the location associated with the purchase order line, ensuring proper logistics and inventory management. |
| ScheduleNumber | Long | The unique number assigned to the schedule in the purchase order, used to track delivery or shipment details. |
| ShipToLocationId | Long | The unique identifier for the location to which the goods or services will be shipped, providing clarity for logistics. |
| RequestedDeliveryDate | Date | The date on which the buyer requests the delivery of the goods or services associated with the purchase order schedule. |
| ScheduleStatusCode | String | The status code representing the current state of the schedule, such as 'Pending,' 'Shipped,' or 'Received.' |
| ClosedReason | String | The reason for closing the schedule, providing context for the completion or cancellation of the scheduled item or service. |
| InvoiceMatchOptionCode | String | The code representing the invoice matching option for the purchase order schedule, specifying the matching criteria (for example, 'PO Invoice,' 'Receipt Invoice'). |
| BilledQuantity | Decimal | The quantity of items billed in the purchase order schedule, providing insight into invoicing against the schedule. |
| ShippedQuantity | Decimal | The quantity of items shipped as part of the purchase order schedule, helping track the fulfillment progress. |
| ReceivedQuantity | Decimal | The quantity of items received as part of the purchase order schedule, indicating how much of the order has been delivered. |
| AcceptedQuantity | Decimal | The quantity of items accepted by the buyer from the scheduled delivery, confirming the successful receipt of goods or services. |
| BilledAmount | Decimal | The total billed amount for the scheduled items, reflecting the monetary value of the billed goods or services. |
| ShippedAmount | Decimal | The total amount corresponding to the shipped items in the purchase order schedule, helping track partial deliveries. |
| ReceivedAmount | Decimal | The total amount for the received items, showing how much has been received and accounted for from the purchase order schedule. |
| AcceptedAmount | Decimal | The total amount for the items accepted by the buyer, ensuring financial records reflect only accepted quantities. |
| ShipToCustomerId | Long | The unique identifier for the customer to whom the goods are shipped, often used in the context of direct sales or distribution. |
| SoldToLegalEntity | String | The name of the legal entity to which the purchase order schedule is billed, ensuring proper invoicing and tax processing. |
| UOM | String | The unit of measure used for the items or services in the purchase order schedule, ensuring uniformity in measurement (for example, 'Units,' 'Boxes'). |
| ShipToLocationCode | String | The code representing the location where the goods or services are to be delivered, used for routing logistics. |
| ScheduleStatus | String | The descriptive status of the schedule, indicating whether it is open, closed, or partially fulfilled. |
| PaymentTermsId | Long | The unique identifier for the payment terms associated with the purchase order schedule, dictating the payment schedule and conditions. |
| FreightTermsCode | String | The code representing the freight terms for the purchase order schedule, indicating the responsibility for shipping costs (for example, 'FOB'). |
| Category | String | The name of the purchasing category associated with the purchase order schedule, aiding in inventory and procurement classification. |
| CategoryCode | String | The code associated with the purchasing category, used for categorization and reporting of purchase order schedules. |
| Buyer | String | The name of the buyer responsible for the purchase order schedule, ensuring accountability for procurement actions. |
| InvoiceMatchOption | String | The descriptive option used for invoice matching against the purchase order schedule, determining how invoices are reconciled. |
| PaymentTerms | String | The terms of payment for the purchase order schedule, such as 'Net 30' or 'Due on Receipt,' determining when payment is expected. |
| FreightTerms | String | The description of the freight terms for the purchase order schedule, clarifying the responsibility for shipping costs (for example, 'Prepaid,' 'Collect'). |
| ShipToCustomer | String | The name of the customer to whom the goods are shipped, ensuring proper delivery logistics and customer service. |
| PurchaseBasisCode | String | The code representing the purchase basis, such as 'Fixed Price,' 'Time and Materials,' which dictates the purchasing model. |
| ItemNumber | String | The item number assigned to the product in the purchase order schedule, used for identification and tracking. |
| Total | Decimal | The total value of the purchase order schedule, accounting for the cost of all items and services within the schedule. |
| TotalTax | Decimal | The total tax amount applied to the purchase order schedule, ensuring accurate financial records and compliance with tax regulations. |
| PurchaseBasis | String | The basis on which the purchase order schedule is made, such as 'Fixed Price' or 'Time and Materials,' specifying the procurement structure. |
| Quantity | Decimal | The quantity of items ordered in the purchase order schedule, used for inventory tracking and fulfillment. |
| Amount | Decimal | The total monetary value of the items or services in the purchase order schedule, before tax and adjustments. |
| ShipToLocation | String | The name or identifier for the location where the goods are shipped, providing details for fulfillment and delivery. |
| DocumentStatusCode | String | The status code of the document associated with the purchase order schedule, used for tracking its approval and processing stage. |
| DocumentStatus | String | The descriptive status of the document, reflecting its current state in the approval, processing, or completion stages. |
| AnticipatedArrivalDate | Date | The anticipated arrival date for the goods or services, helping plan for receipt and inventory management. |
| CreationDate | Datetime | The date and time when the purchase order schedule was created, serving as a historical reference for procurement. |
| RequestedShipDate | Date | The requested shipping date for the goods or services in the purchase order schedule, setting expectations for delivery. |
| Supplier | String | The name of the supplier fulfilling the purchase order schedule, ensuring clarity on the supplier's role in the transaction. |
| SupplierId | Long | The unique identifier for the supplier associated with the purchase order schedule, ensuring accurate supplier records. |
| SupplierSiteId | Long | The unique identifier for the supplier site associated with the purchase order schedule, used for logistics and inventory management. |
| SupplierSite | String | The name of the supplier's site responsible for fulfilling the order, helping with delivery and contact management. |
| RetainageRate | Decimal | The rate at which payment is withheld for the purchase order schedule, often used in construction or long-term contracts. |
| RetainageAmount | Decimal | The amount withheld from payment as retainage, typically used in contracts requiring performance completion before full payment. |
| RetainageReleasedAmount | Decimal | The amount of retainage that has been released, representing funds that were previously withheld but are now available for payment. |
| ProcurementBUId | Long | The unique identifier for the procurement business unit managing the purchase order schedule, ensuring proper procurement oversight. |
| ProcurementBU | String | The name of the procurement business unit that owns and manages the purchase order schedule, ensuring proper budget and resource allocation. |
| RequisitioningBUId | Long | The unique identifier for the business unit that initiated the requisition for the purchase order schedule, linking the order to its origin. |
| RequisitioningBU | String | The name of the requisitioning business unit, providing insight into the department or unit that requested the purchase order. |
| ScheduleDescription | String | A description of the schedule, providing additional context or details about the goods or services being ordered. |
| ScheduleTypeCode | String | The code representing the type of schedule, indicating whether it is a regular, emergency, or backorder schedule. |
| ScheduleType | String | The descriptive name of the schedule type, clarifying the nature of the scheduled order (for example, 'Backorder,' 'Standard'). |
| DocumentStyleId | Long | The unique identifier for the document style associated with the purchase order schedule, ensuring consistent presentation and formatting. |
| DocumentStyle | String | The name or identifier for the document style applied to the purchase order schedule, ensuring a consistent look and feel across procurement documents. |
| FundsStatusCode | String | The code representing the status of funds allocated for the purchase order schedule, indicating whether funds are available or restricted. |
| FundsStatus | String | The descriptive status of the funds allocated for the purchase order schedule, providing insight into financial availability. |
| AccrueAtReceiptFlag | Bool | Indicates whether the financial accrual should be recognized upon receipt of goods or services, ensuring proper accounting treatment. |
| Price | Decimal | The unit price of the item or service in the purchase order schedule, providing the cost per unit for budgeting and financial records. |
| LineNumberScheduleNumber | String | A unique identifier combining the line number and schedule number, used to track specific items or services in the schedule. |
| ItemOrScheduleDescription | String | A description of either the item or schedule, providing more context for the goods or services being ordered. |
| DueDate | String | The due date for the completion of the schedule, setting expectations for the delivery or fulfillment timeline. |
| Finder | String | The search function or query used to locate specific purchase order schedules, providing efficient filtering and retrieval of data. |
| Intent | String | The purpose or intent of the purchase order schedule, clarifying whether it is for an immediate purchase, contract fulfillment, or other procurement goals. |
| SysEffectiveDate | String | The system effective date that determines which version of the data is valid based on the date of the query, ensuring accurate data retrieval. |
| EffectiveDate | Date | The effective date from which the purchase order schedule is valid, determining the applicable schedule version for the given time period. |
Captures additional descriptive flexfield data at the purchase order header level, allowing custom fields.
| Name | Type | Description |
| PurchaseOrdersPOHeaderId [KEY] | Long | The unique identifier for the purchase order header, linking the descriptive flexfield (DFF) attributes to the purchase order header. |
| PoHeaderId [KEY] | Long | The unique identifier for the purchase order header, used to link the DFF data to a specific purchase order. |
| ContractType | String | The type of contract associated with the purchase order, specifying whether it is a fixed price, time and materials, or another type of contract. |
| Contractnumber | String | The contract number associated with the purchase order, providing a reference to the contract governing the terms of the purchase. |
| _FLEX_Context | String | The context for the descriptive flexfield, indicating the specific business context in which the data is entered or used (for example, 'Purchase Order,' 'Supplier Agreement'). |
| Finder | String | The search function or query used to locate or filter purchase orders DFF records, helping users retrieve specific data based on defined criteria. |
| Intent | String | The intent behind the purchase order, specifying whether it is for immediate purchase, contract fulfillment, or another procurement purpose. |
| SysEffectiveDate | String | The system effective date used to determine the active version of the DFF record, ensuring that the data retrieved corresponds to the correct period. |
| EffectiveDate | Date | The date from which the DFF data is considered effective, determining when the descriptive attributes of the purchase order become valid. |
Houses global descriptive flexfields used across purchase orders to accommodate standardized international or enterprise data.
| Name | Type | Description |
| PurchaseOrdersPOHeaderId [KEY] | Long | The unique identifier for the purchase order header, linking the global descriptive flexfield (DFF) attributes to the corresponding purchase order. |
| PoHeaderId [KEY] | Long | The unique identifier for the purchase order header, used to associate the global DFF data with a specific purchase order. |
| _FLEX_Context | String | The context for the global descriptive flexfield, indicating the specific business context in which the data is entered or used (for example, 'Purchase Order,' 'Supplier Agreement'). |
| _FLEX_Context_DisplayValue | String | The display value of the context for the global descriptive flexfield, providing a human-readable label for the context in which the DFF data applies. |
| Finder | String | The search function or query used to locate or filter global DFF records for purchase orders, enabling users to retrieve specific data based on criteria. |
| Intent | String | The purpose or intent of the purchase order, specifying whether it is for immediate purchase, contract fulfillment, or other procurement objectives. |
| SysEffectiveDate | String | The system effective date used to determine the active version of the global DFF data, ensuring that the correct data is retrieved based on the effective period. |
| EffectiveDate | Date | The date from which the global DFF data is considered effective, marking when the descriptive attributes of the purchase order are valid. |
Lists line-level details within a purchase order, specifying items, quantities, unit prices, and related buying terms.
| Name | Type | Description |
| PurchaseOrdersPOHeaderId [KEY] | Long | The unique identifier for the purchase order header, linking the purchase order lines to the associated purchase order header. |
| POLineId [KEY] | Long | The unique identifier for the purchase order line, used to track specific items or services within a purchase order. |
| POHeaderId | Long | The unique identifier for the purchase order header, used to group and associate the purchase order line with the overall order. |
| LineNumber | Decimal | The line number associated with the purchase order line, used for sorting and referencing specific items or services in the purchase order. |
| OrderNumber | String | The unique order number associated with the purchase order, used for tracking the order in procurement and fulfillment processes. |
| LineTypeId | Long | The unique identifier for the line type, indicating the category of items or services represented by the purchase order line. |
| LineType | String | The descriptive name of the line type, such as 'Goods,' 'Services,' or 'Maintenance,' indicating the nature of the item or service. |
| ItemId | Long | The unique identifier for the item associated with the purchase order line, ensuring accurate product identification and tracking. |
| Item | String | The name or code of the item associated with the purchase order line, used to identify the product or service ordered. |
| ConsignmentLineFlag | Bool | Indicates whether the purchase order line is for consignment goods, determining the payment structure based on goods consumption. |
| ItemRevision | String | The revision number or identifier for the item, used to track updates or changes to the item specification. |
| Description | String | A detailed description of the item or service on the purchase order line, providing context for the procurement. |
| SupplierItem | String | The identifier assigned by the supplier for the item, allowing for easy matching between the buyer's order and the supplier's catalog. |
| SupplierConfigurationId | String | The identifier for the configuration set by the supplier, used to specify customized or configurable items. |
| CategoryId | Long | The unique identifier for the category to which the item belongs, helping with classification for inventory and procurement. |
| CategoryCode | String | The code representing the purchasing category for the item, used for reporting and classification within procurement systems. |
| Category | String | The name of the purchasing category for the item, providing a more human-readable classification for procurement management. |
| StatusCode | String | The code representing the current status of the purchase order line, such as 'Open,' 'Completed,' or 'Cancelled.' |
| Status | String | The descriptive status of the purchase order line, indicating its current state in the procurement process. |
| UOMCode | String | The unit of measure code used for the item, ensuring consistent tracking of quantities ordered and received. |
| UOM | String | The abbreviation for the unit of measure for the item, ensuring consistency in how quantities are measured (for example, 'EA' for each, 'KG' for kilograms). |
| Quantity | Decimal | The quantity of the item ordered on the purchase order line, used for inventory tracking and order fulfillment. |
| BasePrice | Decimal | The base price of the item on the purchase order line, used for calculating the cost before any discounts or adjustments. |
| DiscountType | String | The type of discount applied to the purchase order line, such as 'Percentage' or 'Amount,' indicating how the discount is calculated. |
| Discount | Decimal | The value of the discount applied to the purchase order line, reducing the base price of the item. |
| DiscountReason | String | The reason for applying the discount, providing context for why the item received a discount (for example, 'Promotional' or 'Negotiated Price'). |
| Price | Decimal | The total price of the item on the purchase order line, including any discounts or adjustments applied to the base price. |
| NegotiatedFlag | Bool | Indicates whether the price on the purchase order line was negotiated between the buyer and the supplier. |
| CurrencyCode | String | The currency code used for the purchase order line, ensuring the correct currency is applied to the price and amounts. |
| Currency | String | The currency associated with the purchase order line, indicating the financial currency used for the transaction. |
| WorkOrderProduct | String | The identifier for the product or service linked to a work order, used in maintenance or project-based procurement. |
| NoteToSupplier | String | Any special instructions or notes provided to the supplier regarding the purchase order line, helping with the fulfillment process. |
| UNNumberId | Long | The unique identifier for the UN (United Nations) number associated with hazardous materials on the purchase order line. |
| UNNumber | String | The UN number assigned to hazardous materials, used for safety, shipping, and regulatory compliance. |
| UNNumberDescription | String | A description of the UN number, providing further details on the type and classification of hazardous material. |
| HazardClassCode | String | The code representing the hazard class of the material on the purchase order line, used for compliance and safety regulations. |
| HazardClassId | Long | The unique identifier for the hazard class of the material, ensuring proper classification for hazardous materials. |
| HazardClass | String | The descriptive name of the hazard class, such as 'Flammable,' 'Toxic,' or 'Corrosive,' used for regulatory and safety purposes. |
| Ordered | Decimal | The quantity of items ordered in the purchase order line, used for tracking order progress and fulfillment. |
| TotalTax | Decimal | The total amount of tax applied to the purchase order line, helping with financial reporting and compliance. |
| Total | Decimal | The total value of the purchase order line, including the cost of items and any applied tax or fees. |
| SourceAgreementId | Long | The unique identifier for the source agreement associated with the purchase order line, linking it to a negotiated contract or framework agreement. |
| SourceAgreementNumber | String | The number of the source agreement, providing a reference to the contract under which the items are being purchased. |
| SourceAgreementLineId | Long | The unique identifier for the line item within the source agreement, specifying the terms for that particular item. |
| SourceAgreementLine | Decimal | The line number or identifier within the source agreement, used to specify which agreement line corresponds to the purchase order line. |
| SourceAgreementTypeCode | String | The code representing the type of source agreement, such as 'Framework,' 'Spot Purchase,' or 'Contract.' |
| SourceAgreementType | String | The descriptive name of the source agreement type, clarifying whether the agreement is a contract, framework, or other type of agreement. |
| SourceAgreementProcurementBUId | Long | The unique identifier for the procurement business unit associated with the source agreement, ensuring alignment with the correct department. |
| SourceAgreementProcurementBU | String | The name of the procurement business unit associated with the source agreement, helping identify the responsible department. |
| MaximumRetainageAmount | Decimal | The maximum amount of retainage that can be withheld for the purchase order line, typically used in contracts requiring performance completion. |
| Manufacturer | String | The name of the manufacturer of the item, helping to identify the source of production and support traceability. |
| ManufacturerPartNumber | String | The part number assigned by the manufacturer for the item, helping with identification and compatibility. |
| CreationDate | Datetime | The date and time when the purchase order line was created, providing a timestamp for record-keeping and process tracking. |
| CreatedBy | String | The user who created the purchase order line, ensuring accountability and traceability. |
| LastUpdateDate | Datetime | The date and time when the purchase order line was last updated, reflecting the most recent change or adjustment. |
| LastUpdatedBy | String | The user who last updated the purchase order line, ensuring proper documentation of modifications. |
| PricingUOM | String | The unit of measure for pricing, determining how the price of the item is calculated per unit. |
| PricingUOMCode | String | The code for the unit of measure used for pricing the item, ensuring clarity in financial calculations. |
| SecondaryUOM | String | The secondary unit of measure for the item, used when a different measurement unit is required for the item (for example, kilograms instead of pieces). |
| SecondaryUOMCode | String | The code for the secondary unit of measure, ensuring consistent tracking and conversion between measurement units. |
| SecondaryQuantity | String | The quantity of the item in the secondary unit of measure, used for reporting and conversion purposes. |
| NegotiationId | Long | The unique identifier for the negotiation associated with the purchase order line, linking it to the negotiation process. |
| Negotiation | String | The name or identifier of the negotiation associated with the purchase order line, providing context for pricing or contract terms. |
| NegotiationLine | Decimal | The line number associated with the negotiation, helping to identify specific terms or offers within the negotiation. |
| CreditFlag | Bool | Indicates whether the purchase order line is associated with a credit, such as returns or adjustments, affecting the financial records. |
| Finder | String | The search function or query used to locate or filter specific purchase order lines based on defined criteria. |
| Intent | String | The intent behind the purchase order line, clarifying whether the item is being purchased for immediate use, stock, or other specific purposes. |
| SysEffectiveDate | String | The system effective date used to determine the active version of the data, ensuring correct data retrieval based on the effective period. |
| EffectiveDate | Date | The date from which the purchase order line is valid, marking when the descriptive attributes of the purchase order line are in effect. |
Contains attached documents for individual purchase order lines, such as technical specs or regulatory certifications.
| Name | Type | Description |
| PurchaseOrdersPOHeaderId [KEY] | Long | The unique identifier for the purchase order header, linking the purchase order line attachment records to the corresponding purchase order. |
| LinesPOLineId [KEY] | Long | The unique identifier for the purchase order line, used to associate the attachment with a specific item or service on the purchase order. |
| AttachedDocumentId [KEY] | Long | The unique identifier assigned to the document that is attached to the purchase order line, enabling easy reference and access to the attachment. |
| LastUpdateDate | Datetime | The date and time when the attachment record was last updated, indicating when any modifications were made to the attachment information. |
| LastUpdatedBy | String | The username of the individual who last updated the attachment record, ensuring accountability for any changes made to the attachment. |
| DatatypeCode | String | The code representing the data type of the attachment, indicating the format or type (for example, 'PDF,' 'JPEG') of the attached document. |
| FileName | String | The name of the file attached to the purchase order line, used to identify and locate the document in the system. |
| DmFolderPath | String | The folder path in the document management system (DMS) where the attachment is stored, allowing for proper organization and retrieval of the file. |
| DmDocumentId | String | The document ID in the document management system (DMS) from which the attachment is created, providing a reference to the original document. |
| DmVersionNumber | String | The version number of the document from which the attachment is created, helping track changes and updates to the attached file. |
| Url | String | The URL link to a web-based attachment, providing easy access to the file hosted online. |
| CategoryName | String | The category under which the attachment is classified, helping to organize and filter attachments based on their content or purpose. |
| UserName | String | The login credentials of the user who created the attachment, providing traceability of the user responsible for uploading the file. |
| Uri | String | The URI (Uniform Resource Identifier) for a Topology Manager type attachment, providing access to the attachment within the system. |
| FileUrl | String | The URL pointing to the location of the attachment file, used to directly retrieve the document from the storage system. |
| UploadedText | String | The text content of the attachment, if the attachment is a text-based file, enabling easy access to the document's contents without downloading. |
| UploadedFileContentType | String | The content type of the file, specifying its format. |
| UploadedFileLength | Long | The size of the attachment file in bytes, used to track the storage space required for the file. |
| UploadedFileName | String | The name to be assigned to a new attachment file, helping with file naming and retrieval. |
| ContentRepositoryFileShared | Bool | Indicates whether the file is shared across the system or kept private, allowing for proper access control. |
| Title | String | The title or heading of the attachment, providing a brief description or label for the document. |
| Description | String | A detailed description of the attachment, providing further context for the content and purpose of the file. |
| ErrorStatusCode | String | The error code returned, if any, related to the attachment upload or processing, used for troubleshooting and resolving issues. |
| ErrorStatusMessage | String | The error message corresponding to the error code, providing detailed information about what went wrong during the attachment process. |
| CreatedBy | String | The username of the person who created the attachment record, ensuring traceability and accountability for the creation of the file. |
| CreationDate | Datetime | The date and time when the attachment record was created, marking the initial creation and entry of the attachment into the system. |
| FileContents | String | The actual content of the attachment, used for text-based attachments where the file content is stored directly in the record. |
| ExpirationDate | Datetime | The expiration date for the contents of the attachment, used for determining how long the file remains valid or accessible. |
| LastUpdatedByUserName | String | The username of the person who last updated the attachment record, providing accountability for any changes made after the record was created. |
| CreatedByUserName | String | The username of the person who created the attachment record, ensuring proper traceability of the file's origin. |
| AsyncTrackerId | String | An attribute used by the Attachment UI components to assist in managing asynchronous file upload processes. |
| FileWebImage | String | The Base64 encoded image of the file, displayed in .png format, if the source file is an image that can be converted for display. |
| DownloadInfo | String | A JSON object represented as a string, containing information needed to programmatically retrieve the file attachment, used for automation or API interactions. |
| PostProcessingAction | String | The name of the action that can be taken once the attachment is uploaded, such as processing or validation steps. |
| Finder | String | The search function or query used to locate or filter specific attachment records based on defined criteria. |
| Intent | String | The purpose or intent behind the attachment, providing clarity on why the attachment is associated with the purchase order. |
| POHeaderId | Long | The unique identifier for the purchase order header, linking the attachment record to the overall purchase order. |
| SysEffectiveDate | String | The system effective date used to determine the active version of the attachment record, ensuring that the correct file is retrieved based on its effective period. |
| EffectiveDate | Date | The date from which the attachment is considered effective, marking when the attachment's data is valid and applicable. |
Offers descriptive flexfields for purchase order lines, capturing extra information beyond the standard line fields.
| Name | Type | Description |
| PurchaseOrdersPOHeaderId [KEY] | Long | The unique identifier for the purchase order header, linking the corresponding purchase order line DFF (Descriptive Flexfield) record to the main purchase order. |
| LinesPOLineId [KEY] | Long | The unique identifier for the purchase order line, which associates the descriptive flexfield data with a specific item or service in the purchase order. |
| PoLineId [KEY] | Long | The identifier for the purchase order line, linking the descriptive flexfield data to a particular line item within the purchase order. |
| _FLEX_Context | String | A system-generated context code that defines the context or the environment in which the flexfield data is being used or displayed in the application. |
| _FLEX_Context_DisplayValue | String | A human-readable version of the _FLEX_Context value, providing a descriptive label or name to indicate the specific context for the flexfield data. |
| Finder | String | A search or filter function used to locate specific flexfield records based on criteria defined in the finder field. |
| Intent | String | The purpose or intent behind the flexfield entry, used to clarify the objective or use of the data in relation to the purchase order line. |
| POHeaderId | Long | The unique identifier for the purchase order header, ensuring that the descriptive flexfield data is correctly associated with the right purchase order. |
| SysEffectiveDate | String | The system's effective date for the descriptive flexfield record, determining which version of the data is active and applicable during a given time period. |
| EffectiveDate | Date | The date from which the descriptive flexfield data is considered effective, marking when the data should be used in the system. |
Defines the planned shipment dates and delivery details for each line item in a purchase order.
| Name | Type | Description |
| PurchaseOrdersPOHeaderId [KEY] | Long | The unique identifier for the header of the purchase order in the PurchaseOrderslinesschedules table. |
| LinesPOLineId [KEY] | Long | The unique identifier for the individual line item of the purchase order in the PurchaseOrderslinesschedules table. |
| LineLocationId [KEY] | Long | The identifier that represents the location associated with the purchase order line in the PurchaseOrderslinesschedules table. |
| POLineId | Long | The identifier of the purchase order line within the PurchaseOrderslinesschedules table, used to reference a specific line. |
| POHeaderId | Long | The identifier for the purchase order header, linking the purchase order line to its header in the PurchaseOrderslinesschedules table. |
| ScheduleNumber | Decimal | A numerical identifier for the schedule associated with the purchase order line in the PurchaseOrderslinesschedules table. |
| StatusCode | String | The code representing the current status of the purchase order line schedule (for example, Open, Closed, Pending). |
| Quantity | Decimal | The quantity of items specified in the purchase order line schedule. |
| SecondaryQuantity | Decimal | The secondary quantity, usually representing a different unit of measure, for the purchase order line schedule. |
| SecondaryUOMCode | String | The unit of measure code for the secondary quantity (for example, cases, boxes) in the purchase order line schedule. |
| Ordered | Decimal | The total ordered quantity for the purchase order line schedule. |
| CountryOfOriginCode | String | The code representing the country of origin for the goods in the purchase order line schedule. |
| ShipToLocationId | Long | The identifier of the location to which the items in the purchase order line schedule are shipped. |
| ShipToOrganizationId | Long | The identifier of the organization responsible for receiving the shipment in the purchase order line schedule. |
| ShipToCustomerId | Long | The identifier of the customer to which the items in the purchase order line schedule are being shipped. |
| BackToBackFlag | Bool | Indicates whether the purchase order line is linked to a sales order or other fulfillment process (True/False). |
| SalesOrderNumber | String | The number of the sales order related to the purchase order line schedule, if applicable. |
| DestinationTypeCode | String | The code that identifies the type of destination for the shipment (for example, customer, warehouse). |
| ModeOfTransportCode | String | The transport method used to ship the purchase order line items (for example, Air, Sea, Land). |
| EarlyReceiptToleranceDays | Decimal | The tolerance in days that defines how early a receipt can be processed compared to the promised delivery date. |
| LateReceiptToleranceDays | Decimal | The tolerance in days that defines how late a receipt can be processed compared to the promised delivery date. |
| ReceiptDateExceptionActionCode | String | The code specifying the action to take when a receipt date exception occurs. |
| ShipToExceptionActionCode | String | The code specifying the action to take when there is an exception with the shipping address. |
| ReceiptCloseTolerancePercent | Decimal | The percentage tolerance allowed for receipt quantities before the system considers the receipt closed. |
| OverReceiptTolerancePercent | Decimal | The percentage tolerance allowed for over-receipt quantities compared to the ordered quantity. |
| OverReceiptActionCode | String | The code indicating the action to take when the quantity received exceeds the expected amount. |
| ReceiptRoutingId | Long | The identifier for the routing path used for receiving goods associated with the purchase order line schedule. |
| AllowSubstituteReceiptsFlag | Bool | Indicates whether substitute items can be received instead of the originally ordered items (True/False). |
| InvoiceMatchOptionCode | String | The code representing the matching option for invoices (for example, Match to Purchase Order, Match to Receipt). |
| InvoiceCloseTolerancePercent | Decimal | The percentage tolerance allowed for invoice amounts before the system considers the invoice closed. |
| AccrueAtReceiptFlag | Bool | Indicates whether accruals should be created at the time of receipt (True/False). |
| NoteToReceiver | String | A note or comment provided for the receiver of the goods, often including special instructions. |
| WorkOrderId | Long | The unique identifier for the work order associated with the purchase order line schedule, if applicable. |
| WorkOrderNumber | String | The work order number related to the purchase order line schedule. |
| OrchestrationAgreementLineNumber | Long | The line number in the orchestration agreement related to the purchase order line schedule. |
| OrchestrationAgreementNumber | String | The orchestration agreement number associated with the purchase order line schedule. |
| PrimaryTradeRelationshipId | Long | The identifier for the primary trade relationship related to the purchase order line schedule. |
| POTradingOrganizationId | Long | The identifier for the organization involved in the purchase order trading relationship. |
| POTradingOrganizationCode | String | The code for the trading organization associated with the purchase order line schedule. |
| POTradingOrganization | String | The name or description of the trading organization linked to the purchase order. |
| RequestedDeliveryDate | Date | The requested delivery date for the goods in the purchase order line schedule. |
| PromisedDeliveryDate | Date | The date on which the goods are promised to be delivered, as agreed upon in the purchase order. |
| RequestedShipDate | Date | The requested shipment date for the purchase order line items. |
| PromisedShipDate | Date | The promised shipment date for the goods in the purchase order line schedule. |
| WorkOrderOperationSequence | Decimal | The operation sequence number for a specific work order associated with the purchase order line schedule. |
| Status | String | The current status of the purchase order line schedule (for example, Open, Approved, Closed). |
| DestinationType | String | The type of destination associated with the purchase order line (for example, Warehouse, Store, Customer). |
| InvoiceMatchOption | String | The invoice match option for the purchase order line, determining how the system matches invoices with receipts. |
| LineNumber | Decimal | The line number within the purchase order line schedule, used for referencing individual items. |
| UOM | String | The unit of measure for the primary quantity in the purchase order line schedule (for example, Each, Box, Pallet). |
| SecondaryUOM | String | The unit of measure for the secondary quantity in the purchase order line schedule. |
| ShipToLocationCode | String | The code for the location to which the goods in the purchase order line are shipped. |
| ShipToCustomer | String | The name or code of the customer to whom the goods are being shipped. |
| Carrier | String | The name of the carrier company responsible for delivering the goods in the purchase order line schedule. |
| ModeOfTransport | String | The transportation method used to ship the goods for the purchase order line schedule (for example, Truck, Air, Ship). |
| ReceiptDateExceptionAction | String | The action to take when a receipt date is outside of the expected range. |
| ShipToExceptionAction | String | The action to take when there is an issue with the shipping address. |
| OverReceiptAction | String | The action to take when more goods than expected are received for the purchase order line. |
| ReceiptRouting | String | The routing or process for receiving goods in the purchase order line schedule. |
| OriginalPromisedDeliveryDate | Date | The original date on which the delivery of the goods was promised, before any updates. |
| OriginalPromisedShipDate | Date | The original date on which the shipment of goods was promised, before any changes. |
| CurrencyCode | String | The currency code (for example, USD, EUR) used for the purchase order line schedule. |
| Currency | String | The type of currency (for example, US Dollar, Euro) used for the financial transactions of the purchase order line schedule. |
| CountryOfOrigin | String | The country of origin for the goods in the purchase order line schedule. |
| OrderNumber | String | The purchase order number associated with the line item schedule. |
| TotalTax | Decimal | The total tax amount calculated for the purchase order line schedule. |
| Total | Decimal | The total value of the purchase order line schedule, including items, tax, and other fees. |
| MatchApprovalLevelCode | String | The code indicating the level of approval required for matching purchase orders, receipts, and invoices. |
| LastAcceptableDeliveryDate | Date | The last acceptable delivery date for the purchase order line schedule before penalties or delays apply. |
| LastAcceptableShipDate | Date | The last acceptable shipment date for the goods in the purchase order line schedule. |
| LastAcceptDate | Date | The most recent date on which the purchase order line schedule was accepted by the system. |
| CarrierId | Long | The unique identifier for the carrier handling the shipment for the purchase order line schedule. |
| ShipToOrganization | String | The name of the organization responsible for receiving the goods in the purchase order line schedule. |
| ShipToOrganizationCode | String | The code for the organization receiving the goods in the purchase order line schedule. |
| RetainageRate | Decimal | The percentage of the total amount to be withheld (retainage) for the purchase order line schedule. |
| RetainageAmount | Decimal | The actual amount withheld (retainage) from the total value of the purchase order line schedule. |
| RetainageReleasedAmount | Decimal | The amount of retainage that has been released and paid for the purchase order line schedule. |
| Description | String | A description or comment about the purchase order line schedule, providing more context or details. |
| Type | String | The type of purchase order line, indicating its classification (for example, Standard, Service, Subcontract). |
| Price | Decimal | The price per unit for the items in the purchase order line schedule. |
| TypeCode | String | The code representing the type of the purchase order line (for example, Standard or Service). |
| UOMCode | String | The unit of measure code for the purchase order line (for example, Each or Box). |
| CreationDate | Datetime | The date and time when the purchase order line schedule was created. |
| CreatedBy | String | The user or system that created the purchase order line schedule entry. |
| LastUpdateDate | Datetime | The date and time when the purchase order line schedule was last updated. |
| LastUpdatedBy | String | The user or system that last updated the purchase order line schedule. |
| PricingUOMCode | String | The unit of measure code used for pricing the items in the purchase order line schedule. |
| PricingUOM | String | The unit of measure used to price the items in the purchase order line schedule. |
| BilledAmount | Decimal | The amount billed for the items in the purchase order line schedule. |
| ReceivedAmount | Decimal | The total value of items received against the purchase order line schedule. |
| BilledQuantity | Decimal | The quantity of items that have been billed in the purchase order line schedule. |
| ReceivedQuantity | Decimal | The quantity of items that have been received against the purchase order line schedule. |
| ShippingMethod | String | The method of shipping selected for the purchase order line schedule (for example, Ground, Air Freight). |
| ShipToCustomerLocationId | Long | The unique identifier for the customer location where the items are shipped. |
| ShipToCustomerLocation | String | The name or description of the location to which the goods are being shipped. |
| Finder | String | A placeholder or reference for a lookup process within the system. |
| Intent | String | A placeholder or reference for the intent or purpose related to the purchase order line schedule. |
| SysEffectiveDate | String | The system effective date for the data, indicating when the current data state was applied. |
| EffectiveDate | Date | The date from which the resource or data is effective, used as a filter for queries that require specific date ranges. |
Manages attachments for purchase order schedules, such as shipping instructions or agreement references.
| Name | Type | Description |
| PurchaseOrdersPOHeaderId [KEY] | Long | The unique identifier for the header of the purchase order in the PurchaseOrderslinesschedulesattachments table. |
| LinesPOLineId [KEY] | Long | The identifier for the individual line item in the purchase order related to the attachment, linking to the PurchaseOrderslinesschedulesattachments table. |
| SchedulesLineLocationId [KEY] | Long | The identifier for the location associated with the specific schedule line for the purchase order in the PurchaseOrderslinesschedulesattachments table. |
| AttachedDocumentId [KEY] | Long | The unique identifier assigned to the document attached to the purchase order line schedule, linking the document to the schedule. |
| LastUpdateDate | Datetime | The date and time when the record for the attachment was last modified. |
| LastUpdatedBy | String | The name or identifier of the user who last made changes to the attachment record. |
| DatatypeCode | String | A code that represents the type of data for the attachment (for example, text, file, image). |
| FileName | String | The name of the file attached to the purchase order line schedule, typically the document's original name. |
| DmFolderPath | String | The folder path in the document management system where the attachment was stored or retrieved from. |
| DmDocumentId | String | The document ID that identifies the source document from which the attachment is created in the document management system. |
| DmVersionNumber | String | The version number of the document associated with the attachment, indicating which version of the document is being referenced. |
| Url | String | The URL pointing to a web page representing the attachment, typically for web-based document types. |
| CategoryName | String | The category or type classification for the attachment (for example, Invoice, Receipt, Purchase Order). |
| UserName | String | The username of the individual who uploaded or created the attachment. |
| Uri | String | The URI associated with a Topology Manager attachment, pointing to its location or resource. |
| FileUrl | String | The URI or link to access the attached file, often used to directly download or view the attachment. |
| UploadedText | String | The textual content for an attachment of type text, such as a description, notes, or comments associated with the attachment. |
| UploadedFileContentType | String | The content type of the attachment, indicating its format. |
| UploadedFileLength | Long | The size of the attachment file in bytes. |
| UploadedFileName | String | The name assigned to a new attachment file being uploaded, which could be different from the original file name. |
| ContentRepositoryFileShared | Bool | Indicates whether the attached file is shared with other users or entities (True/False). |
| Title | String | The title or name of the attachment, often used for display or identification purposes in the system. |
| Description | String | A description providing context or additional information about the attached file or document. |
| ErrorStatusCode | String | The error code indicating any issue encountered during the attachment upload or processing. |
| ErrorStatusMessage | String | A detailed error message explaining any issue or failure related to the attachment. |
| CreatedBy | String | The name or identifier of the user who created the attachment record. |
| CreationDate | Datetime | The date and time when the attachment record was initially created in the system. |
| FileContents | String | The contents or raw data of the attachment file, typically in Base64 encoding for non-file attachments. |
| ExpirationDate | Datetime | The expiration date of the attachment content, after which the attachment may no longer be accessible or valid. |
| LastUpdatedByUserName | String | The username of the individual who last updated or modified the attachment record. |
| CreatedByUserName | String | The username of the individual who initially created the attachment record. |
| AsyncTrackerId | String | An identifier used by the Attachment UI components to track and manage the asynchronous process of file uploads. |
| FileWebImage | String | The Base64 encoded image of the file displayed in .png format, if the source attachment is an image that can be rendered. |
| DownloadInfo | String | A JSON object represented as a string containing information required to programmatically retrieve or download the attached file. |
| PostProcessingAction | String | The name of the action or process to be executed after the attachment has been successfully uploaded (for example, validation, conversion). |
| Finder | String | A placeholder or reference used for searching or locating the attachment within the system. |
| Intent | String | A placeholder or reference used to define the purpose or intent of the attachment within the system (for example, Review, Approval). |
| POHeaderId | Long | The identifier for the purchase order header associated with the attachment, used for linking the attachment to the purchase order. |
| SysEffectiveDate | String | The system effective date for the attachment data, indicating when the data was last valid or applied. |
| EffectiveDate | Date | The date from which the attachment is considered effective, used as a filter for retrieving attachments based on their validity. |
Enables descriptive flexfields at the schedule level, supporting specialized shipping or delivery requirements.
| Name | Type | Description |
| PurchaseOrdersPOHeaderId [KEY] | Long | The unique identifier for the header of the purchase order in the PurchaseOrderslinesschedulesDFF table, linking the table to the purchase order header. |
| LinesPOLineId [KEY] | Long | The identifier for the individual line item in the purchase order associated with the data in the PurchaseOrderslinesschedulesDFF table. |
| SchedulesLineLocationId [KEY] | Long | The identifier for the location associated with the specific schedule line in the purchase order, used within the PurchaseOrderslinesschedulesDFF table. |
| LineLocationId [KEY] | Long | The identifier for the location of the purchase order line item in the PurchaseOrderslinesschedulesDFF table, used for linking schedule and location information. |
| _FLEX_Context | String | A system-generated context used for tracking and managing the context of Flexfields associated with the purchase order line schedule in the PurchaseOrderslinesschedulesDFF table. |
| _FLEX_Context_DisplayValue | String | A display-friendly value representing the context of the Flexfield for the purchase order line schedule, making it easier for users to interpret the data. |
| Finder | String | A placeholder or reference for the search functionality within the system used to locate the relevant data associated with the purchase order line schedule. |
| Intent | String | A placeholder or reference that defines the purpose or action associated with the purchase order line schedule in the system, such as 'Create', 'Update', or 'Delete'. |
| POHeaderId | Long | The identifier for the purchase order header, used to link the Flexfield data to the specific purchase order in the PurchaseOrderslinesschedulesDFF table. |
| SysEffectiveDate | String | The system-effective date indicating when the data in the PurchaseOrderslinesschedulesDFF table became active or valid, used for tracking changes over time. |
| EffectiveDate | Date | The date from which the data in the PurchaseOrderslinesschedulesDFF table is considered effective, commonly used as a filter to retrieve records based on their effective date. |
Allocates purchase order schedule costs to particular accounts or projects, ensuring accurate financial tracking.
| Name | Type | Description |
| PurchaseOrdersPOHeaderId [KEY] | Long | The unique identifier for the header of the purchase order in the PurchaseOrderslinesschedulesdistributions table, linking distribution data to the purchase order header. |
| LinesPOLineId [KEY] | Long | The identifier for the individual line item within the purchase order, connecting the distribution data to the specific line in the purchase order. |
| SchedulesLineLocationId [KEY] | Long | The identifier representing the location associated with the purchase order line schedule for the distribution, helping to track the location of the distribution. |
| PODistributionId [KEY] | Long | The unique identifier for the distribution record associated with a purchase order line in the PurchaseOrderslinesschedulesdistributions table. |
| POLineId | Long | The identifier of the purchase order line item, used to reference the distribution for that specific line in the purchase order. |
| POHeaderId | Long | The identifier for the purchase order header, linking the distribution data to the overall purchase order. |
| DistributionNumber | Decimal | A unique number assigned to the distribution, identifying it within the purchase order line schedule. |
| Quantity | Decimal | The quantity of items associated with the distribution in the purchase order line schedule. |
| Ordered | Decimal | The total quantity ordered in the distribution for the purchase order line schedule. |
| TotalTax | Decimal | The total tax amount applied to the distribution for the purchase order line schedule. |
| UOMCode | String | The unit of measure code representing the quantity used for the distribution (for example, Each, Box, Pallet). |
| Total | Decimal | The total value of the distribution, including items and any applicable taxes or additional charges. |
| UOM | String | The unit of measure for the distribution quantity, such as 'Each', 'Box', or 'Pallet'. |
| CurrencyCode | String | The currency code (for example, USD, EUR) used in the distribution for the purchase order line schedule. |
| Currency | String | The name or type of currency (for example, US Dollar, Euro) used in the purchase order line schedule distribution. |
| DestinationSubinventory | String | The subinventory code that indicates where the distributed goods are being stored or allocated. |
| RequesterId | Long | The unique identifier for the individual requesting the purchase order distribution. |
| Requester | String | The name or identifier of the person or entity requesting the purchase order distribution. |
| DeliverToLocationId | Long | The identifier for the location where the distributed goods are to be delivered within the purchase order line schedule. |
| DeliverToLocationCode | String | The code for the location where the goods are being delivered, typically used for reference within the system. |
| DeliverToCustomerLocationId | Long | The identifier for the customer location to which the distributed goods are being delivered. |
| DeliverToCustomerLocation | String | The name or description of the customer location where the goods are delivered. |
| DeliverToCustomerId | Long | The identifier for the customer receiving the distributed goods, linking the distribution to a specific customer. |
| DeliverToCustomer | String | The name or identifier of the customer receiving the goods in the purchase order distribution. |
| Requisition | String | The requisition number associated with the purchase order line schedule distribution. |
| RequisitionHeaderId | Long | The unique identifier for the requisition header associated with the purchase order distribution. |
| RequisitionLine | Decimal | The line number of the requisition associated with the distribution in the purchase order line schedule. |
| RequisitionLineId | Long | The unique identifier for the requisition line associated with the purchase order line schedule distribution. |
| RequisitionDistribution | Decimal | The distribution number within the requisition, representing the allocation of the requisition to the purchase order. |
| RequisitionDistributionId | Long | The unique identifier for the requisition distribution record linked to the purchase order line schedule distribution. |
| DestinationChargeAccountId | Long | The identifier for the charge account used for the destination of the distributed goods in the purchase order line schedule. |
| DestinationChargeAccount | String | The charge account used to allocate the costs for the destination in the purchase order line schedule distribution. |
| POChargeAccountId | Long | The identifier for the purchase order charge account used in the distribution process for the purchase order line. |
| POChargeAccount | String | The charge account used for the purchase order, specifying where the financial charges related to the distribution are allocated. |
| POAccrualAccountId | Long | The identifier for the accrual account used for the purchase order line schedule distribution. |
| POAccrualAccount | String | The accrual account used for financial accounting purposes related to the purchase order line schedule distribution. |
| DestinationVarianceAccountId | Long | The identifier for the variance account used to track discrepancies in the distribution of purchase order line items. |
| DestinationVarianceAccount | String | The account used to track any variances in the distribution process of the purchase order line items. |
| POVarianceAccountId | Long | The identifier for the variance account linked to the purchase order line schedule, used to track financial discrepancies. |
| POVarianceAccount | String | The account associated with the purchase order for tracking variances in the distribution process. |
| BudgetDate | Date | The date associated with the budget for the distribution, indicating when the funds are allocated for the purchase order line schedule. |
| ConversionRateDate | Date | The date on which the currency conversion rate is based for the distribution in the purchase order line schedule. |
| ConversionRate | Decimal | The rate at which the currency is converted for the purchase order line schedule distribution. |
| ConversionRateType | String | The type of conversion rate applied for the distribution, such as 'Spot Rate' or 'Forward Rate'. |
| RecoverableInclusiveTax | Decimal | The recoverable tax amount included in the distribution, which can be reclaimed by the buyer or organization. |
| RecoverableExclusiveTax | Decimal | The recoverable tax amount exclusive of other costs, eligible for reclamation under specific conditions. |
| NonrecoverableInclusiveTax | Decimal | The non-recoverable tax amount included in the distribution, which cannot be reclaimed. |
| NonrecoverableExclusiveTax | Decimal | The non-recoverable tax amount exclusive of other costs, which cannot be reclaimed under any circumstances. |
| ScheduleNumber | Decimal | The schedule number that links the distribution to a specific schedule in the purchase order line. |
| LineNumber | Decimal | The line number associated with the purchase order line schedule distribution, used to identify individual items. |
| OrderNumber | String | The unique identifier for the order associated with the purchase order line schedule distribution. |
| CreationDate | Datetime | The date and time when the purchase order distribution was created. |
| CreatedBy | String | The username or identifier of the person who created the distribution record in the purchase order line schedule. |
| LastUpdateDate | Datetime | The date and time when the distribution record was last updated or modified. |
| LastUpdatedBy | String | The username or identifier of the person who last updated the purchase order line schedule distribution. |
| Percentage | Decimal | The percentage allocation of the distribution, typically used to divide the total order or budget across various accounts or items. |
| Status | String | The current status of the distribution, such as 'Pending', 'Approved', or 'Completed'. |
| StatusCode | String | A code representing the status of the distribution, used for tracking and workflow purposes. |
| RequesterDisplayName | String | The display name of the individual who requested the purchase order distribution, used for clarity in reports and workflows. |
| DFF | String | The Flexfield data associated with the distribution, capturing custom attributes for the purchase order line schedule. |
| projectDFF | String | The project-specific Flexfield data associated with the purchase order distribution, capturing project-related information. |
| globalDFFs | String | The global Flexfield data, capturing custom attributes that apply universally across all distributions in the system. |
| Finder | String | A placeholder or reference for the search functionality used to locate specific distribution data. |
| Intent | String | A placeholder or reference defining the action or purpose of the distribution within the system, such as 'Create', 'Update', or 'Delete'. |
| SysEffectiveDate | String | The system-effective date indicating when the distribution data became active or valid in the system. |
| EffectiveDate | Date | The date from which the distribution data is considered effective, used as a filter to retrieve records within the valid date range. |
Holds global descriptive flexfields for purchase order schedules, enabling consistent enterprise or region-level data.
| Name | Type | Description |
| PurchaseOrdersPOHeaderId [KEY] | Long | The unique identifier for the header of the purchase order in the PurchaseOrderslinesschedulesglobalDFFs table, linking global DFF data to the purchase order header. |
| LinesPOLineId [KEY] | Long | The identifier for the individual line item within the purchase order, connecting global DFF data to the specific purchase order line. |
| SchedulesLineLocationId [KEY] | Long | The identifier representing the location associated with the specific schedule line in the purchase order, used to track the location for global DFF data. |
| LineLocationId [KEY] | Long | The identifier for the location of the purchase order line item in the PurchaseOrderslinesschedulesglobalDFFs table, used for linking location data to the global DFF. |
| _FLEX_Context | String | A system-generated context that helps in tracking and managing the Flexfield data related to the purchase order line schedule in the PurchaseOrderslinesschedulesglobalDFFs table. |
| _FLEX_Context_DisplayValue | String | A display-friendly value representing the context of the Flexfield for the purchase order line schedule, providing users with a readable interpretation of the data. |
| Finder | String | A placeholder or reference for the search functionality used to locate specific global DFF data within the system. |
| Intent | String | A placeholder or reference that defines the action or purpose associated with the global DFF data, such as 'Create', 'Update', or 'Delete'. |
| POHeaderId | Long | The identifier for the purchase order header, linking the global DFF data to the overall purchase order. |
| SysEffectiveDate | String | The system-effective date indicating when the global DFF data became active or valid, helping to track changes and data validity. |
| EffectiveDate | Date | The date from which the global DFF data is considered effective, typically used to filter records based on their effective date. |
Provides a quick search interface for existing purchase orders, aiding users in referencing or reusing prior orders.
| Name | Type | Description |
| OrderNumber | String | The unique identifier for the purchase order in the PurchaseOrdersLOV table, representing the order number assigned to the purchase order. |
| POHeaderId [KEY] | Long | The unique identifier for the purchase order header in the PurchaseOrdersLOV table, linking to the overall purchase order record. |
| Supplier | String | The name or description of the supplier associated with the purchase order in the PurchaseOrdersLOV table. |
| SupplierId | Long | The unique identifier for the supplier in the PurchaseOrdersLOV table, used to reference the specific supplier providing goods or services. |
| SupplierSite | String | The name or code representing the specific site of the supplier from which goods or services are provided for the purchase order. |
| SupplierSiteId | Long | The unique identifier for the supplier site, used to link the purchase order to a specific supplier location. |
| BillToBU | String | The business unit responsible for receiving the invoice related to the purchase order in the PurchaseOrdersLOV table. |
| BillToBUId | Long | The unique identifier for the business unit that will receive the invoice for the purchase order. |
| Buyer | String | The name or identifier of the individual or role responsible for managing the purchase order within the organization. |
| BuyerId | Long | The unique identifier for the buyer responsible for the purchase order in the PurchaseOrdersLOV table. |
| Currency | String | The name or type of currency (for example, USD, EUR) used in the financial transactions of the purchase order. |
| CurrencyCode | String | The currency code (for example, USD, EUR) used for the purchase order, representing the type of currency in which the order is processed. |
| SoldToLegalEntity | String | The name of the legal entity to which the purchase order is billed or sold. |
| SoldToLegalEntityId | Long | The unique identifier for the legal entity associated with the sold-to entity of the purchase order. |
| Description | String | A description or additional information about the purchase order, often providing more context on the order’s purpose or content. |
| PaymentTerms | String | The payment terms associated with the purchase order, such as 'Net 30', indicating when payment for the order is due. |
| PaymentTermsId | Long | The unique identifier for the payment terms, used to link the purchase order to specific payment terms in the system. |
| Status | String | The current status of the purchase order, such as 'Open', 'Closed', or 'Pending', representing the state of the order. |
| StatusCode | String | A code representing the status of the purchase order for internal processing and tracking. |
| Finder | String | A placeholder or reference for the search functionality within the system, allowing for easy lookup of purchase orders based on specified criteria. |
| Intent | String | A placeholder or reference defining the action or purpose of the purchase order data, such as 'Create', 'Update', or 'Delete'. |
| SysEffectiveDate | String | The system-effective date indicating when the purchase order data became active or valid in the system. |
| EffectiveDate | Date | The date from which the purchase order data is considered effective, typically used as a filter to retrieve records within a valid date range. |
Maintains documents attached to purchase requisitions, such as quotes, justifications, or requirement definitions.
| Name | Type | Description |
| PurchaseRequisitionsRequisitionHeaderId [KEY] | Long | The unique identifier for the requisition header associated with the attachment, linking the attachment to a specific requisition. |
| AttachedDocumentId [KEY] | Long | The unique identifier for the attached document, used to track and reference the document in the system. |
| LastUpdateDate | Datetime | The date and time when the attachment record was last updated, reflecting the most recent modification to the attachment data. |
| LastUpdatedBy | String | The username or identifier of the user who last modified the attachment record. |
| DatatypeCode | String | An abbreviation that represents the type of data for the attachment (for example, PDF, DOCX, IMAGE). |
| FileName | String | The name of the attached file, typically reflecting the original file name before upload. |
| DmFolderPath | String | The path of the folder from which the document was attached, used to locate the source document within the document management system. |
| DmDocumentId | String | The unique identifier for the document in the document management system from which the attachment is derived. |
| DmVersionNumber | String | The version number of the document from which the attachment was created, helping to track document revisions. |
| Url | String | The URL that points to a web-based attachment, typically used for web page or online content attachments. |
| CategoryName | String | The name of the category assigned to the attachment, used for organizing and classifying attachments (for example, Invoice, Receipt). |
| UserName | String | The username of the person who created the attachment record, identifying the individual responsible for the attachment. |
| Uri | String | The URI (Uniform Resource Identifier) associated with a topology manager type attachment, pointing to its location. |
| FileUrl | String | The URL used to access the file attachment, enabling users to download or view the file. |
| UploadedText | String | The contents of a text file attachment, typically stored in plain text format. |
| UploadedFileContentType | String | The content type of the uploaded file, indicating its format. |
| UploadedFileLength | Long | The size of the uploaded file, measured in bytes. |
| UploadedFileName | String | The name assigned to the uploaded file, which may differ from the original file name. |
| ContentRepositoryFileShared | Bool | Indicates whether the attachment is shared with other users or systems (True/False). |
| Title | String | The title of the attachment, often used for display purposes to describe the content of the attachment. |
| Description | String | A description of the attachment, providing additional context or information about the file. |
| ErrorStatusCode | String | The error code, if any, related to the attachment, indicating issues during upload or processing. |
| ErrorStatusMessage | String | The error message, if any, describing the issue encountered during the attachment's processing. |
| CreatedBy | String | The username or identifier of the user who created the attachment record in the system. |
| CreationDate | Datetime | The date and time when the attachment record was created in the system. |
| FileContents | String | The contents of the file as text, typically used for text-based attachments such as documents or notes. |
| ExpirationDate | Datetime | The date when the attachment's contents are no longer valid or accessible, after which the attachment may be deleted or archived. |
| LastUpdatedByUserName | String | The username of the person who last updated the attachment record. |
| CreatedByUserName | String | The username of the person who initially created the attachment record. |
| AsyncTrackerId | String | A unique identifier used to track the asynchronous upload process of files, ensuring proper tracking of upload progress. |
| FileWebImage | String | The Base64-encoded image representation of the file, displayed in .png format, if the file is an image that can be rendered. |
| DownloadInfo | String | A JSON object, represented as a string, containing all necessary information required to programmatically retrieve or download the attachment. |
| PostProcessingAction | String | The name of the post-upload action that can be performed on the attachment, such as validation, approval, or conversion. |
| BindPreparerId | Long | The unique identifier used to bind the preparer’s data during operations on the attachment. |
| BindRequisitionHeaderId | Long | The unique identifier used to bind the requisition header data during operations on the attachment. |
| Finder | String | A placeholder or reference for the search functionality within the system used to locate specific attachment records. |
| RequisitionHeaderId | Long | The identifier for the requisition header linked to the attachment, used for connecting the attachment to the corresponding requisition. |
| CUReferenceNumber | Int | A reference number used to link child aggregates with their parent tables, ensuring data consistency and integrity. |
| EffectiveDate | Date | The date from which the attachment's data is considered effective, used to filter records by their validity date. |
Stores descriptive flexfields at the requisition header level, enabling custom data elements beyond standard fields.
| Name | Type | Description |
| PurchaseRequisitionsRequisitionHeaderId [KEY] | Long | The unique identifier for the requisition header associated with the descriptive flexfield (DFF) data, linking the DFF data to the corresponding requisition. |
| RequisitionHeaderId [KEY] | Long | The unique identifier for the requisition, used to reference and track the specific requisition record in the system. |
| _FLEX_Context | String | The DFF context name for the purchase requisition distribution, providing additional context or categorization for the DFF data. |
| _FLEX_Context_DisplayValue | String | The display value of the descriptive flexfield context for the purchase requisition distribution, providing a user-friendly description of the context. |
| BindPreparerId | Long | The unique identifier used to bind the preparer's data during operations on the requisition DFF record, helping to track the user responsible for the requisition. |
| BindRequisitionHeaderId | Long | The unique identifier used to bind the requisition header data during operations on the DFF record, ensuring it is correctly associated with the requisition. |
| Finder | String | A placeholder or reference used for searching and locating requisition DFF data within the system, making it easier to access related records. |
| CUReferenceNumber | Int | The reference number used to map child aggregates with their parent tables, ensuring data consistency and integrity within the system. |
| EffectiveDate | Date | The date from which the DFF data is considered effective, used to filter records based on their validity and ensure they are relevant to the specified date. |
Attaches supporting files to requisition lines, such as product specs or vendor quotes, ensuring clear documentation.
| Name | Type | Description |
| PurchaseRequisitionsRequisitionHeaderId [KEY] | Long | The unique identifier for the requisition header associated with the attachment, linking the attachment to a specific requisition. Example: 1001 for Requisition ID 1001. |
| LinesRequisitionLineId [KEY] | Long | The identifier for the requisition line within the requisition, linking the attachment to a specific line item. Example: 2001 for Line 1. |
| AttachedDocumentId [KEY] | Long | The unique identifier for the attached document, used to track and reference the document in the system. Example: 3456 for the document ID. |
| LastUpdateDate | Datetime | The date and time when the attachment record was last updated. This helps track the latest modification to the attachment. Example: '2023-01-15 09:00:00'. |
| LastUpdatedBy | String | The username or identifier of the user who last updated the attachment record. Example: 'JohnDoe' for the user making the last change. |
| DatatypeCode | String | An abbreviation representing the type of data contained in the attachment, such as 'PDF' or 'JPEG'. |
| FileName | String | The name of the attached file, reflecting the original file name. Example: 'Invoice_1001.pdf'. |
| DmFolderPath | String | The path of the folder from which the attachment was created, used to locate the source document within the document management system. Example: '/docs/invoices/'. |
| DmDocumentId | String | The unique identifier for the document in the document management system from which the attachment is derived. Example: 'DOC1234' for a specific document. |
| DmVersionNumber | String | The version number of the document from which the attachment was created. This helps track document revisions. Example: 'V1' for version 1. |
| Url | String | The URL of a web page-type attachment, pointing to a web-based document or resource. Example: 'http://example.com/attachment'. |
| CategoryName | String | The name of the attachment category, used for classification. Example: 'Invoice', 'Contract', 'Receipt'. |
| UserName | String | The login credentials of the user who created the attachment. Example: 'jdoe' for 'John Doe'. |
| Uri | String | The URI (Uniform Resource Identifier) for a topology manager-type attachment, pointing to its location in a network or system. Example: 'topo://attachment/4567'. |
| FileUrl | String | The URL of the file, providing access to the attached file for download or view. Example: 'http://example.com/file/attachment.pdf'. |
| UploadedText | String | The content of a text file attached to the requisition line. This is used when the attachment is a text-based document. Example: 'This is a contract agreement.' |
| UploadedFileContentType | String | The content type of the attached file, indicating its format. |
| UploadedFileLength | Long | The size of the attached file, measured in bytes. Example: 1048576 for a 1 MB file. |
| UploadedFileName | String | The name assigned to the uploaded file, which may differ from the original file name. Example: 'invoice_123.pdf'. |
| ContentRepositoryFileShared | Bool | Indicates whether the file is shared across systems or repositories. True if shared, False if not. Example: True for shared files. |
| Title | String | The title of the attachment, providing a brief description of its content. Example: 'Purchase Order Agreement'. |
| Description | String | A more detailed description of the attachment, offering context for the content. Example: 'This document outlines the terms for purchase order 1001.' |
| ErrorStatusCode | String | The error code, if any, indicating a problem with the attachment. Example: 'FILE_ERR' for a file error. |
| ErrorStatusMessage | String | The error message, if any, detailing the issue with the attachment. Example: 'File format not supported'. |
| CreatedBy | String | The user who initially created the attachment record, typically the person who uploaded the file. Example: 'Jane Smith'. |
| CreationDate | Datetime | The date and time when the attachment was initially created. Example: '2023-01-10 08:30:00'. |
| FileContents | String | The contents of the attached file, usually for text-based attachments. Example: 'Details of the purchase order for 100 units.' |
| ExpirationDate | Datetime | The date when the attachment expires or is no longer valid. Example: '2023-02-01 00:00:00'. |
| LastUpdatedByUserName | String | The username of the person who last updated the attachment record. Example: 'john.doe'. |
| CreatedByUserName | String | The username of the person who initially created the attachment. Example: 'janesmith'. |
| AsyncTrackerId | String | An identifier used to track the asynchronous upload process for the attachment. Example: 'upload12345'. |
| FileWebImage | String | A Base64-encoded image of the file displayed in .png format, if the file source is a convertible image. Example: 'iVBORw0KGgoAAAANSUhEU...'. |
| DownloadInfo | String | A JSON object as a string containing information used to programmatically retrieve a file attachment. Example: '{url |
| PostProcessingAction | String | The name of the action that can be performed after the attachment is uploaded, such as validation, conversion, or approval. Example: 'Approve Attachment'. |
| BindPreparerId | Long | The identifier for the preparer of the requisition line, linking the attachment to the preparer's data. Example: 5001 for 'John Doe'. |
| BindRequisitionHeaderId | Long | The identifier for the requisition header, linking the attachment to the parent requisition. Example: 2001 for 'Requisition 2001'. |
| Finder | String | A placeholder or reference for the search functionality, used to locate the attachment record. Example: 'Search Attachments'. |
| RequisitionHeaderId | Long | The identifier for the requisition header, used to link the attachment to the parent requisition header. Example: 3001 for 'Requisition Header 3001'. |
| CUReferenceNumber | Int | Maps the child aggregates (attachments) to their parent requisition or requisition line. Example: 1001 for 'Requisition Line 1'. |
| EffectiveDate | Date | The date from which the attachment is considered effective. Example: '2023-01-01', used to fetch resources that are valid from this date. |
Provides descriptive flexfields for requisition lines, capturing unique data like internal codes or cost justification details.
| Name | Type | Description |
| PurchaseRequisitionsRequisitionHeaderId [KEY] | Long | The unique identifier for the requisition header associated with the descriptive flexfield (DFF) data, linking the DFF data to a specific requisition. Example: 1001 for Requisition 1001. |
| LinesRequisitionLineId [KEY] | Long | The unique identifier for the requisition line within the requisition header, linking the DFF data to a specific requisition line. Example: 2001 for Line 1. |
| RequisitionLineId [KEY] | Long | A unique identifier for the requisition line, used to track a specific line item in the requisition. Example: 3001 for Line ID 3001. |
| _FLEX_Context | String | The DFF context name, which is used to categorize or provide additional details for the purchase requisition distributions. Example: 'PurchaseOrder' or 'MaterialRequest'. |
| _FLEX_Context_DisplayValue | String | The display value of the descriptive flexfield context, which provides a human-readable version of the context. Example: 'Purchase Order Distribution' or 'Material Request Distribution'. |
| BindPreparerId | Long | The unique identifier for the preparer who created the requisition line, helping to link the DFF data to the preparer's record. Example: 123 for 'John Doe'. |
| BindRequisitionHeaderId | Long | The unique identifier for the requisition header, linking the DFF data to the specific requisition it belongs to. Example: 2001 for 'Requisition Header 2001'. |
| Finder | String | A placeholder or reference used for searching and locating the DFF data associated with requisition lines. Example: 'Search by Line ID' or 'Search by Category'. |
| RequisitionHeaderId | Long | The identifier for the requisition header, used to link the DFF data to the parent requisition record. Example: 1001 for Requisition Header 1001. |
| CUReferenceNumber | Int | The reference number used to map the child aggregates (such as DFF data) to their parent requisition or requisition line, ensuring data integrity. Example: 2001 for 'Requisition Line 1'. |
| EffectiveDate | Date | The date from which the DFF data is considered effective. This is typically used to filter records based on the validity of the data. Example: '2023-01-01' for data valid from the beginning of the year. |
Splits the requisition line cost across multiple accounts or projects, aiding correct budget and financial reporting.
| Name | Type | Description |
| PurchaseRequisitionsRequisitionHeaderId [KEY] | Long | The unique identifier for the requisition header associated with the distribution, linking the distribution to the specific requisition. Example: 1001 for Requisition Header 1001. |
| LinesRequisitionLineId [KEY] | Long | The identifier for the requisition line within the requisition header, linking the distribution to a specific line item. Example: 2001 for Line 1. |
| RequisitionDistributionId [KEY] | Long | The unique identifier for the distribution associated with a requisition line, used to track the allocation of costs and resources. Example: 3001 for Distribution ID 3001. |
| RequisitionLineId | Long | The unique identifier for the requisition line, linking the distribution to a specific item or service requested. Example: 4001 for Line ID 4001. |
| Quantity | Decimal | The quantity of goods being purchased in this requisition distribution. Example: 10 for ten units of a product. |
| DistributionNumber | Decimal | A number that uniquely identifies the distribution associated with a purchase requisition line. Example: 1 for the first distribution of a requisition line. |
| ChargeAccountId | Long | The unique identifier for the account that the purchase from a requisition is charged to, used for accounting and reporting. Example: 5001 for 'General Expense'. |
| ChargeAccount | String | The name or description of the account that the purchase is charged to. Example: 'Office Supplies' or 'Capital Equipment'. |
| CurrencyAmount | Decimal | The monetary amount associated with the distribution line in the currency of the supplier, helping to track the financial allocation. Example: 1000 for $1000 worth of goods. |
| CurrencyNonrecoverableExclusiveTax | Decimal | The amount of non-recoverable exclusive tax in the currency of the supplier for the requisition distribution. Example: 50 for $50 of tax that cannot be recovered. |
| CurrencyRecoverableExclusiveTax | Decimal | The amount of recoverable exclusive tax in the currency of the supplier for the requisition distribution. Example: 30 for $30 of tax that can be recovered. |
| ChartOfAccountId | Long | The identifier for the chart of accounts used in the requisition distribution, linking it to the specific accounting structure. Example: 1001 for 'Office Supplies Account'. |
| UserAccountOverrideFlag | Bool | Indicates whether the user has overridden the default account for the requisition distribution. Example: True if the account was manually changed. |
| BudgetDate | Date | The date from which the budget is consumed for the requisition distribution. This date helps determine which budget period is affected. Example: '2023-01-01' for the start of the year. |
| FundsStatusCode | String | The code representing the funds status for the requisition distribution, indicating whether funds are available or exhausted. Example: 'AVAILABLE' for funds that are still available. |
| FundsStatus | String | The description of the funds status for the requisition distribution, explaining whether the funds are sufficient or insufficient. Example: 'Funds Available' or 'Funds Insufficient'. |
| BindPreparerId | Long | The unique identifier for the preparer of the requisition line, linking the distribution to the preparer's data. Example: 5001 for 'John Doe'. |
| BindRequisitionHeaderId | Long | The unique identifier for the requisition header, linking the distribution to the parent requisition record. Example: 2001 for 'Requisition Header 2001'. |
| Finder | String | A placeholder used for searching and filtering requisition distributions. It helps locate specific distribution records. Example: 'Search by Distribution Number'. |
| RequisitionHeaderId | Long | The identifier for the requisition header associated with the requisition distribution. This links the distribution to the overall requisition. Example: 1001 for 'Requisition Header 1001'. |
| CUReferenceNumber | Int | The reference number used to map child aggregates, such as distributions, to their parent requisition or requisition line. Example: 2001 for 'Requisition Line 1'. |
| EffectiveDate | Date | The date from which the requisition distribution is considered effective. This is used to filter records that are valid from this date onward. Example: '2023-01-01' for the start of the year. |
Enables descriptive flexfields for requisition line distributions, adding specialized data for cost allocations.
| Name | Type | Description |
| PurchaseRequisitionsRequisitionHeaderId [KEY] | Long | The unique identifier for the requisition header associated with the descriptive flexfield (DFF) data, linking the DFF data to a specific requisition. Example: 1001 for Requisition Header 1001. |
| LinesRequisitionLineId [KEY] | Long | The identifier for the requisition line within the requisition header, linking the DFF data to a specific line item. Example: 2001 for Line 1. |
| DistributionsRequisitionDistributionId [KEY] | Long | The unique identifier for the distribution associated with the requisition line, helping to track the allocation of costs and resources. Example: 3001 for Distribution ID 3001. |
| DistributionId [KEY] | Long | The unique identifier for the requisition distribution, used to track the distribution of costs or items within the requisition. Example: 4001 for Distribution 4001. |
| _FLEX_Context | String | The DFF context name, used to categorize or provide additional details for the requisition distribution. Example: 'PurchaseOrder' or 'MaterialRequest'. |
| _FLEX_Context_DisplayValue | String | The display value for the DFF context, providing a human-readable description of the context. Example: 'Purchase Order Distribution' or 'Material Request Distribution'. |
| BindPreparerId | Long | The unique identifier for the preparer who created the requisition line, helping to link the DFF data to the preparer's record. Example: 123 for 'John Doe'. |
| BindRequisitionHeaderId | Long | The unique identifier for the requisition header, linking the DFF data to the parent requisition. Example: 2001 for 'Requisition Header 2001'. |
| Finder | String | A placeholder or reference used for searching and locating the DFF data associated with requisition distributions. Example: 'Search by Distribution ID'. |
| RequisitionHeaderId | Long | The identifier for the requisition header, linking the DFF data to the specific requisition. Example: 1001 for Requisition Header 1001. |
| CUReferenceNumber | Int | The reference number used to map the child aggregates (such as DFF data) to their parent requisition or requisition line, ensuring data integrity. Example: 2001 for 'Requisition Line 1'. |
| EffectiveDate | Date | The date from which the DFF data is considered effective. This is typically used to filter records based on the validity of the data. Example: '2023-01-01' for data valid from the start of the year. |
Captures project-specific descriptive flexfields for requisition line distributions, linking costs to project tasks or milestones.
| Name | Type | Description |
| PurchaseRequisitionsRequisitionHeaderId [KEY] | Long | The unique identifier for the requisition header associated with the project-specific descriptive flexfield (DFF) data, linking the DFF data to a specific requisition. Example: 1001 for Requisition Header 1001. |
| LinesRequisitionLineId [KEY] | Long | The identifier for the requisition line within the requisition header, linking the project DFF data to a specific requisition line. Example: 2001 for Line 1. |
| DistributionsRequisitionDistributionId [KEY] | Long | The unique identifier for the distribution associated with the requisition line, used to track the allocation of resources or costs. Example: 3001 for Distribution ID 3001. |
| DistributionId [KEY] | Long | The unique identifier for the requisition distribution, helping to track the allocation of goods, services, or costs within the requisition. Example: 4001 for Distribution 4001. |
| _FLEX_Context | String | The DFF context name, providing additional categorization or details specific to the project-related requisition distribution. Example: 'ProjectCost' or 'ResourceAllocation'. |
| _FLEX_Context_DisplayValue | String | The display value of the descriptive flexfield context, providing a human-readable version of the context. Example: 'Project Cost Allocation' or 'Resource Distribution'. |
| BindPreparerId | Long | The unique identifier for the preparer of the requisition line, linking the DFF data to the preparer’s information. Example: 123 for 'John Doe'. |
| BindRequisitionHeaderId | Long | The unique identifier for the requisition header, linking the project DFF data to the parent requisition. Example: 2001 for 'Requisition Header 2001'. |
| Finder | String | A placeholder used for searching and locating specific DFF data associated with the requisition distributions. Example: 'Search by Distribution ID'. |
| RequisitionHeaderId | Long | The identifier for the requisition header, linking the DFF data to the parent requisition record. Example: 1001 for Requisition Header 1001. |
| CUReferenceNumber | Int | The reference number that maps child aggregates (such as DFF data) to their parent requisition or requisition line, ensuring data integrity. Example: 2001 for 'Requisition Line 1'. |
| EffectiveDate | Date | The date from which the project-specific DFF data is considered effective. This date is used to filter records by their validity. Example: '2023-01-01' for data valid from the beginning of the year. |
Associates custom information templates (for example, extra fields or questionnaires) with requisition lines for specialized scenarios.
| Name | Type | Description |
| PurchaseRequisitionsRequisitionHeaderId [KEY] | Long | The unique identifier for the requisition header associated with the information template data, linking the template to a specific requisition. Example: 1001 for Requisition Header 1001. |
| LinesRequisitionLineId [KEY] | Long | The identifier for the requisition line within the requisition header, linking the information template to a specific line item. Example: 2001 for Line 1. |
| RequisitionLineId | Long | The unique identifier for the requisition line, used to track a specific line item in the requisition. Example: 3001 for Requisition Line ID 3001. |
| InformationTemplateValuesId [KEY] | Long | The unique identifier for the information template values associated with the requisition line, helping to track the specific values in the template. Example: 4001 for Template Value ID 4001. |
| InformationTemplateId | Long | The identifier for the information template, used to link the requisition line to a specific template. Example: 5001 for 'Purchase Order Template'. |
| InformationTemplateDisplayName | String | The display name of the information template, offering a human-readable description of the template used for the requisition line. Example: 'Purchase Order Template'. |
| InformationTemplate | String | The name of the information template, which could refer to a predefined form or format used for the requisition line. Example: 'Invoice Details' or 'Purchase Order'. |
| BindPreparerId | Long | The unique identifier for the preparer who created the requisition line, linking the information template data to the preparer. Example: 123 for 'John Doe'. |
| BindRequisitionHeaderId | Long | The unique identifier for the requisition header, linking the information template data to the parent requisition. Example: 2001 for 'Requisition Header 2001'. |
| Finder | String | A reference or placeholder used for searching and locating specific information template data in the system. Example: 'Search by Template Name' or 'Search by Template ID'. |
| RequisitionHeaderId | Long | The identifier for the requisition header, linking the information template data to the parent requisition record. Example: 1001 for 'Requisition Header 1001'. |
| CUReferenceNumber | Int | The reference number that maps child aggregates, such as information templates, to their parent requisition or requisition line, ensuring data integrity. Example: 2001 for 'Requisition Line 1'. |
| EffectiveDate | Date | The date from which the information template data is considered effective. This date is typically used to filter records by their validity. Example: '2023-01-01' for data valid from the start of the year. |
Stores descriptive flexfields related to an information template, accommodating extra user-defined attributes for a requisition line.
| Name | Type | Description |
| PurchaseRequisitionsRequisitionHeaderId [KEY] | Long | The unique identifier for the requisition header associated with the information template descriptive flexfield (DFF) data, linking the DFF data to a specific requisition. Example: 1001 for Requisition Header 1001. |
| LinesRequisitionLineId [KEY] | Long | The identifier for the requisition line within the requisition header, linking the DFF data to a specific requisition line. Example: 2001 for Line 1. |
| InformationtemplatesInformationTemplateValuesId [KEY] | Long | The unique identifier for the information template values associated with the requisition line, helping to track the specific values in the information template DFF. Example: 3001 for Template Value ID 3001. |
| InfoTemplateValuesId [KEY] | Long | The unique identifier for the information template values within the DFF, used to track the specific values in the context of the template. Example: 4001 for the specific value set. |
| _FLEX_Context | String | The DFF context name used to categorize or provide additional details for the information template values in the requisition. Example: 'ProjectDetails' or 'CostCenterInfo'. |
| _FLEX_Context_DisplayValue | String | The display value for the descriptive flexfield context, providing a human-readable version of the context. Example: 'Project Information' or 'Cost Center Allocation'. |
| BindPreparerId | Long | The unique identifier for the preparer who created the requisition line, linking the DFF data to the preparer's information. Example: 123 for 'John Doe'. |
| BindRequisitionHeaderId | Long | The unique identifier for the requisition header, linking the DFF data to the parent requisition. Example: 2001 for 'Requisition Header 2001'. |
| Finder | String | A reference or placeholder used for searching and locating specific information template data within the system. Example: 'Search by Template Name' or 'Search by Context'. |
| RequisitionHeaderId | Long | The identifier for the requisition header, linking the DFF data to the parent requisition record. Example: 1001 for 'Requisition Header 1001'. |
| CUReferenceNumber | Int | The reference number used to map child aggregates (such as DFF data) to their parent requisition or requisition line, ensuring data integrity. Example: 2001 for 'Requisition Line 1'. |
| EffectiveDate | Date | The date from which the information template DFF data is considered effective. This date is used to filter records by their validity. Example: '2023-01-01' for data valid from the start of the year. |
Manages special handling flexfields for unique shipping or handling requirements at the requisition line level.
| Name | Type | Description |
| PurchaseRequisitionsRequisitionHeaderId [KEY] | Long | The unique identifier for the requisition header associated with the special handling descriptive flexfield (DFF) data, linking the DFF data to a specific requisition. Example: 1001 for Requisition Header 1001. |
| LinesRequisitionLineId [KEY] | Long | The identifier for the requisition line within the requisition header, linking the special handling DFF data to a specific requisition line. Example: 2001 for Line 1. |
| RequisitionLineId [KEY] | Long | The unique identifier for the requisition line, used to track a specific line item in the requisition. Example: 3001 for Requisition Line ID 3001. |
| _FLEX_Context | String | The DFF context name, used to categorize or provide additional details for the special handling requirements in the requisition. Example: 'ShippingInstructions' or 'PriorityHandling'. |
| _FLEX_Context_DisplayValue | String | The display value for the descriptive flexfield context, offering a human-readable version of the context. Example: 'Shipping Instructions' or 'Priority Handling Required'. |
| BindPreparerId | Long | The unique identifier for the preparer who created the requisition line, linking the special handling DFF data to the preparer's information. Example: 123 for 'John Doe'. |
| BindRequisitionHeaderId | Long | The unique identifier for the requisition header, linking the special handling DFF data to the parent requisition. Example: 2001 for 'Requisition Header 2001'. |
| Finder | String | A reference or placeholder used for searching and locating specific special handling DFF data within the system. Example: 'Search by Special Handling Code' or 'Search by Line ID'. |
| RequisitionHeaderId | Long | The identifier for the requisition header, linking the special handling DFF data to the parent requisition record. Example: 1001 for 'Requisition Header 1001'. |
| CUReferenceNumber | Int | The reference number used to map child aggregates (such as special handling DFF data) to their parent requisition or requisition line, ensuring data integrity. Example: 2001 for 'Requisition Line 1'. |
| EffectiveDate | Date | The date from which the special handling DFF data is considered effective. This date is typically used to filter records by their validity. Example: '2023-01-01' for data valid from the start of the year. |
Enables descriptive flexfields for special handling instructions at the requisition header, ensuring compliance or safety measures.
| Name | Type | Description |
| PurchaseRequisitionsRequisitionHeaderId [KEY] | Long | The unique identifier for the requisition header associated with the special handling descriptive flexfield (DFF) data, linking the DFF data to a specific requisition. Example: 1001 for Requisition Header 1001. |
| RequisitionHeaderId [KEY] | Long | The identifier for the requisition header, linking the special handling DFF data to the parent requisition. Example: 2001 for 'Requisition Header 2001'. |
| _FLEX_Context | String | The DFF context name, used to categorize or provide additional details for the special handling requirements in the requisition. Example: 'ShippingInstructions' or 'PriorityHandling'. |
| _FLEX_Context_DisplayValue | String | The display value for the descriptive flexfield context, offering a human-readable version of the context. Example: 'Shipping Instructions' or 'Priority Handling Required'. |
| BindPreparerId | Long | The unique identifier for the preparer who created the requisition, linking the special handling DFF data to the preparer's information. Example: 123 for 'John Doe'. |
| BindRequisitionHeaderId | Long | The unique identifier for the requisition header, linking the special handling DFF data to the parent requisition. Example: 2001 for 'Requisition Header 2001'. |
| Finder | String | A reference or placeholder used for searching and locating specific special handling DFF data within the system. Example: 'Search by Special Handling Code' or 'Search by Requisition ID'. |
| CUReferenceNumber | Int | The reference number used to map child aggregates (such as special handling DFF data) to their parent requisition, ensuring data integrity. Example: 2001 for 'Requisition Line 1'. |
| EffectiveDate | Date | The date from which the special handling DFF data is considered effective. This date is used to filter records by their validity. Example: '2023-01-01' for data valid from the start of the year. |
Aggregates summary-level data on a requisition, consolidating details from all lines for higher-level review or analysis.
| Name | Type | Description |
| PurchaseRequisitionsRequisitionHeaderId [KEY] | Long | The unique identifier for the requisition header associated with the summary attributes data, linking the summary to a specific requisition. Example: 1001 for Requisition Header 1001. |
| RequisitionHeaderId [KEY] | Long | The identifier for the requisition header, linking the summary attributes data to the parent requisition record. Example: 2001 for 'Requisition Header 2001'. |
| ActiveLineCount | Decimal | The total number of active lines within the requisition header, indicating the number of lines still in use or not completed. Example: 5 for five active lines. |
| PurchaseOrderCount | Decimal | The total number of purchase orders associated with the requisition. Example: 3 for three purchase orders linked to the requisition. |
| TransferOrderCount | Decimal | The total number of transfer orders associated with the requisition. Example: 2 for two transfer orders created for the requisition. |
| BuyerCount | Decimal | The total number of buyers associated with the requisition. Example: 1 for a single buyer responsible for the requisition. |
| PurchaseOrder | String | The purchase order number associated with the requisition. Example: 'PO12345' for a specific purchase order. |
| TransferOrder | String | The transfer order number associated with the requisition. Example: 'TO6789' for a specific transfer order. |
| Buyer | String | The name of the buyer responsible for the requisition. Example: 'John Smith' for the buyer managing the requisition. |
| BuyerId | Long | The unique identifier for the buyer assigned to the requisition. Example: 1234 for 'John Smith'. |
| POHeaderId | Long | The unique identifier for the purchase order header linked to the requisition. Example: 5678 for 'PO5678'. |
| TOHeaderId | Long | The unique identifier for the transfer order header linked to the requisition. Example: 9012 for 'TO9012'. |
| LineCount | Decimal | The total number of lines in the requisition. Example: 10 for ten lines in the requisition. |
| DeliverToSingleLocationFlag | Bool | Indicates whether the requisition items are to be delivered to a single location. Example: True if all items are delivered to one location. |
| DeliverToLocationCode | String | The code representing the delivery location for the requisition items. Example: 'NYC' for New York City. |
| DeliverToLocationId | Long | The unique identifier for the location to which the requisition items will be delivered. Example: 12345 for 'Main Warehouse'. |
| DeliverToOneTimeLocationAddress | String | The address of a one-time delivery location for the requisition items, if applicable. Example: '456 Temporary St, New York, NY'. |
| DeliverToOneTimeLocationId | Long | The unique identifier for a one-time delivery location. Example: 67890 for a temporary delivery address. |
| SameRequestedDeliveryDateFlag | Bool | Indicates whether all lines in the requisition have the same requested delivery date. Example: True if all lines share the same date. |
| RequestedDeliveryDate | Date | The requested delivery date for the requisition items. Example: '2023-06-15' for items requested to be delivered on June 15, 2023. |
| SameBudgetDateFlag | Bool | Indicates whether all requisition lines have the same budget date. Example: True if all lines are tied to the same budget date. |
| BudgetDate | Date | The budget date associated with the requisition, used for budget consumption tracking. Example: '2023-01-01' for the start of the budget period. |
| ChargeToSingleAccountFlag | Bool | Indicates whether all requisition items are charged to a single account. Example: True if all charges go to one account. |
| ChargeAccount | String | The account to which the requisition items are charged. Example: 'Office Supplies' for the relevant charge account. |
| ChargeAccountId | Long | The unique identifier for the charge account associated with the requisition. Example: 101 for 'Office Supplies Account'. |
| RequisitionTotalAmount | Decimal | The total amount for the requisition, including all items and charges. Example: 5000 for a requisition totaling $5000. |
| RequisitionNonRecoverableTaxAmount | Decimal | The amount of non-recoverable tax associated with the requisition. Example: 50 for $50 of non-recoverable tax. |
| RequisitionApprovalAmount | Decimal | The approved amount for the requisition, which may differ from the requested amount based on approval processes. Example: 4800 for an approved amount of $4800. |
| OneTimeLocationCountAcrossRequisition | Long | The number of one-time locations used across the entire requisition. Example: 2 for two one-time locations. |
| OneTimeLocationCountAcrossRequisitionLine | Long | The number of one-time locations used across the individual lines in the requisition. Example: 1 for one line with a one-time location. |
| ProjectCostingDetailsCode | String | The project costing details code, used to categorize the requisition for project-based accounting. Example: 'PCD123' for a specific project cost code. |
| ProjectId | Decimal | The unique identifier for the project associated with the requisition. Example: 1001 for 'Project 1001'. |
| ProjectNumber | String | The project number associated with the requisition. Example: 'PRJ-567' for a specific project number. |
| ProjectName | String | The name of the project associated with the requisition. Example: 'Office Expansion Project'. |
| CategoryId | Long | The unique identifier for the category of items or services requested in the requisition. Example: 101 for 'Office Supplies'. |
| SameCategoryIdFlag | Bool | Indicates whether all requisition lines share the same category. Example: True if all items belong to the same category. |
| VendorId | Long | The unique identifier for the vendor supplying the requisition items. Example: 12345 for 'XYZ Corporation'. |
| SameVendorIdFlag | Bool | Indicates whether all requisition lines are associated with the same vendor. Example: True if all lines are supplied by the same vendor. |
| RequesterId | Long | The unique identifier for the requester of the requisition. Example: 2345 for 'Alice Johnson'. |
| Requester | String | The name of the individual who requested the requisition items. Example: 'Alice Johnson'. |
| SameRequesterIdFlag | Bool | Indicates whether all requisition lines have the same requester. Example: True if all lines were requested by the same person. |
| SuggestedBuyerId | Long | The unique identifier for the suggested buyer of the requisition items. Example: 3456 for 'Bob Smith'. |
| SuggestedBuyer | String | The name of the suggested buyer for the requisition items. Example: 'Bob Smith'. |
| SameSuggestedBuyerIdFlag | Bool | Indicates whether all requisition lines have the same suggested buyer. Example: True if all lines are suggested to be bought by the same buyer. |
| PrcBUId | Long | The unique identifier for the procurement business unit associated with the requisition. Example: 4567 for 'Procurement Unit A'. |
| SamePrcBUIdFlag | Bool | Indicates whether all requisition lines are assigned to the same procurement business unit. Example: True if all lines are handled by the same unit. |
| DestinationTypeCode | String | The code representing the type of destination for the requisition items, such as 'WARE' for warehouse or 'STOR' for store. Example: 'WARE'. |
| SameDestinationTypeCodeFlag | Bool | Indicates whether all requisition lines share the same destination type. Example: True if all lines are destined for the warehouse. |
| AccountUserOverrideFlag | Bool | Indicates whether the user has overridden the default account for the requisition. Example: True if the account was manually adjusted. |
| SameAccountUserOverrideFlag | Bool | Indicates whether all requisition lines have the same account override status. Example: True if all lines have the same override status. |
| TaskNumber | String | The task number associated with the requisition, often used in project-based requisitions. Example: 'TASK-001' for the first task. |
| TaskName | String | The name or description of the task associated with the requisition. Example: 'Procurement for Office Supplies'. |
| ProjectsInformationAcrossLines | String | A summary or categorization of project-related information shared across all lines in the requisition. Example: 'Office Expansion Project'. |
| TotalIMTLinesCount | Decimal | The total number of IMT (Internal Material Transfer) lines within the requisition. Example: 5 for five IMT lines. |
| UnprocessedIMTLinesCount | Decimal | The number of unprocessed IMT lines within the requisition. Example: 2 for two unprocessed lines. |
| ContainsNoneditableLinesFlag | Bool | Indicates whether the requisition contains lines that are non-editable. Example: True if there are non-editable lines. |
| SameDestinationOrganizationIdFlag | Bool | Indicates whether all requisition lines have the same destination organization. Example: True if all lines are assigned to the same organization. |
| SameDestinationSubinventoryFlag | Bool | Indicates whether all requisition lines have the same destination subinventory. Example: True if all lines are assigned to the same subinventory. |
| HasOneTimeLocAcrossLinesFlag | Bool | Indicates whether the requisition contains one-time locations across multiple lines. Example: True if multiple lines involve one-time locations. |
| HasAllMasterItemsFlag | Bool | Indicates whether the requisition contains only master items. Example: True if all items are master items. |
| MaximumSequenceNumber | Long | The maximum sequence number assigned to the requisition lines, used to track line order. Example: 10 for the 10th sequence number. |
| BindPreparerId | Long | The unique identifier for the preparer of the requisition, linking the summary attributes data to the preparer. Example: 1234 for 'John Doe'. |
| BindRequisitionHeaderId | Long | The unique identifier for the requisition header, linking the summary attributes data to the parent requisition record. Example: 2001 for 'Requisition Header 2001'. |
| Finder | String | A placeholder or reference used for searching and locating specific requisition summary data. Example: 'Search by PO Number'. |
| CUReferenceNumber | Int | The reference number used to map child aggregates (such as summary attributes) to their parent requisition or requisition line. Example: 1001 for 'Requisition Line 1'. |
| EffectiveDate | Date | The date from which the requisition summary attributes data is considered effective. Example: '2023-01-01' for data valid from the start of the year. |
Lists errors encountered during bulk imports of purchasing documents, such as invalid data or missing references.
| Name | Type | Description |
| InterfaceTransactionId [KEY] | Long | The unique identifier for the interface transaction associated with the import error, linking the error to a specific transaction. Example: 1001 for Interface Transaction ID 1001. |
| InterfaceType [KEY] | String | The type of interface associated with the import error, indicating the source or method of the data import. Example: 'PO_IMPORT' for Purchase Order Import. |
| BatchId | Long | The unique identifier for the batch in which the error occurred, helping to group errors within the same import session. Example: 5001 for Batch ID 5001. |
| RequestId | Long | The identifier for the request that triggered the import process, linking the error to a specific request. Example: 2001 for Request ID 2001. |
| ColumnName | String | The name of the column where the error occurred, identifying the specific field that caused the error. Example: 'SUPPLIER_ID' for an issue with the supplier column. |
| ColumnValue | String | The value in the column that caused the error, providing context for the issue. Example: 'XYZ Supplier' for an invalid supplier value. |
| ErrorMessage | String | A detailed message describing the error that occurred during the import process, providing insight into the nature of the issue. Example: 'Invalid Supplier ID' or 'Missing Value'. |
| ErrorMessageName | String | A concise name or code representing the error message, often used for categorizing or referencing the issue. Example: 'INVALID_SUPPLIER' for an invalid supplier ID error. |
| TableName | String | The name of the table where the error occurred, helping to identify the source of the issue in the database. Example: 'PO_HEADERS' for an issue with the purchase order headers table. |
| InterfaceAssignmentId | Long | The unique identifier for the assignment of the interface, linking the error to a specific assignment within the interface process. Example: 3001 for Interface Assignment ID 3001. |
| InterfaceAttrValuesId | Long | The identifier for the attribute values associated with the interface, providing additional context about the data being imported. Example: 4001 for Interface Attribute Values ID 4001. |
| InterfaceAttrValuesTlpId | Long | The identifier for the attribute values template associated with the interface, providing additional details about the template used in the import. Example: 5001 for Template ID 5001. |
| InterfaceDistributionId | Long | The unique identifier for the distribution associated with the interface, linking the error to a specific distribution record. Example: 6001 for Interface Distribution ID 6001. |
| InterfaceHeaderId | Long | The identifier for the interface header, which organizes the data into logical groupings for the import process. Example: 7001 for Interface Header ID 7001. |
| InterfaceLineId | Long | The identifier for the line item in the interface, identifying the specific line that caused the import error. Example: 8001 for Interface Line ID 8001. |
| InterfaceLineLocationId | Long | The identifier for the location of the interface line, providing further detail about where the error occurred. Example: 9001 for Interface Line Location ID 9001. |
| ProcessingDate | Date | The date on which the import error was processed, helping to track when the error occurred. Example: '2023-01-01' for the processing date. |
| CreatedBy | String | The username or identifier of the user who created the error record, typically the person who initiated or encountered the error. Example: 'admin' for the administrator. |
| CreationDate | Datetime | The date and time when the error record was created, used for tracking and auditing purposes. Example: '2023-01-01 10:00:00' for when the error was logged. |
| Finder | String | A reference or placeholder used for searching and locating specific import error records. Example: 'Search by Error Message' or 'Search by Request ID'. |
Publishes announcements or updates for procurement teams, covering new policies, system changes, or supplier updates.
| Name | Type | Description |
| PurchasingNewsId [KEY] | Long | The unique identifier for the purchasing news record, used to track and reference specific news items. Example: 1001 for Purchasing News ID 1001. |
| RequisitioningBUId | Long | The unique identifier for the requisitioning business unit (BU) associated with the purchasing news, linking the news item to the relevant business unit. Example: 2001 for 'Procurement Unit A'. |
| News | String | The content or description of the purchasing news, providing important information or updates related to procurement activities. Example: 'New supplier contracts approved for Q3'. |
| Finder | String | A reference or placeholder used for searching and locating specific purchasing news records within the system. Example: 'Search by News Content' or 'Search by BU ID'. |
Manages supplier or compliance questionnaire responses, collecting details for audits, qualifications, and due diligence.
| Name | Type | Description |
| QuestionnaireRespHeaderId [KEY] | Long | The unique identifier for the questionnaire response header, linking the response to a specific questionnaire. Example: 1001 for Questionnaire Response Header 1001. |
| InitiativeId | Long | The unique identifier for the initiative associated with the questionnaire response, linking the response to a specific initiative. Example: 2001 for Initiative 2001. |
| QuestnaireId | Long | The unique identifier for the questionnaire to which the response belongs. Example: 3001 for Questionnaire ID 3001. |
| QuestionnaireTypeCode | String | The code representing the type of the questionnaire, categorizing the nature of the questionnaire. Example: 'SURVEY' for a survey type questionnaire. |
| QuestionnaireType | String | The full name or description of the questionnaire type, helping to identify its purpose. Example: 'Supplier Feedback' or 'Internal Assessment'. |
| QuestionnaireUsageCode | String | The code representing how the questionnaire is used within the organization, such as for feedback or evaluation. Example: 'FEEDBACK' for a feedback questionnaire. |
| QuestionnaireUsage | String | The description of how the questionnaire is used within the organization. Example: 'For supplier performance evaluation'. |
| ProcurementBUId | Long | The unique identifier for the procurement business unit (BU) associated with the questionnaire response, linking the response to a specific business unit. Example: 4001 for 'Procurement Unit A'. |
| ProcurementBU | String | The name of the procurement business unit associated with the questionnaire response. Example: 'Global Procurement'. |
| ResponseStatusCode | String | The code representing the status of the questionnaire response, indicating its current stage or condition. Example: 'COMPLETED' for a fully submitted response. |
| ResponseStatus | String | The description of the response status, providing more detail on the stage or state of the response. Example: 'Completed' or 'Pending'. |
| Introduction | String | The introductory text or instructions provided at the beginning of the questionnaire. Example: 'Please fill out the following feedback survey'. |
| SupplierId | Long | The unique identifier for the supplier associated with the questionnaire response, linking the response to a specific supplier. Example: 5001 for 'Supplier ABC'. |
| SupplierName | String | The name of the supplier associated with the questionnaire response. Example: 'ABC Supplies'. |
| SupplierSiteId | Long | The unique identifier for the supplier site related to the questionnaire response, indicating the specific location of the supplier. Example: 6001 for 'Main Warehouse'. |
| SupplierSiteName | String | The name of the supplier site associated with the questionnaire response. Example: 'Warehouse 1'. |
| SupplierContactPartyId | Long | The unique identifier for the supplier contact party, linking the response to the specific person or entity. Example: 7001 for 'John Doe'. |
| SupplierContactPartyName | String | The name of the supplier contact party associated with the questionnaire response. Example: 'John Doe'. |
| InternalRespondentId | Long | The unique identifier for the internal respondent who filled out the questionnaire. Example: 8001 for 'Jane Smith'. |
| InternalResponderName | String | The name of the internal respondent who completed the questionnaire. Example: 'Jane Smith'. |
| InitiativeSuppContactId | Long | The unique identifier for the contact party for the initiative, linking the response to the specific person responsible for the initiative. Example: 9001 for 'Robert Brown'. |
| InitiativeSupplierContactName | String | The name of the contact person for the initiative supplier. Example: 'Robert Brown'. |
| SubmissionDate | Datetime | The date and time when the questionnaire response was submitted. Example: '2023-06-01 10:00:00' for a response submitted on June 1, 2023. |
| SubmittedBy | Long | The unique identifier for the user who submitted the questionnaire response. Example: 1002 for 'Alice Johnson'. |
| SubmittedByName | String | The name of the user who submitted the questionnaire response. Example: 'Alice Johnson'. |
| SurrogResponseFlag | Bool | Indicates whether the response was submitted on behalf of someone else (surrogate response). Example: True if submitted by a proxy. |
| SurrogEntryDate | Datetime | The date when the surrogate response was entered. Example: '2023-06-01 10:30:00' for the entry time of the surrogate response. |
| SurrogEnteredBy | Long | The unique identifier for the person who entered the surrogate response. Example: 1010 for 'Michael Scott'. |
| SurrogateEnteredByName | String | The name of the person who entered the surrogate response. Example: 'Michael Scott'. |
| AcceptanceDate | Datetime | The date when the questionnaire response was accepted. Example: '2023-06-02 11:00:00' for when the response was formally accepted. |
| AcceptedBy | Long | The unique identifier for the person who accepted the questionnaire response. Example: 1020 for 'Sarah Lee'. |
| AcceptedByName | String | The name of the person who accepted the questionnaire response. Example: 'Sarah Lee'. |
| AcceptanceNote | String | Any additional notes or comments provided when accepting the response. Example: 'Response validated and accepted.' |
| CanceledDate | Datetime | The date when the questionnaire response was canceled. Example: '2023-06-03 14:00:00' for when the cancellation was recorded. |
| CanceledBy | Long | The unique identifier for the person who canceled the questionnaire response. Example: 1030 for 'David Green'. |
| CanceledByName | String | The name of the person who canceled the questionnaire response. Example: 'David Green'. |
| CanceledReasonCode | String | The code representing the reason for canceling the response. Example: 'INVALID' for an invalid response. |
| CanceledReasonUserText | String | The user-provided reason for canceling the response. Example: 'Response data was corrupted'. |
| ReturnedDate | Datetime | The date when the questionnaire response was returned. Example: '2023-06-04 15:00:00' for when the response was returned by the respondent. |
| ReturnedBy | Long | The unique identifier for the person who returned the questionnaire response. Example: 1040 for 'Emma White'. |
| ReturnedByName | String | The name of the person who returned the questionnaire response. Example: 'Emma White'. |
| ReturnMessageContent | String | The content of the message provided when returning the questionnaire response. Example: 'Please revise and resubmit the response'. |
| RequestErrorReason | String | The reason for any error encountered during the request process for the questionnaire. Example: 'System Timeout' or 'Invalid Input'. |
| RecentNotificationFlag | Bool | Indicates whether the questionnaire response has been recently notified. Example: True if the response was recently notified to the relevant stakeholders. |
| MergeRequestId | Long | The unique identifier for the merge request associated with the questionnaire response, if the response is part of a merge process. Example: 1050 for Merge Request 1050. |
| CloseDate | Datetime | The date when the questionnaire response was closed. Example: '2023-06-05 16:00:00' for when the response was closed. |
| ClosedBy | Long | The unique identifier for the person who closed the questionnaire response. Example: 1060 for 'James Clark'. |
| ClosedByName | String | The name of the person who closed the questionnaire response. Example: 'James Clark'. |
| AcceptanceProcessedStage | String | The stage at which the acceptance of the questionnaire response was processed. Example: 'INITIAL_REVIEW' for the initial review stage. |
| AcceptanceRecoveredCode | String | The code indicating the recovery status of the acceptance. Example: 'RECOVERED' if the acceptance process was completed after initial failure. |
| AcceptanceInstanceId | Long | The unique identifier for the instance of acceptance for the questionnaire response. Example: 1070 for 'Acceptance Instance 1070'. |
| RecoveredBy | Long | The unique identifier for the person who recovered or resolved the questionnaire response acceptance issue. Example: 1080 for 'Laura Adams'. |
| RecoveredDate | Datetime | The date when the questionnaire response acceptance was successfully recovered. Example: '2023-06-06 17:00:00' for the recovery date. |
| Finder | String | A reference or placeholder used for searching and locating specific questionnaire response records within the system. Example: 'Search by Response Status'. |
Stores attachments linked to questionnaire responses (for example, supporting documents, references), providing additional context for responses.
| Name | Type | Description |
| QuestionnaireResponsesQuestionnaireRespHeaderId [KEY] | Long | The unique identifier for the questionnaire response header associated with the attachment, linking the attachment to a specific response. Example: 1001 for Questionnaire Response Header 1001. |
| AttachedDocumentId [KEY] | Long | The unique identifier for the attached document, linking the attachment to the specific document. Example: 2001 for 'Document 2001'. |
| LastUpdateDate | Datetime | The date and time when the attachment was last updated. Example: '2023-06-15 14:00:00' for the latest modification time. |
| LastUpdatedBy | String | The username or identifier of the person who last updated the attachment record. Example: 'admin' for the administrator. |
| DatatypeCode | String | The code representing the type of data in the attachment, such as 'PDF', 'JPEG', or 'TEXT'. Example: 'PDF' for a PDF document attachment. |
| FileName | String | The name of the file associated with the attachment. Example: 'questionnaire_response.pdf' for a PDF file. |
| DmFolderPath | String | The folder path where the attachment is stored in the document management system. Example: '/docs/attachments/2023/'. |
| DmDocumentId | String | The unique identifier for the document in the document management system from which the attachment is derived. Example: 'DOC1234' for Document ID DOC1234. |
| DmVersionNumber | String | The version number of the document from which the attachment is created. Example: 'V2' for version 2 of the document. |
| Url | String | The URL pointing to the attachment in a web-based location. Example: 'http://example.com/attachment/12345' for a web URL. |
| CategoryName | String | The category of the attachment, which helps classify the document type. Example: 'Invoice' for an invoice-related attachment. |
| UserName | String | The username or credentials of the person who uploaded the attachment. Example: 'jdoe' for 'John Doe'. |
| Uri | String | The URI (Uniform Resource Identifier) for the attachment, indicating its location in a system or network. Example: 'doc://attachments/12345'. |
| FileUrl | String | The URL to directly access the file for viewing or download. Example: 'http://example.com/file/attachment.pdf'. |
| UploadedText | String | The text content of the attachment if it is a text-based document. Example: 'This is the content of the questionnaire response attachment.' |
| UploadedFileContentType | String | The content type of the attached file, indicating its format. |
| UploadedFileLength | Long | The size of the attached file in bytes. Example: 1048576 for a 1 MB file. |
| UploadedFileName | String | The name assigned to the uploaded file, which may differ from the original file name. Example: 'response_document_2023.pdf'. |
| ContentRepositoryFileShared | Bool | Indicates whether the file is shared within the content repository. Example: True if the file is shared, False if it is not. |
| Title | String | The title of the attachment, providing a brief description or name of the file. Example: 'Supplier Feedback Response'. |
| Description | String | A detailed description of the attachment, explaining its purpose or content. Example: 'This document contains the supplier's feedback for Q2.' |
| ErrorStatusCode | String | The error code, if any, associated with the attachment, indicating the nature of the error. Example: 'FILE_ERR' for a file error. |
| ErrorStatusMessage | String | The error message providing further explanation about the issue with the attachment. Example: 'File format not supported' or 'File upload failed'. |
| CreatedBy | String | The username or identifier of the person who initially created the attachment record. Example: 'admin' for the system administrator. |
| CreationDate | Datetime | The date and time when the attachment was initially created or uploaded. Example: '2023-06-01 09:30:00' for when the attachment was uploaded. |
| FileContents | String | The contents of the file if it is a text-based file. Example: 'This is a sample questionnaire response text.' |
| ExpirationDate | Datetime | The expiration date when the attachment is no longer valid or accessible. Example: '2023-12-31 23:59:59' for the expiration of the attachment. |
| LastUpdatedByUserName | String | The username of the person who last updated the attachment record. Example: 'jdoe' for 'John Doe'. |
| CreatedByUserName | String | The username of the person who created the attachment. Example: 'admin' for 'Administrator'. |
| AsyncTrackerId | String | An identifier used for tracking the asynchronous upload process of the attachment. Example: 'upload12345' for tracking the upload process. |
| FileWebImage | String | A Base64-encoded image of the file, displayed in PNG format if the source is a convertible image. Example: 'iVBORw0KGgoAAAANSUhEU...'. |
| DownloadInfo | String | A JSON object as a string containing information used to retrieve the attachment programmatically. Example: '{url |
| PostProcessingAction | String | The action to be performed after the attachment is uploaded, such as validation or conversion. Example: 'Approve Attachment'. |
| Finder | String | A reference or placeholder used for searching and locating the attachment record in the system. Example: 'Search by Document ID' or 'Search by Category'. |
| QuestionnaireRespHeaderId | Long | The unique identifier for the questionnaire response header associated with the attachment, linking the attachment to a specific response header. Example: 1001 for Questionnaire Response Header 1001. |
Organizes questionnaires into sections, each containing related questions or topics for supplier or compliance evaluations.
| Name | Type | Description |
| QuestionnaireResponsesQuestionnaireRespHeaderId [KEY] | Long | The unique identifier for the questionnaire response header associated with the section, linking the section data to a specific questionnaire response. Example: 1001 for Questionnaire Response Header 1001. |
| QuestionnaireRespSectionId [KEY] | Long | The unique identifier for the questionnaire response section, used to track a specific section of the questionnaire response. Example: 2001 for Section ID 2001. |
| QuestionnaireRespHeaderId | Long | The identifier for the questionnaire response header, linking the section data to the parent response record. Example: 1001 for Questionnaire Response Header 1001. |
| QuestionnaireSectionId | Long | The unique identifier for the questionnaire section, used to categorize and organize the sections within the questionnaire. Example: 3001 for Questionnaire Section ID 3001. |
| QuestionnaireSectionName | String | The name or title of the questionnaire section, providing a label for the section. Example: 'Supplier Information' for the section related to supplier details. |
| DisplaySequence | Int | The sequence number used to determine the display order of the section within the questionnaire. Example: 1 for the first section in the questionnaire. |
| Instructions | String | Any instructions or guidelines provided to the respondent for completing the section. Example: 'Please fill in all fields related to supplier details'. |
| SectionGeneratedFlag | Bool | Indicates whether the section was automatically generated or created by the system. Example: True if the section was auto-generated by the system. |
| SectionCompletedFlag | String | Indicates the completion status of the section, indicating whether the section has been fully answered. Example: 'YES' for a section that has been completed. |
| Finder | String | A reference or placeholder used for searching and locating specific section data in the system. Example: 'Search by Section Name' or 'Search by Section ID'. |
Captures individual answers or notes for each question in a questionnaire section, reflecting the respondent’s input.
| Name | Type | Description |
| QuestionnaireResponsesQuestionnaireRespHeaderId [KEY] | Long | The unique identifier for the questionnaire response header associated with the detailed section data, linking the section details to a specific questionnaire response. Example: 1001 for Questionnaire Response Header 1001. |
| QuestionnaireresponsesectionsQuestionnaireRespSectionId [KEY] | Long | The unique identifier for the questionnaire response section, linking the section details to a specific section in the questionnaire response. Example: 2001 for Section ID 2001. |
| QuestionnaireResponseId [KEY] | Long | The unique identifier for the questionnaire response, linking the section details to the overall questionnaire response. Example: 3001 for Questionnaire Response ID 3001. |
| QuestionnaireRespHeaderId | Long | The identifier for the questionnaire response header, linking the section details to the parent questionnaire response. Example: 1001 for Questionnaire Response Header 1001. |
| QuestionnaireRespSectionId | Long | The unique identifier for the section in the questionnaire response, providing the context for the section details. Example: 2001 for Section ID 2001. |
| QuestionnaireQuestionId | Long | The unique identifier for the specific question within the section, linking the question details to the section. Example: 4001 for Questionnaire Question ID 4001. |
| ParentQuestionnaireQuestId | Long | The unique identifier for the parent question if the current question is part of a hierarchical structure. Example: 5001 for Parent Question ID 5001. |
| HasNewerResponseFlag | Bool | Indicates whether a newer response exists for the question. Example: True if a more recent response has been submitted for the same question. |
| FailedPozValidationFlag | Bool | Indicates whether the response failed POZ (Purchase Order Zero) validation. Example: True if the response did not pass the validation. |
| QuestionDisplayedFlag | Bool | Indicates whether the question was displayed to the respondent. Example: True if the question was shown to the user. |
| AcceptanceNote | String | Any additional notes provided during the acceptance of the questionnaire response. Example: 'Approved by the manager' for a response that has been accepted. |
| ResponseComments | String | The comments provided by the respondent for the question. Example: 'The pricing information is correct.' |
| DisplayNumber | String | The display number for the question, used to identify its position in the questionnaire. Example: 'Q1' for the first question. |
| DisplaySequence | Int | The sequence number used to define the order of the question in the questionnaire. Example: 1 for the first question in the section. |
| QuestionId | Long | The unique identifier for the question, linking it to the response details. Example: 6001 for Question ID 6001. |
| QuestionName | String | The name of the question, providing a descriptive label for the question. Example: 'Supplier Name'. |
| QuestionTypeCode | String | The code representing the type of the question, such as multiple choice or text. Example: 'MC' for multiple-choice question. |
| QuestionType | String | The full description of the question type, such as 'Multiple Choice' or 'Short Answer'. Example: 'Text Response' for a question that requires text input. |
| ResponseTypeCode | String | The code representing the type of response expected, such as text, number, or selection. Example: 'TEXT' for a text-based response. |
| ResponseType | String | The full description of the expected response type. Example: 'Numeric' or 'Text' for a text-based response. |
| QuestionText | String | The full text of the question being asked in the questionnaire. Example: 'What is your supplier name?' |
| QuestionPlainText | String | The plain text version of the question, without any formatting or HTML. Example: 'What is the total order value?' |
| QuestionHint | String | A hint or guidance provided with the question to assist the respondent in answering. Example: 'Enter the total amount of your latest order'. |
| DisplayPreferredRespFlag | Bool | Indicates whether the preferred response should be displayed to the respondent. Example: True if the system suggests a preferred response. |
| PreferredResponseText | String | The text of the preferred response, which is typically displayed to the respondent as a suggested answer. Example: 'Yes' for a yes/no question. |
| PreferredResponseDate | Date | The date when the preferred response was given. Example: '2023-06-01' for the date of the preferred response. |
| PreferredResponseDatetime | Datetime | The exact date and time when the preferred response was given. Example: '2023-06-01 10:30:00' for the preferred response submission timestamp. |
| PreferredResponseNumber | Decimal | The numeric value of the preferred response, if applicable. Example: 5 for a rating scale question where 5 is the preferred answer. |
| AttachmentAllowedCode | String | The code representing whether attachments are allowed for the question. Example: 'YES' if attachments are allowed. |
| AttachmentAllowed | String | The description of whether attachments are allowed for the question. Example: 'Yes' if attachments are permitted. |
| ResponseRequiredFlag | Bool | Indicates whether a response is required for the question. Example: True if the respondent is required to provide an answer. |
| AllowRespCommentFlag | Bool | Indicates whether comments are allowed for the response. Example: True if the respondent can add comments to their answer. |
| ParentAcceptableResponseId | Long | The unique identifier for the acceptable parent response, if the current response is linked to a parent response. Example: 7001 for the parent response ID. |
| SupplierAttributeCode | String | The code representing the supplier attribute associated with the question. Example: 'SUPPLY_QUAL' for a supplier quality attribute. |
| SupplierAttributeFlag | Bool | Indicates whether the question is related to a supplier attribute. Example: True if the question is related to supplier attributes. |
| CategoryCode | String | The category code associated with the question, used to group related questions. Example: 'CAT1' for Category 1 questions. |
| Category | String | The category name associated with the question, providing context for its grouping. Example: 'Product Information'. |
| BranchLevel | Int | The level of the branch in a multi-level questionnaire, indicating how deep the question is in the hierarchy. Example: 1 for top-level questions. |
| MappedToPrereqQuestionFlag | Bool | Indicates whether the question is mapped to a prerequisite question. Example: True if the question is part of a dependent sequence. |
| Finder | String | A reference or placeholder used for searching and locating specific questionnaire response section details. Example: 'Search by Question ID' or 'Search by Response Type'. |
Manages files attached to specific question responses, such as certificates or documentation supporting the respondent’s claims.
| Name | Type | Description |
| QuestionnaireResponsesQuestionnaireRespHeaderId [KEY] | Long | The unique identifier for the questionnaire response header associated with the attachment, linking the attachment to a specific questionnaire response. Example: 1001 for Questionnaire Response Header 1001. |
| QuestionnaireresponsesectionsQuestionnaireRespSectionId [KEY] | Long | The unique identifier for the questionnaire response section, linking the attachment to a specific section within the questionnaire response. Example: 2001 for Section ID 2001. |
| QuestionnaireresponsedetailsQuestionnaireResponseId [KEY] | Long | The unique identifier for the questionnaire response, linking the attachment to a specific questionnaire response record. Example: 3001 for Questionnaire Response ID 3001. |
| AttachedDocumentId [KEY] | Long | The unique identifier for the document attached to the questionnaire response, linking the attachment to a specific document. Example: 4001 for Document ID 4001. |
| LastUpdateDate | Datetime | The date and time when the attachment was last updated. Example: '2023-06-15 14:00:00' for when the attachment was last modified. |
| LastUpdatedBy | String | The username or identifier of the person who last updated the attachment. Example: 'admin' for the administrator responsible for the last update. |
| DatatypeCode | String | The code representing the data type of the attachment file, such as PDF, image, or text. Example: 'PDF' for a PDF file. |
| FileName | String | The name of the attached file. Example: 'response_document.pdf' for the name of the document attached to the questionnaire response. |
| DmFolderPath | String | The folder path in the document management system where the attachment is stored. Example: '/docs/questionnaire_responses/'. |
| DmDocumentId | String | The unique identifier for the document in the document management system, linking the attachment to the source document. Example: 'DOC1234' for Document ID DOC1234. |
| DmVersionNumber | String | The version number of the attached document, indicating which version of the document the attachment corresponds to. Example: 'V2' for version 2. |
| Url | String | The URL pointing to the attachment, used to access the document online. Example: 'http://example.com/file/12345' for accessing the document through a URL. |
| CategoryName | String | The category or type of the attached document. Example: 'Supplier Feedback' for documents related to supplier feedback. |
| UserName | String | The username or credentials of the person who uploaded the attachment. Example: 'jdoe' for the user who uploaded the file. |
| Uri | String | The URI (Uniform Resource Identifier) used to identify the attachment's location. Example: 'doc://attachments/12345' for the URI of the attachment. |
| FileUrl | String | The direct URL to access the attachment file. Example: 'http://example.com/file/attachment.pdf' for the link to download the file. |
| UploadedText | String | The text content of the uploaded file if it is a text-based document. Example: 'This is a questionnaire response from Supplier ABC.' |
| UploadedFileContentType | String | The content type of the uploaded file, indicating its format. |
| UploadedFileLength | Long | The size of the uploaded file in bytes. Example: 1048576 for a file that is 1 MB in size. |
| UploadedFileName | String | The name of the file as assigned during the upload process. Example: 'response_document_2023.pdf'. |
| ContentRepositoryFileShared | Bool | Indicates whether the file is shared within the content repository. Example: True if the file is shared, False if it is not. |
| Title | String | The title or name of the attachment. Example: 'Supplier Feedback Response' for the title of the uploaded document. |
| Description | String | A description of the attachment, providing additional context or information about the file. Example: 'This document contains the feedback from Supplier ABC.' |
| ErrorStatusCode | String | The error code associated with the attachment, if any, indicating a problem with the file or its processing. Example: 'FILE_ERR' for a file error. |
| ErrorStatusMessage | String | The error message describing the issue encountered with the attachment. Example: 'File format not supported' for an unsupported file type error. |
| CreatedBy | String | The username or identifier of the person who initially created or uploaded the attachment. Example: 'admin' for the administrator who uploaded the document. |
| CreationDate | Datetime | The date and time when the attachment was initially created or uploaded. Example: '2023-06-01 09:00:00' for when the attachment was first added. |
| FileContents | String | The contents of the file if it is a text-based file. Example: 'This is the text content of the questionnaire response attachment.' |
| ExpirationDate | Datetime | The expiration date after which the attachment will no longer be accessible or valid. Example: '2023-12-31 23:59:59' for the expiration of the document. |
| LastUpdatedByUserName | String | The username of the person who last updated the attachment. Example: 'jdoe' for 'John Doe' who last updated the file. |
| CreatedByUserName | String | The username of the person who created the attachment. Example: 'admin' for the person who initially uploaded the document. |
| AsyncTrackerId | String | An identifier used to track the asynchronous upload or processing of the attachment. Example: 'upload12345' for tracking the file upload process. |
| FileWebImage | String | A Base64-encoded image of the file, displayed in PNG format if the source is a convertible image. Example: 'iVBORw0KGgoAAAANSUhEU...'. |
| DownloadInfo | String | A JSON object as a string containing information used to retrieve the file, such as download links or metadata. Example: '{url |
| PostProcessingAction | String | The action to be performed after the attachment is uploaded, such as validation or conversion. Example: 'Approve Attachment' or 'Verify File Integrity'. |
| Finder | String | A reference or placeholder used for searching and locating the attachment within the system. Example: 'Search by Document ID' or 'Search by Category'. |
| QuestionnaireRespHeaderId | Long | The unique identifier for the questionnaire response header, linking the attachment to the specific questionnaire response. Example: 1001 for Questionnaire Response Header 1001. |
Holds the actual data points (for example, text, dates, numeric values) provided in response to each question, enabling detailed analysis.
| Name | Type | Description |
| QuestionnaireResponsesQuestionnaireRespHeaderId [KEY] | Long | The unique identifier for the questionnaire response header associated with the value, linking the value to a specific questionnaire response. Example: 1001 for Questionnaire Response Header 1001. |
| QuestionnaireresponsesectionsQuestionnaireRespSectionId [KEY] | Long | The unique identifier for the questionnaire response section, linking the value to a specific section within the questionnaire. Example: 2001 for Section ID 2001. |
| QuestionnaireresponsedetailsQuestionnaireResponseId [KEY] | Long | The unique identifier for the questionnaire response, linking the value to a specific response record. Example: 3001 for Questionnaire Response ID 3001. |
| QuestionnaireRespValueId [KEY] | Long | The unique identifier for the questionnaire response value, used to track the response value for the specific question. Example: 4001 for Response Value ID 4001. |
| QuestionnaireResponseId | Long | The identifier for the questionnaire response, linking the value to the overall response. Example: 5001 for Questionnaire Response ID 5001. |
| QuestionnaireAccResponseId | Long | The unique identifier for the accepted response, used to track the response that is considered acceptable for the question. Example: 6001 for Accepted Response ID 6001. |
| ResponseValueDate | Date | The date associated with the response value, typically used for date-based responses. Example: '2023-06-01' for a date-based response. |
| ResponseValueDatetime | Datetime | The exact date and time associated with the response value, providing more precision. Example: '2023-06-01 10:30:00' for a datetime-based response. |
| ResponseValueNumber | Decimal | The numerical value of the response, typically used for rating scales or numeric input. Example: 5 for a rating of 5. |
| ResponseValueText | String | The text response provided by the respondent. Example: 'Yes, the information is correct.' |
| AcceptableResponseId | Long | The unique identifier for the acceptable response, linking the response to a predefined acceptable answer. Example: 7001 for the acceptable response ID. |
| ResponseText | String | The text of the response, providing the detailed answer provided by the respondent. Example: 'The product meets the specifications.' |
| PreferredResponseFlag | Bool | Indicates whether the response is preferred or suggested by the system. Example: True if the response is marked as preferred. |
| AttachmentAllowedCode | String | The code indicating whether attachments are allowed for the response. Example: 'YES' if attachments are allowed. |
| AttachmentAllowed | String | A description of whether attachments are allowed for the response. Example: 'Yes' if the system allows attachments to the response. |
| IsSelectedFlag | Bool | Indicates whether the response has been selected. Example: True if the response was selected by the respondent. |
| DisplayNumber | String | The display number used to identify the response in the questionnaire, often for organizational or sequential purposes. Example: 'Q1' for the first response. |
| DisplaySequence | Int | The sequence number that determines the order in which the response is displayed. Example: 1 for the first response in the section. |
| HasBranchingFlag | Bool | Indicates whether the question has branching logic based on the response. Example: True if the response leads to a new set of questions. |
| FromUI | String | Indicates whether the response was provided via the user interface (UI). Example: 'YES' if the response was submitted through the web interface. |
| ResponseAttachments | String | The attachments associated with the response, providing links or references to any uploaded files. Example: 'file1.pdf, file2.jpg' for attached documents. |
| Finder | String | A reference or placeholder used for searching and locating specific response values. Example: 'Search by Response ID' or 'Search by Question ID'. |
| QuestionnaireRespHeaderId | Long | The unique identifier for the questionnaire response header, linking the response value to the specific questionnaire response. Example: 1001 for Questionnaire Response Header 1001. |
Lists the most recently created or submitted requisitions for a given user, speeding up reorders or reference checks.
| Name | Type | Description |
| RequisitionHeaderId [KEY] | Long | The unique identifier for the requisition header, linking the requisition details to a specific requisition record. Example: 1001 for Requisition Header ID 1001. |
| Description | String | A brief description or title of the requisition, providing context or summary of the requisition's purpose. Example: 'Office Supplies for Q3'. |
| RequisitionNumber | String | The unique identifier or number assigned to the requisition, typically used for tracking and referencing. Example: 'REQ-2023-001' for Requisition Number REQ-2023-001. |
| DocumentStatus | String | The current status of the requisition document, indicating its approval or submission stage. Example: 'APPROVED' for an approved requisition. |
| PreparerId | Long | The unique identifier for the preparer of the requisition, linking the requisition to the person who created it. Example: 2001 for Preparer ID 2001. |
| LineCount | Int | The number of lines or items listed in the requisition, indicating the total number of distinct entries. Example: 10 for a requisition with 10 items. |
| RequisitionAmount | Decimal | The total monetary value of the requisition, representing the overall cost of the requested items. Example: 1500.00 for a requisition worth $1500. |
| ThumbnailImage | String | A link or reference to the thumbnail image associated with the requisition, typically used for visual representation. Example: 'thumbnail_12345.png' for the thumbnail image file. |
| CurrencyCode | String | The code for the currency used in the requisition, helping to identify the currency format. Example: 'USD' for US Dollars. |
| CurrencySymbol | String | The symbol of the currency used in the requisition, displayed alongside monetary values. Example: '$' for US Dollars. |
| RequisitioningBUId | Long | The unique identifier for the requisitioning business unit (BU) associated with the requisition, linking it to the specific department or unit. Example: 3001 for Procurement Unit A. |
| FormattedRequisitionAmount | String | The formatted string representation of the requisition amount, often including currency symbols and thousand separators. Example: '$1,500.00' for a properly formatted amount. |
| BindPreparerId | Long | The identifier for the preparer used to bind and link the requisition to the preparer's user account. Example: 4001 for Preparer ID bound to this requisition. |
| Finder | String | A reference or placeholder used for searching and locating specific requisition records in the system. Example: 'Search by Requisition Number' or 'Search by Preparer'. |
Maintains ad-hoc delivery addresses (for example, temporary job sites) for requisitions, capturing non-standard ship-to details.
| Name | Type | Description |
| AddrElementAttribute1 | String | The first additional address element used to support a flexible address format, often used for customized address fields. Example: 'Suite 101' for an office suite. |
| AddrElementAttribute2 | String | The second additional address element used to support a flexible address format, providing extra address information. Example: 'Building B' for a specific building within a complex. |
| AddrElementAttribute3 | String | The third additional address element, allowing further customization for address formats. Example: 'Floor 3' for specifying the floor in a multi-floor building. |
| AddrElementAttribute4 | String | The fourth additional address element used to capture any other address-related information that does not fit into standard fields. Example: 'North Wing'. |
| AddrElementAttribute5 | String | The fifth additional address element for capturing additional flexible address details. Example: 'Behind the main entrance' to provide further location details. |
| Address1 | String | The first line of the address, typically used for the street address or primary address field. Example: '123 Main St'. |
| Address2 | String | The second line of the address, typically used for suite, apartment, or additional location information. Example: 'Apt. 4B'. |
| Address3 | String | The third line of the address, used when more address information is needed. Example: 'Building 5'. |
| Address4 | String | The fourth line of the address, used to capture any additional address information if necessary. Example: 'Room 101'. |
| LocationId [KEY] | Long | The unique identifier for the location, linking the address details to the specific location record. Example: 12345 for Location ID 12345. |
| AddressLinesPhonetic | String | A phonetic representation of the address, used to help with pronunciation or speech recognition systems. Example: 'One-two-three Main Street' for a simplified address pronunciation. |
| Building | String | The specific name or number of the building at the given address, used to differentiate between buildings within a complex. Example: 'Building A' in a multi-building campus. |
| City | String | The name of the city mentioned in the address, helping to identify the geographic location. Example: 'New York'. |
| CountryCode | String | The country code used for identifying the country in international address formats. Example: 'US' for the United States. |
| County | String | The county mentioned in the address, often used for locations within certain regions or jurisdictions. Example: 'Los Angeles County'. |
| FloorNumber | String | The floor number within the building or complex, helping to identify the specific level of a building. Example: '2' for the second floor. |
| PostalCode | String | The postal code (ZIP code) of the address, used for sorting mail and geographic identification. Example: '90210' for a postal code in Beverly Hills. |
| PostalPlus4Code | String | The four-digit extension to the U.S. postal ZIP code, providing more precise delivery information. Example: '90210-1234' for an extended ZIP code. |
| Province | String | The province mentioned in the address, often used for regions in countries like Canada or other jurisdictions. Example: 'Ontario'. |
| State | String | The state mentioned in the address, helping to further identify the geographic region. Example: 'California'. |
| FormattedAddress | String | The fully formatted address, combining all address elements into a single string for easy reading or output. Example: '123 Main St, Apt. 4B, New York, NY 10001'. |
| Country | String | The country mentioned in the address, identifying the nation where the location is situated. Example: 'United States'. |
| CreatedBy | String | The username or identifier of the person who created the location record. Example: 'admin' for the administrator who created the address. |
| CreationDate | Datetime | The date and time when the location record was created. Example: '2023-06-01 10:00:00' for the creation timestamp. |
| LastUpdatedBy | String | The username or identifier of the person who last updated the location record. Example: 'jdoe' for 'John Doe'. |
| LastUpdateDate | Datetime | The date and time when the location record was last updated. Example: '2023-06-10 15:00:00' for the last update timestamp. |
| Finder | String | A reference or placeholder used for searching and locating specific location records in the system. Example: 'Search by Location ID' or 'Search by City'. |
Stores user-defined requisition defaults—like favorite charge accounts, default delivery locations, or preference settings.
| Name | Type | Description |
| UserPreferenceId [KEY] | Long | The unique identifier for the user's requisition preferences. Example: 1001 for the preferences record associated with User ID 1001. |
| RequisitioningBUId | Long | The unique identifier for the business unit where the requisition preferences are applicable. Example: 2001 for Business Unit A. |
| RequisitioningBU | String | The name of the business unit where the requisition preferences are applicable. Example: 'Procurement' for the Procurement business unit. |
| PersonId | Long | The unique identifier for the user to whom the requisition preferences apply. Example: 3001 for the user 'John Doe'. |
| UserDisplayName | String | The display name of the user for whom the requisition preferences are set. Example: 'John Doe' for the user's name. |
| UserEmail | String | The email address of the user for whom the requisition preferences are applicable. Example: '[email protected]'. |
| RequesterId | Long | The unique identifier for the person making the requisition request. Example: 4001 for Requester ID 4001. |
| Requester | String | The name of the person making the requisition request. Example: 'Jane Smith' for the requester. |
| RequesterEmail | String | The email address of the person making the requisition request. Example: '[email protected]' for the requester's email. |
| DeliverToLocationId | Long | The unique identifier for the location to which the requisitioned goods should be delivered. Example: 5001 for the destination location. |
| DeliverToLocationCode | String | An abbreviation or code used to identify the location where goods should be delivered. Example: 'DLR1' for Delivery Location 1. |
| DeliverToLocationName | String | The name of the delivery location where requisitioned goods should be delivered. Example: 'Warehouse A'. |
| DeliverToAddress | String | The address to which goods should be delivered. Example: '1234 Elm St, Springfield'. |
| FormattedDeliverToAddress | String | A fully formatted version of the delivery address, combining all address components. Example: '1234 Elm St, Springfield, IL 62701'. |
| DestinationOrganizationId | Long | The unique identifier for the organization receiving the requisitioned goods. Example: 6001 for Receiving Organization A. |
| DestinationOrganization | String | The name of the organization receiving the requisitioned goods. Example: 'Sales Department'. |
| DestinationOrganizationCode | String | The code representing the organization receiving the requisitioned goods. Example: 'SALES' for the Sales organization. |
| DestinationTypeCode | String | A code representing the type of destination, such as INVENTORY, EXPENSE, or MANUFACTURING. Example: 'INVENTORY' for goods delivered to inventory. |
| DestinationType | String | The full description of the destination type, determining how goods should be charged. Example: 'Inventory' for goods delivered to inventory. |
| DestinationSubinventory | String | The subinventory or area within the destination organization where goods should be stored. Example: 'Main Warehouse'. |
| WorkOrderId | Long | The unique identifier for the work order associated with the requisition preferences. Example: 7001 for Work Order ID 7001. |
| WorkOrder | String | The name or reference of the work order associated with the requisition. Example: 'Repair Work Order #123'. |
| WorkOrderOperationId | Long | The identifier for the specific operation within the work order. Example: 8001 for Work Order Operation ID 8001. |
| WorkOrderOperationSequence | Decimal | The sequence number indicating the order of operations within the work order. Example: 1.1 for the first operation in sequence. |
| PreferenceType | String | The type of requisition preference to determine where the preferences are applied. Example: 'SSP' for Self-Service Procurement or 'WORK_ORDER' for work order related preferences. |
| OneTimeLocationFlag | Bool | Indicates whether the location is a one-time delivery address. Example: True if the location is for one-time use. |
| InvOrgEnabledForProjectTracking | String | Indicates if the inventory organization is enabled for project tracking. Example: 'Yes' if enabled for tracking requisitions related to projects. |
| ActivePreferenceFlag | Bool | Indicates whether the requisition preferences are active for the user. Example: True if the preferences are currently active, False if inactive. |
| WorkOrderInventoryOrganizationId | Long | The identifier for the inventory organization associated with the work order. Example: 9001 for the inventory organization used in the work order. |
| WorkOrderInventoryOrganizationCode | String | The code for the inventory organization associated with the work order. Example: 'WO_INV' for the work order inventory organization. |
| WorkOrderInventoryOrganization | String | The name of the inventory organization associated with the work order. Example: 'Work Order Inventory'. |
| CreatedBy | String | The username or identifier of the person who created the requisition preferences record. Example: 'admin' for the administrator who created the record. |
| CreationDate | Datetime | The date and time when the requisition preferences record was created. Example: '2023-06-01 09:00:00'. |
| LastUpdatedBy | String | The username or identifier of the person who last updated the requisition preferences record. Example: 'jdoe' for 'John Doe'. |
| LastUpdateDate | Datetime | The date and time when the requisition preferences record was last updated. Example: '2023-06-10 15:00:00'. |
| SetId | Long | The unique identifier for the set of requisition preferences, used to group preferences together. Example: 1001 for Set ID 1001. |
| DeliverToCustomerLocationId | Long | The unique identifier for the customer location to which materials should be delivered. Example: 1101 for Customer Location ID 1101. |
| DeliverToOneTimeAddress | String | A one-time delivery address for requisitioned goods or services. Example: '4567 Oak St, Springfield'. |
| RequisitionBUOptionsOrganizationId | Long | The unique identifier for the business unit options associated with requisitions. Example: 1201 for the Business Unit Options ID. |
| Finder | String | A reference or placeholder used for searching and locating specific requisition preference records. Example: 'Search by User ID' or 'Search by Business Unit'. |
| SysEffectiveDate | Date | The date from which the requisition preferences are effective. Example: '2023-06-01' to specify when the preferences are applicable. |
| EffectiveDate | Date | This query parameter is used to fetch resources which are effective as of the specified start date. Example: '2023-06-01' for fetching records effective from this date. |
Tracks a user’s most commonly used charge accounts, simplifying account selection during requisition line allocation.
| Name | Type | Description |
| RequisitionPreferencesUserPreferenceId [KEY] | Long | The unique identifier for the requisition preferences associated with the favorite charge account. Example: 1001 for User Preference ID 1001. |
| UserPreferenceId | Long | The unique identifier for the user's requisition preferences record. Example: 2001 for the specific user's preferences. |
| UserPreferenceAccountId [KEY] | Long | The unique identifier for the account linked to the user's requisition preferences. Example: 3001 for the account associated with the user's preferences. |
| CodeCombinationId | Long | The unique identifier for the charge account combination, linking it to the accounting setup. Example: 4001 for the specific code combination. |
| ChargeAccountNickname | String | The nickname or alias given to the charge account within the requisition preferences for easier identification. Example: 'Main Office Supplies' for an account used for office supplies. |
| ChargeAccount | String | The actual account to which goods or services requested in the requisition are charged. Example: 'Office Supplies Account' for the account that handles office-related expenses. |
| PrimaryFlag | Bool | Indicates whether the favorite charge account is set as the primary account for requisitions. Example: True if this account is the primary account for the user. |
| Finder | String | A reference or placeholder used for searching and locating specific charge account records. Example: 'Search by Account Nickname' or 'Search by Charge Account'. |
| PersonId | Long | The unique identifier for the person associated with the requisition preferences. Example: 5001 for Person ID 5001. |
| RequisitioningBUId | Long | The unique identifier for the business unit associated with the requisition preferences. Example: 6001 for the Requisitioning Business Unit ID. |
| SysEffectiveDate | Date | The date from which the requisition preferences for the charge account are effective. Example: '2023-06-01' for the effective date of the preference. |
| EffectiveDate | Date | This query parameter is used to fetch resources which are effective as of the specified start date. Example: '2023-06-01' for fetching records effective from this date. |
Enables descriptive flexfields for project costing within a user’s requisition preferences, linking requisition data to project tasks.
| Name | Type | Description |
| RequisitionPreferencesUserPreferenceId [KEY] | Long | The unique identifier for the requisition preferences associated with the project descriptive flexfield (DFF) record. Example: 1001 for User Preference ID 1001. |
| UserPreferenceId [KEY] | Long | The unique identifier for the user's requisition preferences record, linking it to the project DFF. Example: 2001 for the specific user's preferences. |
| _FLEX_Context | String | The context for the DFF, used to define the context in which the DFF is applicable. Example: 'Project Details' for the DFF context. |
| _FLEX_Context_DisplayValue | String | The display value of the DFF context, providing a user-friendly label for the context. Example: 'Project Information' for the context display name. |
| Finder | String | A reference or placeholder used for searching and locating specific project DFF records in the system. Example: 'Search by Context' or 'Search by Project ID'. |
| PersonId | Long | The unique identifier for the person associated with the requisition preferences. Example: 3001 for Person ID 3001. |
| RequisitioningBUId | Long | The unique identifier for the business unit associated with the requisition preferences related to the project. Example: 4001 for the Requisitioning Business Unit ID. |
| SysEffectiveDate | Date | The date from which the requisition preferences for the project DFF are effective. Example: '2023-06-01' for the effective date of the project DFF preferences. |
| EffectiveDate | Date | This query parameter is used to fetch resources which are effective as of the specified start date. Example: '2023-06-01' for fetching records effective from this date. |
Surfaces relevant procurement announcements or updates within a user’s requisitioning context (for example, changes in policy).
| Name | Type | Description |
| RequisitionPreferencesUserPreferenceId [KEY] | Long | The unique identifier for the requisition preferences record associated with purchasing news. Example: 1001 for User Preference ID 1001. |
| PurchasingNewsId [KEY] | Long | The unique identifier for the purchasing news record associated with the requisition preferences. Example: 2001 for Purchasing News ID 2001. |
| RequisitioningBUId | Long | The unique identifier for the business unit where the requisition preferences related to purchasing news are applicable. Example: 3001 for Requisitioning Business Unit ID 3001. |
| PurchasingNews | String | The content of the purchasing news associated with the requisition preferences. Example: 'New purchasing guidelines for Q3' for the relevant news content. |
| Finder | String | A reference or placeholder used for searching and locating specific purchasing news records in the system. Example: 'Search by Purchasing News ID' or 'Search by Business Unit'. |
| PersonId | Long | The unique identifier for the person associated with the requisition preferences. Example: 4001 for Person ID 4001. |
| SysEffectiveDate | Date | The date from which the requisition preferences for the purchasing news are effective. Example: '2023-06-01' for when the preferences become active. |
| UserPreferenceId | Long | The unique identifier for the user's preference record associated with the purchasing news. Example: 5001 for the user's preference ID. |
| EffectiveDate | Date | This query parameter is used to fetch resources which are effective as of the specified start date. Example: '2023-06-01' for fetching records that are effective from this date. |
Reflects configured requisitioning BU features, profile options, and active functional opt-ins that shape the user’s requisition interface.
| Name | Type | Description |
| RequisitionPreferencesUserPreferenceId [KEY] | Long | The unique identifier for the requisition preferences associated with requisitioning options. Example: 1001 for User Preference ID 1001. |
| RequisitioningBUOptionsId [KEY] | Long | The unique identifier for the requisitioning business unit options associated with the requisition preferences. Example: 2001 for Requisitioning Business Unit Options ID 2001. |
| RequisitioningBUId | Long | The unique identifier for the business unit associated with the requisitioning options. Example: 3001 for Requisitioning Business Unit ID 3001. |
| LineTypeId | Long | The unique identifier for the line type associated with requisitioning options. Example: 4001 for Line Type ID 4001. |
| EnableApproverOverrideFlag | Bool | Indicates whether the approver override feature is enabled. Example: True if approver override is allowed for the requisition. |
| ShowInternalSupplyAvailableQuantityFlag | Bool | Indicates whether the internal supply available quantity should be displayed. Example: True if the available quantity of internal supply is visible. |
| HeaderDffContextCode | String | The context code for the header descriptive flexfield (DFF), defining how header-level attributes should be captured. Example: 'REQ_HEADER' for requisition header attributes. |
| LineDffContextCode | String | The context code for the line DFF, defining how line-level attributes should be captured. Example: 'REQ_LINE' for requisition line attributes. |
| DistributionDffContextCode | String | The context code for the distribution DFF, defining how distribution-level attributes should be captured. Example: 'REQ_DIST' for requisition distribution attributes. |
| FunctionalCurrencyCode | String | The currency code used in the requisition, typically reflecting the business unit's functional currency. Example: 'USD' for U.S. Dollars. |
| ChartOfAccountId | Long | The unique identifier for the chart of accounts associated with the requisitioning options. Example: 5001 for Chart of Account ID 5001. |
| ShowDFFByDefault | String | Indicates whether the DFF should be shown by default for requisitioning options. Example: 'Yes' if DFF fields should be displayed by default. |
| ConversionRateType | String | The type of conversion rate used in the requisition. Example: 'Spot Rate' for a rate applied to a specific transaction. |
| ShowAdditionalItemAttributes | String | Indicates whether additional item attributes should be displayed. Example: 'Yes' if extra attributes like color or size should be shown. |
| LESystemDate | Date | The system date for the legal entity (LE), used for date-based validation in the requisition process. Example: '2023-06-01' for the legal entity system date. |
| InventoryOrganizationSystemDate | Date | The system date for the inventory organization, used for inventory-related date validations. Example: '2023-06-01' for the inventory organization system date. |
| PackagingStringOrder | String | The order in which packaging strings should appear for items in the requisition. Example: '1-2-3' to specify a sequence for packaging. |
| DisplayPackagingStringOptinFlag | Bool | Indicates whether the user has opted to display the packaging string. Example: True if the user has opted in to see the packaging string. |
| RequestedDeliveryDateOffset | String | The offset from the requested delivery date, used to calculate the expected delivery date. Example: '2 days' to indicate a two-day delay. |
| ProgressiveWebappOptinFlag | Bool | Indicates whether the user has opted in to use a progressive web app (PWA) for requisitioning. Example: True if the user opts in for PWA functionality. |
| InternalMaterialTransfersOptinFlag | Bool | Indicates whether the user has opted in for internal material transfers. Example: True if the user allows internal material transfers in requisitions. |
| ExpenseAgreementLinesFromInternalSourcesOptinFlag | Bool | Indicates whether the user has opted in to include expense agreement lines from internal sources. Example: True if the user permits such lines. |
| AllowOnetimeAddrFlag | Bool | Indicates whether one-time delivery addresses are allowed in requisitions. Example: True if one-time addresses can be used for deliveries. |
| ProjectCostingFeatureOptinFlag | Bool | Indicates whether the user has opted in to use project costing features in requisitioning. Example: True if project costing features are enabled for the user. |
| PJCAllowAccountOverride | String | Indicates whether account overrides are allowed in project costing for requisitions. Example: 'Yes' if account overrides are permitted for project costing. |
| RequestedDateInLocalTimeOptinFlag | Bool | Indicates whether the user has opted in to use local time for requested delivery dates. Example: True if the delivery dates should reflect the local time zone. |
| InvoiceHoldOptinFlag | Bool | Indicates whether the user has opted in to put invoices on hold in the requisitioning process. Example: True if invoices can be held for review. |
| CatalogInformationTemplateApplicableFlag | Bool | Indicates whether catalog information templates are applicable for requisitions. Example: True if templates from the catalog can be used for requisitioning. |
| SpecialHandlingOptinFlag | Bool | Indicates whether the user has opted in to handle special requisition requirements. Example: True if special handling flags can be used in requisition requests. |
| ShopFromPreferredSourceOptinFlag | Bool | Indicates whether the user has opted to shop from preferred sources for requisitions. Example: True if preferred suppliers are prioritized. |
| EPPOptinFlag | Bool | Indicates whether the user has opted in to use the Electronic Purchase Order (EPP) system. Example: True if EPP is enabled for the user. |
| BpaDescriptionOverrideProfileOptionFlag | Bool | Indicates whether the user has opted to override the description profile in Blanket Purchase Agreements (BPA). Example: True if the description override is allowed. |
| MarketplaceOptinFlag | Bool | Indicates whether the user has opted to participate in the marketplace for requisitioning. Example: True if the marketplace is enabled for the user. |
| SSPImplementedFlag | Bool | Indicates whether the Self-Service Procurement (SSP) feature is implemented for the user. Example: True if SSP is implemented. |
| NextGenSSPSupplierRegistrationOptinFlag | Bool | Indicates whether the user has opted into the NextGen SSP Supplier Registration. Example: True if the user is enrolled in the NextGen SSP supplier registration program. |
| Finder | String | A reference or placeholder used for searching and locating specific requisition preferences records. Example: 'Search by User ID' or 'Search by Business Unit'. |
| PersonId | Long | The unique identifier for the person associated with the requisition preferences. Example: 7001 for Person ID 7001. |
| SysEffectiveDate | Date | The system effective date, used to determine when the requisition preferences become valid. Example: '2023-06-01' for when the requisition preferences take effect. |
| UserPreferenceId | Long | The unique identifier for the user preference record. Example: 8001 for the user's preference ID. |
| EffectiveDate | Date | This query parameter is used to fetch resources which are effective as of the specified start date. Example: '2023-06-01' for fetching records that are effective from this date. |
Handles the conversion of approved requisition lines into purchase documents (for example, purchase orders), orchestrating the procurement flow.
| Name | Type | Description |
| RequestHeaderId [KEY] | Long | The unique identifier for the request header in the requisition processing system. Example: 1001 for Request Header ID 1001. |
| ProcurementBUId | Long | The unique identifier for the business unit responsible for managing the requisition and corresponding purchase order or negotiation. Example: 2001 for Procurement Business Unit A. |
| ProcurementBU | String | The name of the business unit managing and owning the requisition and corresponding purchase order or negotiation. Example: 'Procurement' for the Procurement department. |
| RequisitioningBUId | Long | The unique identifier for the business unit that raised the requisition. Example: 3001 for the business unit that raised the requisition for office supplies. |
| RequisitioningBU | String | The name of the business unit that raised the requisition for goods or services. Example: 'Sales' for the business unit requesting the purchase. |
| Type | String | The type of document being processed, which can represent a new order, an existing order, or a negotiation. Example: 'New Order' for newly created requisitions. |
| SoldToLegalEntityId | Long | The unique identifier for the legal entity that is financially responsible for purchases on the purchase order. Example: 4001 for the legal entity responsible for the purchase. |
| SoldToLegalEntity | String | The legal entity responsible for the financial obligations of the purchase order. Example: 'ABC Corporation' for the legal entity making the purchase. |
| SupplierId | Long | The unique identifier for the supplier of the goods or services. Example: 5001 for Supplier ID 5001. |
| Supplier | String | The name of the supplier providing the goods or services. Example: 'XYZ Supplies Ltd.' for the company supplying the requested items. |
| SupplierSiteId | Long | The unique identifier for the supplier site. Example: 6001 for the supplier's location where the goods will be sent from. |
| SupplierSite | String | The location that the supplier uses for order fulfillment. Example: 'Warehouse A' for the supplier's main distribution center. |
| DocumentStyleId | Long | The unique identifier for the purchasing document style. Example: 7001 for Purchase Order Document Style ID 7001. |
| DocumentStyle | String | The name of the purchasing document style, used to control the display and parameters of the document. Example: 'Standard PO' for the default purchasing document style. |
| SourceAgreementId | Long | The unique identifier for the source agreement linked to the requisition. Example: 8001 for Source Agreement ID 8001. |
| SourceAgreement | String | The number that uniquely identifies the source agreement. Example: 'AGT-123' for the agreement under which goods are being procured. |
| CurrencyCode | String | The currency code used for the purchase order. Example: 'USD' for U.S. Dollars. |
| Currency | String | The currency of the purchase order. Example: 'USD' for a purchase order in U.S. Dollars. |
| ConversionRateTypeCode | String | The abbreviation identifying the type of conversion rate used to determine currency conversion. Example: 'Spot Rate' for the conversion rate applied on a given day. |
| ConversionRateType | String | The type of conversion rate used for currency conversion in the purchase order. Example: 'Market Rate' for using the market rate at the time of purchase. |
| ConversionRateDate | Date | The date used for the conversion rate when converting an ordered amount into another currency. Example: '2023-06-01' for the conversion rate applicable on this date. |
| ConversionRate | Decimal | The rate used to convert the purchase order amount from one currency to another. Example: 1.1 for the conversion rate from EUR to USD. |
| BuyerId | Long | The unique identifier for the buyer responsible for managing the procurement document. Example: 9001 for Buyer ID 9001. |
| Buyer | String | The person responsible for managing and overseeing the procurement process. Example: 'John Doe' for the buyer handling the requisition. |
| GroupRequisitionLines | String | Indicates whether requisition lines are grouped together on purchase order lines. Example: 'Y' if requisition lines are grouped, 'N' if they are not grouped. |
| OrderNumber | String | The unique number assigned to the purchase order. Example: 'PO-1001' for the first purchase order in the system. |
| POHeaderId | Long | The unique identifier for the purchase order header. Example: 10001 for Purchase Order Header ID 10001. |
| Finder | String | A reference or placeholder used for searching and locating specific requisition processing request records. Example: 'Search by Order Number' or 'Search by Buyer'. |
Specifies which approved requisition lines are to be processed into new or existing purchasing documents.
| Name | Type | Description |
| RequisitionProcessingRequestsRequestHeaderId [KEY] | Long | The unique identifier for the request header in the requisition processing system, associated with the lines of a requisition. Example: 1001 for Request Header ID 1001. |
| RequestLineId [KEY] | Long | The unique identifier for the requisition processing request line, linking it to the request header. Example: 2001 for Request Line ID 2001. |
| RequestHeaderId | Long | The unique identifier for the header of the requisition request to which the line belongs. Example: 3001 for the requisition header that encompasses all request lines. |
| RequisitionLineId | Long | The unique identifier for the requisition line within the requisition document. Example: 4001 for Requisition Line ID 4001, indicating a specific item requested. |
| Finder | String | A reference or placeholder used for searching and locating specific requisition processing request line records. Example: 'Search by Request Line ID' or 'Search by Requisition Header ID'. |
Retrieves extended information about a requisition item, including its description, category, and associated services or configurations.
| Name | Type | Description |
| ItemKey | String | A unique identifier for the item in the requisition product details. Example: 'ABC123' for a specific product key. |
| PunchoutItemIdentifier | Long | The unique identifier for an item in a punchout catalog, used to link external catalog data. Example: 10001 for the punchout item identifier. |
| PunchoutCatalogId | Long | The unique identifier for the punchout catalog from which the item is sourced. Example: 20001 for Punchout Catalog ID. |
| ItemDescription | String | A brief description of the item in the requisition. Example: 'Wireless Mouse' for a mouse being requested. |
| LongDescription | String | A detailed description of the item in the requisition, providing further specifications. Example: 'Ergonomic wireless mouse with Bluetooth connectivity'. |
| CurrencyCode | String | The currency code used for pricing the item in the requisition. Example: 'USD' for U.S. Dollars. |
| OrderTypeLookupCode | String | The lookup code that defines the type of order for the item. Example: 'EXPENSE' for an expense-type order. |
| CategoryName | String | The name of the category under which the item is classified. Example: 'Electronics' for items in the electronics category. |
| CurrencyUnitPrice | Decimal | The unit price of the item in the requisition, in the specified currency. Example: 25.99 for the price of one unit in USD. |
| UnitPrice | Decimal | The price of one unit of the item in the default currency. Example: 20.00 for the unit price of the item. |
| CurrencyAmount | Decimal | The total amount for the item in the requisition, in the specified currency. Example: 100.00 for the total cost in USD. |
| Amount | Decimal | The total amount for the item in the default currency. Example: 80.00 for the total amount of the item. |
| SuggestedVendorName | String | The name of the vendor suggested for the purchase of the item. Example: 'ABC Supplies' for the suggested supplier. |
| Manufacturer | String | The manufacturer of the item. Example: 'Logitech' for the maker of the wireless mouse. |
| ThumbnailImage | String | A small image representing the item in the requisition. Example: 'thumbnail.jpg' for an image file of the item. |
| ItemSource | String | The source from which the item is being procured. Example: 'Internal' for items sourced within the company. |
| FunctionalCurrencyCode | String | The currency code of the functional currency used in the business unit. Example: 'USD' for U.S. Dollars as the functional currency. |
| CatalogItemKey [KEY] | Long | The unique key for the item in the catalog. Example: 30001 for Catalog Item Key 30001. |
| FunctionalCurrencySymbol | String | The symbol for the functional currency. Example: '$' for the symbol used in USD. |
| ManufacturerPartNumber | String | The part number assigned by the manufacturer for the item. Example: '12345X' for a specific manufacturer's part number. |
| SupplierPartNumber | String | The part number assigned by the supplier for the item. Example: 'XYZ678' for a supplier-specific part number. |
| UOM | String | The unit of measure for the item in the requisition. Example: 'Each' for a unit of measure indicating individual items. |
| RequisitioningBUId | Long | The unique identifier for the business unit that raised the requisition for the item. Example: 4001 for the business unit requesting the item. |
| FormattedUnitPrice | String | The formatted price for one unit of the item, including the currency symbol. Example: '$25.99' for the unit price in USD. |
| FormattedCurrencyUnitPrice | String | The formatted price for one unit of the item in the specified currency, including the currency symbol. Example: '€23.50' for the unit price in EUR. |
| FormattedAmount | String | The formatted total amount for the item in the requisition. Example: '$100.00' for the total price of the item. |
| FormattedCurrencyAmount | String | The formatted total amount for the item, including the currency symbol. Example: '€90.00' for the total cost in EUR. |
| Bind_itemId | Long | The binding ID for the item in the requisition. Example: 5001 for Item ID 5001. |
| Bind_punchoutItemIdentifier | Long | The binding ID for the punchout item identifier. Example: 6001 for the binding of the punchout item identifier. |
| Bind_sourceDocLineId | Long | The binding ID for the source document line associated with the item. Example: 7001 for the binding of the source document line. |
| Finder | String | A reference or placeholder used for searching and locating specific requisition product detail records. Example: 'Search by Item Key' or 'Search by Supplier'. |
Displays tiered or location-based price variations for an item in a requisition, guiding cost-effective purchasing decisions.
| Name | Type | Description |
| RequisitionProductDetailsCatalogItemKey [KEY] | Long | The unique identifier for the catalog item associated with the price breaks. Example: 1001 for Catalog Item Key 1001. |
| Quantity | Decimal | The quantity of items eligible for the specified price break. Example: 10 for a price break applicable to 10 units. |
| Price | Decimal | The price per unit for the item at the specified quantity. Example: 15.00 for a price of $15 per unit when 10 units are ordered. |
| Discount | Decimal | The discount applied to the item at the specified quantity. Example: 5.00 for a $5 discount per unit when the quantity is 10. |
| StartDate | Date | The date when the price break is applicable from. Example: '2023-06-01' for the start date of the price break. |
| EndDate | Date | The date when the price break expires or is no longer applicable. Example: '2023-06-30' for the end date of the price break. |
| LineLocationId [KEY] | Long | The unique identifier for the location on the requisition line where the price break is applicable. Example: 2001 for Line Location ID 2001. |
| DeliverTo | String | The location where the item is to be delivered, tied to the price break. Example: 'Warehouse A' for the delivery location. |
| UnitOfMeasure | String | The unit of measure for the item associated with the price break. Example: 'Each' for individual units of the item. |
| CurrencyCode | String | The currency code used for the price break. Example: 'USD' for U.S. Dollars as the currency for the price break. |
| FunctionalCurrencySymbol | String | The symbol for the functional currency used for the price break. Example: '$' for the symbol of USD. |
| FunctionalCurrencyCode | String | The code for the functional currency used in the price break. Example: 'USD' for U.S. Dollars as the functional currency. |
| FunctionalCurrencyPrice | Decimal | The price of the item in the functional currency, accounting for the price break. Example: 12.00 for the functional currency price of the item. |
| FormattedPrice | String | The formatted price for the item, including the currency symbol. Example: '$15.00' for the price formatted in USD. |
| FormattedFunctionalCurrencyPrice | String | The formatted price in the functional currency, including the currency symbol. Example: '€13.00' for the price in EUR. |
| FormattedDiscount | String | The formatted discount amount, including the currency symbol. Example: '-$5.00' for the discount formatted in USD. |
| Bind_itemId | Long | The binding ID for the item associated with the price break. Example: 3001 for the item ID linked to this price break. |
| Bind_punchoutItemIdentifier | Long | The binding ID for the punchout item identifier, used for external catalog data. Example: 4001 for the punchout item ID. |
| Bind_sourceDocLineId | Long | The binding ID for the source document line associated with the price break. Example: 5001 for the line ID from the source document. |
| CatalogItemKey | Long | The unique key for the catalog item in the price break record. Example: 6001 for the catalog item key. |
| Finder | String | A reference or placeholder used for searching and locating specific requisition product details price break records. Example: 'Search by Catalog Item' or 'Search by Quantity'. |
Represents the smart form configuration for procuring items or services, capturing fields and validation logic for shopper input.
| Name | Type | Description |
| SmartFormId [KEY] | Long | The unique identifier for the smart form in the shopping catalog. Example: 1001 for SmartForm ID 1001. |
| ProcurementBUId | Long | The unique identifier for the business unit responsible for managing the procurement of items within the smart form. Example: 2001 for Procurement Business Unit A. |
| ProcurementBU | String | The name of the procurement business unit. Example: 'Procurement' for the department managing requisitions. |
| SmartFormName | String | The name of the smart form used in the shopping catalog. Example: 'Office Supplies Order Form' for a specific order form. |
| InstructionText | String | The instructional text provided for users filling out the smart form. Example: 'Please select the items you wish to purchase.' |
| LineTypeId | Long | The unique identifier for the type of line item in the smart form. Example: 3001 for a line item in the form. |
| LineType | String | The type of line item within the smart form. Example: 'Product' for items that represent individual products. |
| ProductType | String | The type of product associated with the smart form. Example: 'Electronics' for items that fall under electronics category. |
| PurchaseBasis | String | The basis on which the purchase is made. Example: 'Per Unit' for purchases made based on individual unit pricing. |
| ItemDescription | String | A description of the item in the smart form. Example: 'Laptop 15 inch with 16GB RAM' for a detailed description of the product. |
| DescriptionEditableFlag | Bool | Indicates whether the description field is editable by the user. Example: true if the description can be edited, false if it is fixed. |
| RestrictToBrowsingCategoryId | Long | The ID of the category that limits the browsing to certain items within the smart form. Example: 4001 for restricting the form to electronics only. |
| RestrictToBrowsingCategoryName | String | The name of the category that restricts browsing for items. Example: 'Office Supplies' for limiting item selection to office supplies. |
| CategoryId | Long | The unique identifier for the category under which the items in the smart form are listed. Example: 5001 for the category of 'Laptops'. |
| CategoryName | String | The name of the category for the items in the smart form. Example: 'Electronics' for the category name. |
| CategoryEditableFlag | Bool | Indicates whether the category name is editable. Example: true if users can modify the category, false if the category is fixed. |
| CurrencyCode | String | The currency code for pricing in the smart form. Example: 'USD' for U.S. Dollars. |
| Currency | String | The currency used for the pricing of the items in the smart form. Example: 'USD' for U.S. Dollars. |
| CurrencyEditableFlag | Bool | Indicates whether the currency field is editable. Example: true if users can select a different currency, false if it is locked. |
| Quantity | Decimal | The quantity of items being ordered in the smart form. Example: 5 for ordering five units of an item. |
| UOMCode | String | The unit of measure code for the items in the smart form. Example: 'EA' for 'Each' unit of measure. |
| UOM | String | The unit of measure for the item in the smart form. Example: 'Each' for individual units of the item. |
| UOMEditableFlag | Bool | Indicates whether the unit of measure is editable. Example: true if users can change the UOM, false if it is fixed. |
| UnitPrice | Decimal | The unit price of the item in the smart form. Example: 20.00 for the price of one unit of the item. |
| UnitPriceEditableFlag | Bool | Indicates whether the unit price is editable. Example: true if the price can be modified, false if it is fixed. |
| Amount | Decimal | The total amount for the item in the smart form, calculated based on quantity and unit price. Example: 100.00 for 5 units at 20.00 each. |
| AmountEditableFlag | Bool | Indicates whether the total amount is editable. Example: false if the amount is calculated automatically and cannot be changed. |
| NegotiationRequiredFlag | Bool | Indicates whether negotiation is required for the item. Example: true if the item requires a negotiation process before purchase. |
| NegotiationRequiredEditableFlag | Bool | Indicates whether the negotiation required flag is editable. Example: false if the flag is automatically set based on item characteristics. |
| NegotiatedByPreparerFlag | Bool | Indicates whether the item was negotiated by the preparer. Example: true if the preparer has negotiated the item pricing. |
| NegotiatedEditableFlag | Bool | Indicates whether the negotiated price is editable. Example: false if the negotiated price cannot be changed by the user. |
| SourceAgreementHeaderId | Long | The unique identifier for the source agreement header associated with the item. Example: 6001 for the agreement header ID. |
| AgreementEditableFlag | Bool | Indicates whether the agreement is editable. Example: false if the agreement terms are fixed and cannot be changed. |
| SourceAgreement | String | The source agreement associated with the item. Example: 'AGT-123' for a specific agreement that covers the item. |
| SupplierId | Long | The unique identifier for the supplier associated with the item in the smart form. Example: 7001 for Supplier ID 7001. |
| Supplier | String | The name of the supplier providing the item. Example: 'XYZ Supplies' for the company supplying the items. |
| SupplierEditableFlag | Bool | Indicates whether the supplier name is editable. Example: false if the supplier is pre-selected and cannot be changed. |
| SupplierSiteId | Long | The unique identifier for the supplier site associated with the item. Example: 8001 for Supplier Site ID 8001. |
| SupplierSite | String | The name of the supplier site from which the item will be shipped. Example: 'Main Warehouse' for the shipping site. |
| SupplierSiteEditableFlag | Bool | Indicates whether the supplier site is editable. Example: true if users can select a different site, false if it is fixed. |
| SupplierContactId | Long | The unique identifier for the supplier contact associated with the item. Example: 9001 for Supplier Contact ID 9001. |
| SupplierContact | String | The name of the supplier contact. Example: 'John Doe' for the contact person at the supplier. |
| SupplierContactEditableFlag | Bool | Indicates whether the supplier contact is editable. Example: true if users can change the contact person, false if it is fixed. |
| SupplierContactPhone | String | The phone number for the supplier contact. Example: '(123) 456-7890' for the contact’s phone number. |
| SupplierContactPhoneEditableFlag | Bool | Indicates whether the supplier contact phone number is editable. Example: true if users can modify the phone number. |
| SupplierContactFax | String | The fax number for the supplier contact. Example: '(123) 456-7891' for the contact’s fax number. |
| SupplierContactFaxEditableFlag | Bool | Indicates whether the supplier contact fax number is editable. Example: true if users can modify the fax number. |
| SupplierContactEmail | String | The email address for the supplier contact. Example: '[email protected]' for the contact’s email. |
| SupplierContactEmailEditableFlag | Bool | Indicates whether the supplier contact email is editable. Example: true if users can update the email address. |
| SupplierItemNumber | String | The supplier-specific part number for the item. Example: 'SUP12345' for the part number assigned by the supplier. |
| SupplierItemEditableFlag | Bool | Indicates whether the supplier item number is editable. Example: false if the item number is pre-populated and cannot be modified. |
| Manufacturer | String | The manufacturer of the item. Example: 'Logitech' for the manufacturer of a wireless mouse. |
| ManufacturerEditableFlag | Bool | Indicates whether the manufacturer field is editable. Example: true if users can select a different manufacturer. |
| ManufacturerPartNumber | String | The part number assigned by the manufacturer. Example: 'LGT123' for the manufacturer’s part number. |
| PartNumberEditableFlag | Bool | Indicates whether the manufacturer part number is editable. Example: false if the part number is fixed and cannot be changed. |
| CreatedBy | String | The name of the user who created the smart form. Example: 'John Doe' for the creator of the form. |
| CreationDate | Datetime | The date and time when the smart form was created. Example: '2023-06-01 10:00:00' for the creation timestamp. |
| LastUpdateDate | Datetime | The date and time when the smart form was last updated. Example: '2023-06-05 14:00:00' for the last update timestamp. |
| LastUpdatedBy | String | The name of the user who last updated the smart form. Example: 'Jane Smith' for the person who last modified the form. |
| LineTypeOrderTypeLookupCode | String | The lookup code that defines the order type for the line item. Example: 'EXPENSE' for an expense-type order. |
| AllowOrderFromUnassignedSitesFlag | Bool | Indicates whether the smart form allows orders from unassigned sites. Example: true if orders can be placed from any site, false if restricted. |
| Finder | String | A reference or placeholder used for searching and locating specific shopping catalog smart form detail records. Example: 'Search by Supplier' or 'Search by Smart Form ID'. |
| SysEffectiveDate | String | The system-effective date used to filter resources based on their effective date. Example: '2023-06-01' for filtering by this date. |
| EffectiveDate | Date | This query parameter is used to fetch resources that are effective as of the specified start date. Example: '2023-06-01' for the resources effective from June 1st, 2023. |
Indicates which requisitioning business units are assigned to an agreement specified in a smart form, defining usage scope.
| Name | Type | Description |
| ShoppingCatalogSmartFormDetailsSmartFormId [KEY] | Long | The unique identifier for the smart form associated with the agreement requisition business unit assignment. Example: 1001 for Smart Form ID. |
| RequisitionBUAssignmentId [KEY] | Long | The unique identifier for the requisition business unit assignment related to the smart form. Example: 2001 for the assignment ID. |
| RequisitioningBUId | Long | The unique identifier for the business unit that raised the requisition. Example: 3001 for the business unit raising the requisition. |
| RequisitioningBUName | String | The name of the business unit that raised the requisition. Example: 'Purchasing Department' for the name of the requisitioning business unit. |
| SupplierSiteId | Long | The unique identifier for the supplier site associated with the requisition. Example: 4001 for Supplier Site ID 4001. |
| SupplierSite | String | The name of the supplier site where goods or services will be delivered. Example: 'Main Warehouse' for the supplier site. |
| SupplierContactId | Long | The unique identifier for the supplier contact. Example: 5001 for Supplier Contact ID 5001. |
| SupplierContact | String | The name of the supplier contact person for the requisition. Example: 'John Doe' for the contact person at the supplier. |
| SupplierContactEmail | String | The email address of the supplier contact. Example: '[email protected]' for the supplier contact's email. |
| SupplierContactPhone | String | The phone number of the supplier contact. Example: '(123) 456-7890' for the supplier contact's phone number. |
| SupplierContactFax | String | The fax number of the supplier contact. Example: '(123) 456-7891' for the supplier contact's fax number. |
| Finder | String | A reference or placeholder used for searching and locating specific records of supplier contact details in the agreement requisition assignments. Example: 'Search by Supplier Contact Name'. |
| SmartFormId | Long | The unique identifier for the associated smart form. Example: 1002 for SmartForm ID 1002. |
| SysEffectiveDate | String | The system-effective date used for filtering the resource by its effective date. Example: '2023-06-01' for filtering based on this date. |
| EffectiveDate | Date | This query parameter is used to fetch resources that are effective as of the specified start date. Example: '2023-06-01' for filtering by June 1st, 2023. |
Holds references to files attached to a smart form, such as instructions or supplementary materials for the shopper.
| Name | Type | Description |
| ShoppingCatalogSmartFormDetailsSmartFormId [KEY] | Long | The unique identifier for the smart form associated with the attachment. Example: 1001 for the smart form ID. |
| AttachedDocumentId [KEY] | Long | The unique identifier for the attached document. Example: 2001 for the document ID of the attached file. |
| LastUpdateDate | Datetime | The date and time when the attachment record was last updated. Example: '2023-06-01 12:00:00' for the last update timestamp. |
| LastUpdatedBy | String | The user who last updated the attachment record. Example: 'Jane Doe' for the person who modified the attachment details. |
| DatatypeCode | String | A code representing the data type of the attachment. Example: 'PDF' for a Portable Document Format attachment. |
| FileName | String | The name of the attached file. Example: 'Invoice_12345.pdf' for a specific invoice file. |
| DmFolderPath | String | The path of the folder where the attachment file is stored. Example: '/documents/invoices' for the folder containing the attachment. |
| DmDocumentId | String | The document ID from which the attachment is created. Example: 'DOC-12345' for a document ID associated with the file. |
| DmVersionNumber | String | The version number of the document from which the attachment was created. Example: 'v1.0' for the version of the original document. |
| Url | String | The URL of the web page type attachment. Example: 'https://www.example.com/file.pdf' for the online URL of the file. |
| CategoryName | String | The category under which the attachment falls. Example: 'Invoice' for an attachment categorized as an invoice document. |
| UserName | String | The username of the person who created the attachment record. Example: 'jdoe' for the user who uploaded the file. |
| Uri | String | The URI of a Topology Manager type attachment. Example: '/path/to/attachment/abc123' for the URI to access the attachment. |
| FileUrl | String | The URL to access the attachment file. Example: 'https://www.example.com/file.pdf' for the location of the uploaded file. |
| UploadedText | String | The text content of a new text attachment. Example: 'Important document regarding the purchase order.' |
| UploadedFileContentType | String | The content type of the attached file, indicating its format. |
| UploadedFileLength | Long | The size of the attachment file in bytes. Example: 204800 for a 200 KB file. |
| UploadedFileName | String | The name to assign to the new attachment file. Example: 'Invoice_12345.pdf' for the designated file name. |
| ContentRepositoryFileShared | Bool | Indicates whether the file is shared. Example: true if the file is shared with others, false if not. |
| Title | String | The title of the attachment. Example: 'Purchase Order Invoice' for the title used for the attachment. |
| Description | String | A description of the attachment. Example: 'This document contains the invoice for order #12345.' |
| ErrorStatusCode | String | The error code, if any, associated with the attachment upload. Example: 'ERR001' for a generic upload error code. |
| ErrorStatusMessage | String | The error message, if any, associated with the attachment upload. Example: 'File format not supported.' |
| CreatedBy | String | The user who created the attachment record. Example: 'John Doe' for the user who uploaded the file. |
| CreationDate | Datetime | The date and time when the attachment was created. Example: '2023-05-01 10:00:00' for the timestamp when the attachment was first uploaded. |
| FileContents | String | The contents of the attachment, if it is a text-based file. Example: 'This is the text content of the uploaded document.' |
| ExpirationDate | Datetime | The expiration date for the attachment contents. Example: '2023-12-31 23:59:59' for when the attachment expires. |
| LastUpdatedByUserName | String | The username of the person who last updated the attachment. Example: 'jdoe' for the last user who modified the attachment. |
| CreatedByUserName | String | The username of the person who initially created the attachment. Example: 'mdoe' for the creator of the attachment. |
| AsyncTrackerId | String | An identifier used by the Attachment UI components to assist in uploading files asynchronously. Example: 'tracker123' for tracking the upload process. |
| FileWebImage | String | The Base64 encoded image of the file displayed in .png format, if the source file is a convertible image. Example: 'data:image/png;Base64,...' for a Base64 encoded image. |
| DownloadInfo | String | A JSON object represented as a string containing the necessary information to retrieve the attachment programmatically. Example: '{\url\ |
| PostProcessingAction | String | The action that can be performed after the attachment is uploaded. Example: 'Notify User' for sending an email notification after upload completion. |
| Finder | String | A placeholder or reference for searching and locating attachment records. Example: 'Search by Document Type' or 'Search by Attachment ID'. |
| SmartFormId | Long | The unique identifier for the smart form associated with the attachment. Example: 1003 for the associated smart form ID. |
| SysEffectiveDate | String | The system-effective date used for filtering the resources based on their effective date. Example: '2023-06-01' for filtering by this date. |
| EffectiveDate | Date | This query parameter is used to fetch resources that are effective as of the specified start date. Example: '2023-06-01' for filtering resources effective from June 1st, 2023. |
Associates information templates (additional fields or questionnaires) with a smart form, ensuring comprehensive data collection.
| Name | Type | Description |
| ShoppingCatalogSmartFormDetailsSmartFormId [KEY] | Long | The unique identifier for the smart form associated with the information template assignment. Example: 1001 for the smart form ID. |
| SmartFormId | Long | The unique identifier for the smart form used in the assignment. Example: 2001 for the smart form ID associated with the template. |
| InformationTemplateAssignmentId [KEY] | Long | The unique identifier for the information template assignment. Example: 3001 for the ID of the information template assignment. |
| InformationTemplateId | Long | The unique identifier for the information template. Example: 4001 for the ID of the assigned template. |
| InformationTemplate | String | The name of the information template being assigned. Example: 'Procurement Template' for the assigned template. |
| InformationTemplateDisplayName | String | The display name of the information template. Example: 'Purchase Order Template' for the user-friendly name of the template. |
| InstructionText | String | The instruction text associated with the information template. Example: 'Please fill in the required fields for the purchase order.' |
| DFFContextCode | String | The context code for the descriptive flexfield associated with the information template assignment. Example: 'PO_HEADER' for a context related to purchase orders. |
| Finder | String | A reference or placeholder used for searching and locating specific records of the information template assignment. Example: 'Search by Template Name'. |
| SysEffectiveDate | String | The system-effective date used for filtering resources based on their effective date. Example: '2023-06-01' for filtering based on June 1st, 2023. |
| EffectiveDate | Date | This query parameter is used to fetch resources that are effective as of the specified start date. Example: '2023-06-01' for filtering resources effective from June 1st, 2023. |
Aggregates both personal and public shopping list headers to quickly locate items for requisition creation.
| Name | Type | Description |
| ShoppingListHeaderId [KEY] | Long | Unique identifier for the shopping list header in the ShoppingLists table, used to group related shopping list items. |
| ShoppingList | String | Name or label of the shopping list, representing the list of items being managed or purchased. |
| ShoppingListDescription | String | Detailed description or notes about the shopping list, providing additional context for the items included. |
| ShoppingListType [KEY] | String | Categorization or classification of the shopping list, indicating whether it’s a personal, corporate, or special-purpose list. |
| ImageURL | String | URL pointing to an image representing the shopping list, often used for visual reference in a user interface. |
| CreationDate | Datetime | The date and time when the shopping list was initially created in the system. |
| CreatedBy | String | Identifier or name of the user who created the shopping list. |
| LastUpdatedBy | String | Identifier or name of the user who last updated the shopping list. |
| LastUpdateDate | Datetime | The date and time when the shopping list was last modified or updated. |
| Finder | String | Search or query reference related to the shopping list, potentially used for filtering or lookup purposes in the system. |
| RequisitioningBUId | Long | Identifier for the business unit that is responsible for requisitioning items on the shopping list, linking it to a specific organizational unit. |
| ShoppingListName | String | The specific name given to the shopping list, which is typically used for easy identification and reference. |
Enables keyword or attribute-based item searches within procurement catalogs, streamlining the user’s shopping experience.
| Name | Type | Description |
| SearchPhraseId [KEY] | Long | Unique identifier for the search phrase used in the ShoppingSearches table, allowing for individual tracking of search queries. |
| SearchDate | Date | The date on which the search was performed, helping to track when the search activity occurred. |
| SearchPhraseTerms | String | The specific words or terms entered by the user in the search query, representing the string used to search for items or information. |
| RequisitioningBUId | Long | Unique identifier for the business unit that initiated the search, indicating the organizational unit responsible for the search. |
| Finder | String | Search or query reference related to the ShoppingSearches, potentially used for filtering or looking up past search results. |
Applies brand-specific filters to search results, helping users refine item listings by preferred or authorized brands.
| Name | Type | Description |
| ShoppingSearchesSearchPhraseId [KEY] | Long | Unique identifier linking to the search phrase used in the ShoppingSearches table, allowing the filtering of search results by specific phrases. |
| Manufacturer [KEY] | String | The name of the manufacturer associated with the filtered items in the search results, used to narrow down searches based on brand or maker. |
| TotalItems | String | The total number of items available or matching the filter criteria, providing a count of filtered products or results. |
| Finder | String | Search or query reference related to the ShoppingSearchesbrandFilters, likely used for filtering or looking up past searches and their results. |
| SearchPhraseId | Long | Unique identifier for the search phrase used in the search filter, linking to the SearchPhraseId in the ShoppingSearches table to identify specific search queries. |
Holds detailed data for items returned in a shopping search, including item ID, pricing, and availability.
| Name | Type | Description |
| ShoppingSearchesSearchPhraseId [KEY] | Long | Unique identifier linking to the search phrase used in the ShoppingSearches table, allowing for specific filtering of result items by search term. |
| ItemKey [KEY] | String | Unique identifier for the item in the result set, allowing for precise tracking and referencing of individual items. |
| ItemId | Long | Unique identifier for the item within the system, used for internal tracking and linking to the item’s detailed data. |
| PunchoutItemId | Long | Identifier for punchout items, typically used in procurement systems to represent items sourced from external catalogs. |
| PunchoutCatalogId | Long | Identifier for the punchout catalog that the item belongs to, linking it to a third-party supplier's catalog. |
| ItemDescription | String | A detailed description of the item, providing relevant information about the product for the search result. |
| CurrencyCode | String | Code representing the currency in which the item’s prices are listed, such as USD or EUR. |
| OrderTypeLookupCode | String | Lookup code identifying the type of order, used for categorizing orders based on their purpose or processing method. |
| CategoryName | String | The name of the category to which the item belongs, helping to classify the item within a specific group for easier searching. |
| CurrencyUnitPrice | Decimal | The unit price of the item in the specified currency, used to indicate the cost per individual item. |
| UnitPrice | Decimal | The unit price of the item, potentially in the system's default currency, representing the cost per unit. |
| CurrencyAmount | Decimal | The total price of the item in the specified currency, calculated by multiplying the unit price by the quantity. |
| Amount | Decimal | The total price of the item, potentially in the system's default currency, calculated by multiplying the unit price by the quantity. |
| Manufacturer | String | The manufacturer or brand name associated with the item, providing context for the item's origin or producer. |
| ThumbnailImage | String | URL or path to a small image of the item, typically used for visual representation in a search result. |
| ItemSource | String | Source of the item, which could indicate whether the item is from an internal catalog, a supplier, or a punchout catalog. |
| FunctionalCurrencyCode | String | Code representing the functional currency used for accounting or financial purposes within the system. |
| FunctionalCurrencySymbol | String | Symbol of the functional currency, used for display purposes in the user interface (for example, $, €, £). |
| CatalogItemKey [KEY] | Long | Unique key used to reference the catalog item, linking it to specific catalog data in the system. |
| UnitOfMeasure | String | Unit of measurement for the item, indicating how the item is quantified (for example, each, box, kg). |
| FormattedUnitPrice | String | Formatted string representing the unit price, often used for display purposes, including the currency symbol. |
| FormattedCurrencyUnitPrice | String | Formatted string representing the unit price in a specified currency, ready for display with the appropriate currency symbol. |
| FormattedAmount | String | Formatted string representing the total amount, often used for display purposes with the appropriate currency symbol. |
| FormattedCurrencyAmount | String | Formatted string representing the total amount in a specified currency, ready for display with the appropriate currency symbol. |
| Finder | String | Search or query reference related to the ShoppingSearchesresultItems, potentially used for filtering or looking up past search results. |
| SearchPhraseId | Long | Unique identifier for the search phrase used to find the items in the result set, linking to the SearchPhraseId in the ShoppingSearches table. |
Lists punchout catalog links included in search results, letting users directly access supplier-hosted catalogs.
| Name | Type | Description |
| ShoppingSearchesSearchPhraseId [KEY] | Long | Unique identifier linking to the search phrase used in the ShoppingSearches table, allowing for specific filtering of punchout catalogs by search term. |
| CatalogId [KEY] | Long | Unique identifier for the punchout catalog, used to link the search result to a specific external catalog available through the punchout process. |
| CatalogName | String | The name of the punchout catalog, typically provided by an external supplier, representing a collection of items available for purchase. |
| ImageURL | String | URL pointing to an image that visually represents the punchout catalog, often used for display in search results or catalog listings. |
| PunchoutURL | String | URL to the punchout catalog, allowing users to be redirected to the external supplier’s catalog to view and select items. |
| Finder | String | Search or query reference related to the ShoppingSearchesresultPunchoutCatalogs, potentially used for filtering or looking up past search results and their corresponding punchout catalogs. |
| SearchPhraseId | Long | Unique identifier for the search phrase used to find the punchout catalog in the search results, linking it to the SearchPhraseId in the ShoppingSearches table. |
Queries the list of valid codes and meanings for standard lookups, ensuring consistent use of reference data.
| Name | Type | Description |
| LookupType [KEY] | String | The type of the lookup, categorizing the data and defining the group to which this lookup belongs (for example, status types, country codes). |
| LookupCode [KEY] | String | Unique identifier for the lookup value, used to reference a specific entry in the lookup table. |
| Meaning | String | The meaning or value description associated with the lookup code, providing context to what the code represents (for example, 'Active', 'Inactive'). |
| Description | String | A detailed description of the lookup value, often explaining the context or usage of the code in business processes. |
| Tag | String | A tag associated with the lookup value, often used for categorization or additional metadata that can help identify related values. |
| ActiveDate | Date | The date on which the lookup value becomes active, indicating when the lookup is valid for use in the system. |
| Bind_ParentLookupCode | String | The lookup code of the parent lookup value, used to establish a relationship between this value and a broader lookup hierarchy. |
| Bind_ParentSetidDetermType | String | Type of the parent set ID determination, which defines how the parent lookup is linked to the child lookup in the system. |
| Bind_ParentSetidDetermValue | String | The value associated with the parent set ID determination, providing the specific reference for the lookup hierarchy relationship. |
| Bind_RelationshipId | Long | Unique identifier for the relationship between this lookup value and its parent, used to link and organize related lookup codes. |
| BindActiveDate | Date | The date on which the binding relationship between the parent and child lookup values becomes active. |
| BindLookupCode | String | The lookup code of the parent or related lookup value that is bound to this particular lookup, establishing a link. |
| BindLookupType | String | The type of lookup the parent lookup belongs to, used for identifying the nature of the parent lookup in the relationship. |
| BindTag | String | A tag associated with the binding of lookup values, providing additional metadata or categorization for the relationship. |
| Finder | String | Search or query reference related to the StandardLookupsLOV, potentially used for filtering or looking up specific lookup values. |
| NewLookupCode1 | String | Additional lookup code, typically used for tracking or referencing new or updated values in the lookup hierarchy. |
| NewLookupCode2 | String | Additional lookup code, typically used for tracking or referencing new or updated values in the lookup hierarchy. |
| NewLookupCode3 | String | Additional lookup code, typically used for tracking or referencing new or updated values in the lookup hierarchy. |
| NewLookupCode4 | String | Additional lookup code, typically used for tracking or referencing new or updated values in the lookup hierarchy. |
| NewLookupCode5 | String | Additional lookup code, typically used for tracking or referencing new or updated values in the lookup hierarchy. |
Designates whether a supplier is allowed to participate in sourcing events, capturing approval statuses or disqualifications.
| Name | Type | Description |
| EligibilityId [KEY] | Long | Unique identifier for the supplier eligibility record, allowing for tracking and referencing specific eligibility entries. |
| SupplierId | Long | Unique identifier for the supplier participating in the sourcing eligibility process, linking the eligibility to a specific supplier. |
| SupplierName | String | The name of the supplier that is being evaluated for sourcing eligibility, providing context to the specific supplier involved. |
| BusinessUnitId | Long | Unique identifier for the procurement business unit associated with the supplier eligibility, indicating which organizational unit is responsible for the eligibility. |
| BusinessUnitName | String | The name of the procurement business unit that is responsible for the supplier's eligibility evaluation, providing context for the decision. |
| SourcingEligibilityCode | String | Code that indicates the status of the supplier’s sourcing eligibility. Valid values include ALLOWED, NOT_ALLOWED, and WARNING, representing the different eligibility outcomes. |
| SourcingEligibility | String | The status of sourcing eligibility at the supplier level, providing a high-level summary of whether the supplier is eligible, not eligible, or eligible with a warning for sourcing. |
| SourcingAssessmentId | Long | Unique identifier for the sourcing assessment related to the supplier, allowing for reference to the specific evaluation that influenced the eligibility decision. |
| SourcingAssessmentNumber | String | The number associated with the most recent sourcing assessment, used to identify the assessment on which the eligibility decision is based. |
| SourcingEligUpdateDate | Datetime | The date and time when the sourcing eligibility was last updated, helping to track when the eligibility status was modified. |
| SourcingEligUpdatedBy | Long | The login identifier of the user who made the most recent update to the supplier's sourcing eligibility, providing accountability for changes. |
| SourcingEligUpdatedByName | String | The name of the user who most recently updated the sourcing eligibility, providing clarity on who made the change. |
| SourcingComments | String | Comments related to the sourcing eligibility decision, often used to provide additional context or justification for the supplier's eligibility status. |
| Finder | String | Search or query reference related to the SupplierEligibilities, potentially used for filtering or looking up specific supplier eligibility records. |
Tracks the creation and status of supplier initiatives, which manage supplier assessments or qualification projects.
| Name | Type | Description |
| InitiativeId [KEY] | Long | Unique identifier for the initiative, used to reference and track specific initiatives within the system. |
| Initiative | String | The unique number assigned to the initiative, typically used for identification and reference within sourcing and procurement processes. |
| Title | String | Title of the initiative as entered by the user, providing a brief summary or label for the initiative. |
| Description | String | Detailed description of the initiative, entered by the user, explaining the initiative’s purpose, scope, and objectives. |
| StatusCode | String | Abbreviation representing the current status of the initiative. Valid values include those defined in the lookup type POQ_INITIATIVE_STATUS (for example, ACTIVE, INACTIVE, COMPLETED). |
| Status | String | Current status of the initiative, providing a high-level summary of its state (for example, 'Active', 'Completed', 'Cancelled'). |
| InitiativeTypeCode | String | Code that identifies the type of initiative (for example, 'New', 'Renewal', 'Assessment'), with values defined in the lookup type POQ_INITIATIVE_TYPE. |
| InitiativeType | String | The type of initiative, indicating whether it’s a new initiative, a renewal, or a different kind of activity. |
| ProcurementBUId | Long | Unique identifier for the procurement business unit associated with the initiative, linking the initiative to a specific organizational unit. |
| ProcurementBU | String | The name of the procurement business unit responsible for the initiative, providing context for the unit handling the initiative. |
| InitiativeOwnerId | Long | Unique identifier for the person or entity responsible for the initiative, linking the initiative to the owner. |
| InitiativeOwner | String | The name of the individual or entity that owns and is accountable for the initiative. |
| InternalNote | String | Internal notes for the initiative, entered by the user, providing additional context, comments, or instructions regarding the initiative. |
| QualificationModelId | Long | Unique identifier for the qualification model associated with the assessment initiative, linking it to a specific qualification model. |
| QualificationModel | String | The name of the qualification model used for the assessment, providing context on the criteria and framework for evaluating the initiative. |
| QualificationModelStatusCode | String | Code representing the current status of the qualification model, reflecting whether the model is active, inactive, or in another state. |
| QualificationModelStatus | String | Descriptive status of the qualification model, indicating its current state (for example, 'Active', 'Inactive', 'Under Review'). |
| QualificationModelRevision | Int | Revision number of the qualification model, indicating the version of the model in use for the initiative. |
| AssessmentOwnerId | Long | Unique identifier for the individual responsible for the assessment, linking the assessment to a specific owner. |
| AssessmentOwner | String | The name of the person who owns and oversees the assessment process for the initiative. |
| AssessmentEvaluationDueDate | Date | The date by which the assessment for the initiative is due to be evaluated, establishing a deadline for the evaluation process. |
| ReuseActiveQualificationFlag | Bool | Flag indicating whether existing active qualifications can be reused for the assessment initiative. If true, valid reusable qualifications will be applied; if false, new qualifications will be created. |
| LaunchDate | Datetime | The date and time when the initiative was officially launched, marking the start of the initiative. |
| InitiativeCompletionDate | Datetime | The date and time when the initiative was completed, marking the end of the initiative. |
| InitiativeCancellationDate | Datetime | The date and time when the initiative was canceled, if applicable, marking the cessation of the initiative. |
| CanceledById | Long | Unique identifier for the user who canceled the initiative, providing accountability for the cancellation. |
| CanceledBy | String | The name of the user who canceled the initiative, providing visibility into who made the decision to cancel. |
| CanceledReason | String | The reason for the cancellation of the initiative, entered by the user, providing context for why the initiative was stopped. |
| CreationDate | Datetime | The date and time when the initiative was created, tracking the creation of the initiative in the system. |
| CreationSourceCode | String | Code identifying the source from which the initiative was created (for example, 'Internal', 'External'), defined in the lookup type ORA_POQ_CREATION_SOURCE. |
| CreationSource | String | Descriptive source for the creation of the initiative, indicating whether it originated internally or externally. |
| AutoAcceptResponsesFlag | Bool | Flag indicating whether questionnaire responses should be automatically accepted. If true, responses are automatically accepted; if false, manual approval is required. |
| AutoPopulateResponsesFlag | Bool | Flag indicating whether responses from the response repository should be auto-filled in the questionnaire. If true, responses will be populated automatically; if false, they will need to be manually entered. |
| LastOverdueReminderDate | Datetime | The date and time when the last overdue reminder notification was sent for an internal response that was overdue. |
| LastOverdueRmndrDateSup | Datetime | The date and time when the last overdue reminder notification was sent for an external response that was overdue. |
| InitiativeSurveyFlag | Bool | Flag indicating whether the initiative is a survey type. If true, the initiative allows multiple internal responders; if false, it allows only a single responder. |
| Finder | String | Search or query reference related to the SupplierInitiatives, potentially used for filtering or looking up past initiatives. |
Manages files related to a supplier initiative, such as supporting documents or evidence of compliance.
| Name | Type | Description |
| SupplierInitiativesInitiativeId [KEY] | Long | Unique identifier for the initiative to which the attachment belongs, linking the attachment to a specific supplier initiative. |
| AttachedDocumentId [KEY] | Long | Unique identifier for the attached document, used to reference the specific document associated with the initiative. |
| LastUpdateDate | Datetime | The date and time when the attachment was last updated, tracking the most recent modification to the document. |
| LastUpdatedBy | String | The name or identifier of the user who most recently updated the attachment, providing accountability for changes made. |
| DatatypeCode | String | Code representing the data type of the attached document (for example, 'PDF' or 'Word'), helping to categorize the file type. |
| FileName | String | The name of the attached file, which identifies the document for reference within the system. |
| DmFolderPath | String | Path to the folder in the document management system where the attached file is stored, used for locating the file within the system. |
| DmDocumentId | String | Unique identifier for the document in the document management system, allowing for precise tracking and management of the document. |
| DmVersionNumber | String | Version number of the document in the document management system, used to differentiate between versions of the same document. |
| Url | String | The URL link to the attachment, providing direct access to the file or document. |
| CategoryName | String | The category or classification assigned to the attachment, used to group similar attachments together based on type or purpose. |
| UserName | String | The name or identifier of the user who uploaded or is associated with the attachment, providing visibility into the uploader. |
| Uri | String | Uniform Resource Identifier (URI) that links to the attachment, providing a consistent way to reference the document in the system. |
| FileUrl | String | The URL for downloading the attachment, offering direct access to the file for users. |
| UploadedText | String | Text or notes that may have been entered during the upload of the attachment, often used to describe the document or its contents. |
| UploadedFileContentType | String | The content type of the uploaded file, indicating its format. |
| UploadedFileLength | Long | The size of the uploaded file in bytes, giving an indication of the document's size. |
| UploadedFileName | String | The original name of the file when it was uploaded, used for reference and storage within the system. |
| ContentRepositoryFileShared | Bool | Flag indicating whether the file in the content repository is shared with others. If true, the file is shared; if false, it is not. |
| Title | String | The title of the attached document, often used to summarize or label the content of the file. |
| Description | String | Detailed description of the attached document, providing additional context and information about the file's purpose or contents. |
| ErrorStatusCode | String | Code indicating the error status of the attachment process, helping to track if an error occurred during the upload or processing. |
| ErrorStatusMessage | String | Message explaining the error that occurred during the attachment process, providing insights into any issues encountered. |
| CreatedBy | String | The name or identifier of the user who created the attachment record, indicating the origin of the attachment. |
| CreationDate | Datetime | The date and time when the attachment was originally created, providing a timestamp for when the document was added to the system. |
| FileContents | String | Contents of the file, typically used for text-based documents, representing the raw content stored within the file. |
| ExpirationDate | Datetime | The expiration date of the attachment, if applicable, indicating when the document will no longer be valid or accessible. |
| LastUpdatedByUserName | String | The username of the individual who last updated the attachment, providing clarity on who made the most recent changes. |
| CreatedByUserName | String | The username of the individual who initially created the attachment, providing visibility into the attachment’s origin. |
| AsyncTrackerId | String | Identifier used to track asynchronous processing related to the attachment, helping manage file processing tasks. |
| FileWebImage | String | URL or path to an image representing the file in web interfaces, often used for visual reference or previews of the attachment. |
| DownloadInfo | String | Information related to downloading the attachment, such as download instructions or available formats. |
| PostProcessingAction | String | Action that is performed on the attachment after it has been uploaded, such as validation, encryption, or categorization. |
| Finder | String | Search or query reference related to the SupplierInitiativesattachments, used for filtering or looking up specific attachment records. |
| InitiativeId | Long | Unique identifier for the initiative associated with the attachment, linking the attachment to a specific initiative within the supplier sourcing process. |
Provides descriptive flexfields for supplier initiatives, capturing additional contextual or compliance-related data.
| Name | Type | Description |
| SupplierInitiativesInitiativeId [KEY] | Long | Unique identifier for the supplier initiative within the SupplierInitiativesDFF table, linking the flexfield data to a specific initiative. |
| InitiativeId [KEY] | Long | Unique identifier for the initiative, used to reference and track the specific initiative across the system. |
| _FLEX_Context | String | Descriptive context name for the flexfield associated with the initiative, used to categorize or define the data being captured in the flexfield. |
| _FLEX_Context_DisplayValue | String | Display value associated with the flexfield context, providing a user-friendly label or description for the context in which the flexfield is being used. |
| Finder | String | Search or query reference related to the SupplierInitiativesDFF, potentially used for filtering or looking up specific flexfield data tied to initiatives. |
Lists members of the evaluation team assigned to a supplier initiative, detailing their roles and responsibilities in the review process.
| Name | Type | Description |
| SupplierInitiativesInitiativeId [KEY] | Long | Unique identifier for the supplier initiative, linking the evaluation team member data to a specific initiative. |
| EvaluationTeamMemberId [KEY] | Long | Unique identifier for the evaluation team member, used to track and reference the specific member within the evaluation process. |
| TeamMemberId | Long | Unique identifier for the individual team member, linking them to the broader evaluation team for the initiative. |
| TeamMember | String | Name of the evaluation team member, providing the identity of the person involved in the assessment or evaluation. |
| EvaluationTeamMemberJob | String | The job title or role of the evaluation team member, indicating their responsibilities or function within the evaluation team. |
| AddedByCode | String | Abbreviation indicating whether the evaluation team member was manually added by a user or defaulted by the system. Valid values are 'DEFAULT' and 'USER'. |
| Finder | String | Search or query reference related to the SupplierInitiativesevaluationTeamMembers, used for filtering or looking up specific team member records associated with the initiative. |
| InitiativeId | Long | Unique identifier for the initiative to which the evaluation team member is associated, linking the team member to the correct initiative in the system. |
Identifies the qualification areas within an initiative, specifying the criteria against which suppliers are assessed.
| Name | Type | Description |
| SupplierInitiativesInitiativeId [KEY] | Long | Unique identifier for the supplier initiative, linking the qualification area data to a specific initiative. |
| InitiativeQualificationAreaId [KEY] | Long | Unique identifier for the qualification area associated with the initiative, allowing for precise tracking and reference of qualification areas. |
| SyncCheckFlag | Bool | Flag indicating whether the acceptable response to a supplier attribute question has been synchronized with the supplier profile. If true, synchronization has passed; if false, it has failed. This flag ensures that the qualification area data is consistent with the supplier profile. |
| QualificationAreaId | Long | Unique identifier for the qualification area, used to reference and track the specific qualification criteria within the system. |
| QualificationArea | String | Name of the qualification area, representing the specific category or subject of assessment for the initiative. |
| OwnerId | Long | Unique identifier for the owner of the qualification area, linking the qualification area to the responsible individual or entity. |
| Owner | String | The name of the individual or entity responsible for overseeing and managing the qualification area. |
| OriginalQualificationAreaId | Long | Unique identifier for the original qualification area, used to reference the initial qualification area before any modifications or updates. |
| EvaluationDueDate | Date | The date by which the qualification area assessment is due for evaluation, establishing a deadline for completing the qualification process. |
| QualificationAreaDescription | String | Detailed description of the qualification area, providing additional context about the criteria and requirements for the area. |
| QualificationAreaRevision | Int | Revision number of the qualification area, indicating the version or iteration of the qualification criteria. |
| QualificationAreaStatusCode | String | Code representing the current status of the qualification area (for example, 'Active', 'Completed'), reflecting its state in the evaluation process. |
| QualificationAreaStatus | String | Descriptive status of the qualification area, indicating whether it is currently active, completed, or in another state. |
| DisplaySequence | Int | The sequence in which the qualification area appears in the qualification initiative, helping to organize the order of assessment or display. |
| Finder | String | Search or query reference related to the SupplierInitiativesqualificationAreas, used for filtering or looking up specific qualification area records associated with the initiative. |
| InitiativeId | Long | Unique identifier for the initiative to which the qualification area is linked, ensuring that the qualification area is associated with the correct initiative. |
Tracks the suppliers participating in an initiative, providing status updates and scoring information for qualification or selection.
| Name | Type | Description |
| SupplierInitiativesInitiativeId [KEY] | Long | Unique identifier for the supplier initiative, linking the supplier data to a specific initiative in the system. |
| InitiativeSupplierId [KEY] | Long | Unique identifier for the supplier associated with the initiative, helping to track and reference the specific supplier involved in the initiative. |
| SupplierId | Long | Unique identifier for the supplier, used to track and reference the supplier across various initiatives and sourcing activities. |
| Supplier | String | The name of the supplier, providing the identity of the company or vendor involved in the initiative. |
| SupplierSiteId | Long | Unique identifier for the specific supplier site, linking the supplier’s location to the initiative, which could represent a physical or organizational site. |
| SupplierSite | String | The name of the supplier site, identifying the location or organizational unit of the supplier participating in the initiative. |
| SupplierContactId | Long | Unique identifier for the supplier contact, linking the supplier’s designated contact person to the initiative. |
| SupplierContact | String | The name of the supplier contact, providing the point of communication for the supplier in the context of the initiative. |
| SupplierNumber | String | The number assigned to the supplier for identification purposes, often used for internal tracking and reference. |
| InternalResponderId | Long | Unique identifier for the internal responder, linking the person responsible for internal responses to the initiative. |
| InternalResponder | String | The name of the internal responder, providing the identity of the person who will respond to internal questions or assessments for the initiative. |
| SendSupplierQuestionnaireFlag | Bool | Flag indicating whether a questionnaire should be sent to the supplier contact. If true, the questionnaire is sent; if false, it is not. The default is true if required questions are missing in the response repository. |
| SendInternalQuestionnaireFlag | Bool | Flag indicating whether a questionnaire should be sent to the internal responder. If true, the questionnaire is sent; if false, it is not. The default is true if required questions are missing in the response repository. |
| ResponsePulledFlag | Bool | Flag indicating whether the supplier’s response has been pulled as part of the initiative. If true, data has been pulled from the supplier’s profile into the repository; if false, data has not been pulled. |
| Finder | String | Search or query reference related to the SupplierInitiativessuppliers, used for filtering or looking up specific supplier records in relation to the initiative. |
| InitiativeId | Long | Unique identifier for the initiative to which the supplier is linked, associating the supplier with the appropriate initiative. |
Retrieves supplier-submitted responses to sourcing negotiations (for example, RFI, RFQ), offering visibility into proposed terms and pricing.
| Name | Type | Description |
| ResponseNumber [KEY] | Long | Unique identifier for the response within the supplier negotiation process, used to reference and track specific responses. |
| AuctionHeaderId | Long | Unique identifier for the auction header, linking the response to a specific auction event in the negotiation process. |
| NegotiationTitle | String | The title of the negotiation, providing a summary or label for the negotiation process that the response is part of. |
| Negotiation | String | Detailed name or description of the negotiation, offering further context for the specific negotiation process. |
| CloseDate | Datetime | The date and time when the negotiation is scheduled to close, marking the deadline for submitting responses. |
| AwardCompleteDate | Datetime | The date and time when the award process for the negotiation is completed, finalizing the decision based on responses. |
| PurchasingDocument | String | The document associated with the purchasing process, often representing the contract or order that is being negotiated. |
| ResponseStatus | String | The current status of the response, indicating whether it is active, withdrawn, under review, or in another state. |
| OverallRank | String | The overall ranking of the supplier’s response in the negotiation, showing how the response compares to others. |
| OverallRankComposite | String | Composite ranking of the response, combining various evaluation metrics into a single overall ranking. |
| ShortlistStatus | String | The status of the supplier in relation to being shortlisted, indicating whether the supplier has been selected for further consideration. |
| ResponseAmount | String | The total amount stated in the supplier’s response, often representing the price or offer submitted by the supplier. |
| TotalAgreementAmount | Long | The total amount of the agreement or contract, representing the full financial commitment of the negotiation. |
| TotalAwardAmount | Long | The total award amount, indicating the final financial figure awarded based on the negotiation response. |
| SavingsInAmount | Decimal | The amount of savings generated as a result of the negotiation response, showing cost reductions compared to prior estimates. |
| SavingsInPercent | String | Percentage of savings achieved based on the negotiation response, representing the cost savings relative to the baseline amount. |
| AwardStatus | String | The current status of the award process, indicating whether the award has been completed, pending, or canceled. |
| RequirementScore | Decimal | The score assigned based on how well the supplier’s response meets the required criteria for the negotiation. |
| CompositeScore | String | The composite score combining multiple evaluation factors, providing an overall measure of the response’s performance. |
| OverriddenScore | Decimal | The score that has been manually adjusted or overridden by the evaluator, reflecting changes made to the initial score. |
| ScoringStatus | String | The current status of the scoring process, indicating whether scoring has been completed, is in progress, or is pending. |
| ScoreOverriddenFlag | Bool | Flag indicating whether the score has been overridden. If true, the score was manually adjusted; if false, it remains as initially calculated. |
| ScoreOverriddenBy | String | The name of the person who overrode the score, providing accountability for score changes. |
| ScoreOverridePersonId | Long | Unique identifier for the person who performed the score override, linking the adjustment to a specific individual. |
| ScoreOverrideReason | String | Explanation for why the score was overridden, offering context for the decision to change the original score. |
| ScoreOverriddenDate | Datetime | The date and time when the score was overridden, providing a timestamp for when the change was made. |
| ResponseType | String | Type of response submitted by the supplier, indicating whether it is a bid, offer, or another form of response. |
| ResponseTypeCode | String | Code that categorizes the response type, providing a standardized identifier for the type of response. |
| MethodOfResponse | String | Method by which the supplier submitted their response, such as electronically, via email, or in person. |
| MethodOfResponseCode | String | Code representing the method of response, used for standardized tracking of how responses are submitted. |
| DisqualificationReason | String | Reason why the supplier’s response was disqualified, providing transparency on the decision to reject the response. |
| EvaluationStage | String | Stage of the evaluation process that the response is currently in, such as initial review, scoring, or final selection. |
| PrebidFlag | Bool | Flag indicating whether the response was submitted prior to the official start of the bidding process. If true, it is a prebid response. |
| Buyer | String | The name of the buyer or procurement officer responsible for the negotiation, providing clarity on the individual overseeing the process. |
| PreviousResponseNumber | Long | The response number for the supplier’s previous submission, allowing comparison between responses across different rounds. |
| OriginalResponseNumber | Long | The original response number assigned to the first submission from the supplier, used to track initial responses. |
| NegotiationCurrency | String | The currency used in the negotiation, indicating the financial system for all amounts related to the negotiation. |
| NegotiationCurrencyCode | String | Code representing the currency used in the negotiation, following standard currency codes such as USD or EUR. |
| NoteToBuyer | String | Additional notes provided to the buyer, often used for clarification or extra information relevant to the response. |
| PriceDecrement | Decimal | The amount by which the supplier has reduced their price in subsequent rounds of the negotiation, showing price adjustments. |
| ResponseCurrency | String | Currency in which the supplier has provided their response, which may differ from the negotiation currency. |
| ResponseCurrencyCode | String | Code representing the currency used by the supplier in their response, such as USD or EUR. |
| ResponseCurrencyPricePrecision | Decimal | Precision used for pricing in the response currency, specifying the number of decimal places for price calculations. |
| CurrencyConversionRate | Decimal | The rate used to convert between the response currency and the negotiation currency, helping to reconcile different currencies. |
| ResponseValidUntilDate | Datetime | The date until which the supplier’s response remains valid, marking the expiry of the offer or bid. |
| Supplier | String | The name of the supplier submitting the response, identifying the company or entity involved in the negotiation. |
| SupplierId | Long | Unique identifier for the supplier, used to track and reference the supplier across various negotiation processes. |
| SupplierContact | String | The contact person at the supplier’s organization, providing a point of communication for the negotiation. |
| SupplierContactId | Long | Unique identifier for the supplier contact, linking the individual to their role in the negotiation. |
| SupplierSite | String | The specific supplier site associated with the response, identifying the location or branch handling the negotiation. |
| SupplierSiteId | Long | Unique identifier for the supplier site, linking the location to the supplier and their response. |
| SurrogateResponseEnteredById | Long | Unique identifier for the person who entered the surrogate response, used for tracking who submitted the response on behalf of the supplier. |
| SurrogateResponseEnteredBy | String | The name of the person who entered the surrogate response, providing clarity on the individual responsible. |
| SurrogateResponseFlag | Bool | Flag indicating whether the response is a surrogate response entered on behalf of the supplier. If true, it was entered by someone other than the supplier. |
| SurrogateResponseCreationDate | Datetime | The date and time when the surrogate response was created, marking when the surrogate submission occurred. |
| SurrogateResponseReceivedOn | Datetime | The date and time when the surrogate response was received, helping to track the timing of the submission. |
| ReferenceNumber | String | A reference number associated with the response, used for tracking and external referencing of the submission. |
| ProxyBidFlag | Bool | Flag indicating whether the response is a proxy bid, where a third party is acting on behalf of the supplier. |
| PartialResponseFlag | Bool | Flag indicating whether the response is partial, meaning it does not cover the full scope or requirements of the negotiation. |
| CreatedBy | String | The name of the individual who created the negotiation response record, providing accountability for the data entry. |
| CreationDate | Datetime | The date and time when the response record was created, providing a timestamp for when the response was initially entered. |
| TwoStageEvaluationFlag | Bool | Flag indicating whether the response is part of a two-stage evaluation process. If true, the evaluation will be conducted in two distinct stages. |
| TechnicalShortlistFlag | Bool | Flag indicating whether the response is part of the technical shortlist, indicating that the supplier meets the technical requirements. |
| ShortlistFlag | Bool | Flag indicating whether the supplier has been shortlisted for further consideration based on their response. |
| ShortlistStatusUpdatedBy | String | The name of the person who last updated the shortlist status, providing accountability for changes to the shortlist. |
| ShortlistStatusUpdatedById | Long | Unique identifier for the person who last updated the shortlist status, linking the update to a specific individual. |
| Finder | String | Search or query reference related to the SupplierNegotiationResponses, used for filtering or looking up specific response records in the negotiation process. |
Manages files (for example, statements of work, supporting documents) attached to negotiation responses, ensuring comprehensive bid details.
| Name | Type | Description |
| SupplierNegotiationResponsesResponseNumber [KEY] | Long | Unique identifier for the response within the supplier negotiation, linking the attachment to a specific response in the negotiation process. |
| AttachedDocumentId [KEY] | Long | Unique identifier for the attached document, used to track and reference the specific document associated with the response. |
| LastUpdateDate | Datetime | The date and time when the attached document was last updated, providing a timestamp for the most recent modification to the attachment. |
| LastUpdatedBy | String | The name or identifier of the person who last updated the attached document, ensuring accountability for changes made. |
| DatatypeCode | String | Code representing the data type of the attached document, such as 'PDF' or 'Word', helping to classify the file. |
| FileName | String | The name of the attached file, identifying the document for reference in the system. |
| DmFolderPath | String | Path to the folder in the document management system where the attached document is stored, aiding in locating the file. |
| DmDocumentId | String | Unique identifier for the document in the document management system, allowing precise tracking and retrieval. |
| DmVersionNumber | String | Version number of the attached document in the document management system, used to distinguish between different iterations of the same file. |
| Url | String | The URL pointing directly to the attachment, providing access to the document for users. |
| CategoryName | String | The category or classification assigned to the attachment, helping to group related documents together within the system. |
| UserName | String | The name or identifier of the user associated with the attachment, providing context for who uploaded or is managing the document. |
| Uri | String | Uniform Resource Identifier (URI) linking to the attachment, offering a consistent reference for the document within the system. |
| FileUrl | String | URL for downloading the attached file, offering a direct link for users to access the document. |
| UploadedText | String | Text or notes entered during the upload of the attachment, often used for describing the file or providing additional context. |
| UploadedFileContentType | String | The content type of the uploaded file, indicating its format. |
| UploadedFileLength | Long | The size of the uploaded file in bytes, providing an indication of the document’s size. |
| UploadedFileName | String | The original name of the file when it was uploaded, often retained for reference or organization. |
| ContentRepositoryFileShared | Bool | Flag indicating whether the file in the content repository is shared with other users. If true, the file is shared; if false, it is private. |
| Title | String | The title of the attached document, summarizing the content or purpose of the file. |
| Description | String | Detailed description of the attached document, explaining its relevance, contents, or other important information. |
| ErrorStatusCode | String | Code representing the error status of the document attachment process, helping to identify issues during upload or processing. |
| ErrorStatusMessage | String | Message explaining the error that occurred during the attachment process, providing details about what went wrong. |
| CreatedBy | String | The name or identifier of the person who created the attachment record, ensuring visibility into who entered the data. |
| CreationDate | Datetime | The date and time when the attachment record was created, providing a timestamp for when the document was added to the system. |
| FileContents | String | The contents of the file, typically for text-based documents, representing the raw text within the attachment. |
| ExpirationDate | Datetime | The expiration date of the attachment, marking when the document will no longer be valid or accessible. |
| LastUpdatedByUserName | String | The username of the individual who most recently updated the attachment, providing clarity on who made the last modification. |
| CreatedByUserName | String | The username of the individual who initially created the attachment, providing insight into the origin of the document. |
| AsyncTrackerId | String | Identifier used to track asynchronous processing related to the attachment, such as file conversion or upload tasks. |
| FileWebImage | String | URL or path to an image representing the file in web interfaces, often used as a visual preview of the document. |
| DownloadInfo | String | Information related to downloading the attachment, such as format, size, or instructions for accessing the document. |
| PostProcessingAction | String | Action that is performed after the attachment is uploaded, such as validation, encryption, or categorization. |
| Finder | String | Search or query reference related to the SupplierNegotiationResponsesattachments, used for filtering or looking up specific attachment records in the system. |
| ResponseNumber | Long | Unique identifier for the response within the supplier negotiation, linking the attachment to a specific response in the negotiation process. |
Displays line-level details, such as pricing or lead times, in a supplier’s negotiation response for each item or service.
| Name | Type | Description |
| SupplierNegotiationResponsesResponseNumber [KEY] | Long | Unique identifier for the response within the supplier negotiation, linking the response line to a specific response in the negotiation process. |
| ResponseNumber [KEY] | Long | Unique identifier for the response, used to track and reference a specific supplier's offer or bid in the negotiation process. |
| AuctionHeaderId | Long | Unique identifier for the auction header, linking the response line to a specific auction event that is part of the negotiation. |
| LineId [KEY] | Long | Unique identifier for the line item within the response, used to reference specific items within the negotiation response. |
| Line | String | The description or label for the line item, providing identification for each specific offer or item in the supplier’s response. |
| LineTypeId | Long | Unique identifier for the line type, categorizing the line item (for example, product, service) in the context of the negotiation. |
| LineType | String | The type of line item (for example, 'Product', 'Service'), helping to categorize the nature of the item being negotiated. |
| GroupTypeCode | String | Code representing the group to which the line item belongs, used for categorizing and grouping similar items in the negotiation process. |
| GroupType | String | Description of the group type, offering further clarification on the grouping of line items in the negotiation. |
| ItemId | Long | Unique identifier for the item associated with the line, linking the line item to a specific product or service in the catalog. |
| Item | String | The name or description of the item associated with the response line, providing context for the specific product or service being offered. |
| ItemRevision | String | The revision number of the item, indicating the version of the product or service being offered in the negotiation. |
| LineDescription | String | Detailed description of the line item, providing additional context or specifications related to the item or service being negotiated. |
| AlternateLineNumber | Decimal | Alternative line number for the item, used for reference if there are multiple versions or variations of the line item. |
| AlternateLineDescription | String | Alternative description for the line item, used if there are alternative versions or variations of the item offered. |
| CategoryId | Long | Unique identifier for the category of the line item, helping to group the item into broader product or service categories. |
| CategoryName | String | The name of the category to which the line item belongs, providing a classification for grouping items in the negotiation. |
| StartPrice | Decimal | The starting price for the line item, often representing the initial offer or starting point for negotiation. |
| TargetPrice | Decimal | The target price for the line item, representing the price at which the supplier hopes to reach an agreement. |
| Score | Decimal | The score assigned to the line item based on evaluation criteria, showing how well the item meets the requirements of the negotiation. |
| Rank | String | The rank of the line item relative to other offers in the negotiation, providing an indication of how it compares in terms of price or other evaluation criteria. |
| ResponsePrice | Decimal | The price offered for the line item by the supplier, representing their bid or offer for the item in the negotiation. |
| ProxyDecrement | Decimal | The amount by which the price is reduced in subsequent rounds of negotiation, indicating price adjustments made by the supplier. |
| ProxyMinimum | Decimal | The minimum price limit for the line item that the supplier is willing to accept, establishing a lower threshold for negotiation. |
| TargetQuantity | Decimal | The quantity of the item that the supplier aims to offer in the negotiation, often linked to the target order size or quantity. |
| ResponseQuantity | Decimal | The quantity of the item offered by the supplier in their response, indicating how much of the item they are bidding for. |
| PartialQuantityFlag | Bool | Flag indicating whether the response includes partial quantities. If true, the supplier is offering less than the full quantity requested. |
| ResponseEstimatedQuantity | Decimal | The estimated quantity for the item as provided by the supplier, giving a forecasted amount they intend to offer. |
| UOMCode | String | Code representing the unit of measure for the line item (for example, 'EA' for each, 'KG' for kilograms), helping to standardize measurement units. |
| UOM | String | The unit of measure for the line item, indicating how the item is quantified (for example, each, kilogram, box). |
| LineCloseDate | Datetime | The date and time when the line item is scheduled to close, marking the deadline for finalizing negotiations related to the item. |
| LineTargetPrice | Decimal | The target price for the line item, representing the price the supplier aims to achieve for the specific item. |
| LinePrice | Decimal | The price of the line item, typically representing the final agreed price or the supplier’s proposed price for the item. |
| LineAmount | Decimal | The total amount for the line item, calculated by multiplying the line price by the quantity offered. |
| PricingBasisCode | String | Code representing the pricing basis for the line item, such as unit price, total price, or other pricing models. |
| PricingBasis | String | The basis for pricing the line item, describing how the price is calculated (for example, per unit, per service). |
| TargetMinimumReleaseAmount | Decimal | The minimum amount the supplier is willing to accept for releasing the line item, used to define lower price thresholds. |
| ResponseMinimumReleaseAmount | Decimal | The minimum release amount proposed by the supplier for the line item, setting a lower bound for their response. |
| EstimatedTotalAmount | Decimal | The estimated total amount for the entire line item based on the response price and quantity. |
| ActiveResponses | Decimal | Number of active responses for the line item, indicating how many suppliers have submitted responses for that item. |
| AgreementQuantity | Decimal | The quantity of the item agreed upon, based on the negotiation outcome, representing the final quantity to be ordered. |
| AwardQuantity | Decimal | The quantity of the line item awarded to the supplier, reflecting the agreed-upon order quantity after the negotiation. |
| AwardStatus | String | Status of the award for the line item, indicating whether the award has been made, pending, or canceled. |
| AwardReason | String | Reason for awarding the line item to the supplier, providing justification for the decision based on evaluation criteria. |
| ShipToLocationId | Long | Unique identifier for the ship-to location for the line item, linking the item to a specific delivery address or location. |
| ShipToLocation | String | The name of the location where the line item is to be shipped, providing the shipping address for the item. |
| RequestedDeliveryDate | Date | The date requested by the supplier for delivering the line item, representing the supplier’s proposed delivery timeline. |
| RequestedShipDate | Date | The date requested by the supplier for shipping the line item, representing their proposed shipping schedule. |
| PromisedDeliveryDate | Date | The date promised by the supplier for delivering the line item, representing the supplier's commitment. |
| PromisedShipDate | Date | The date promised by the supplier for shipping the line item, confirming their shipping commitment. |
| NoteToBuyer | String | Additional notes from the supplier to the buyer regarding the line item, providing further context or instructions. |
| NoteToSuppliers | String | Notes from the buyer to the suppliers, offering additional instructions or clarifications for the line item. |
| PriceBreakTypeCode | String | Code representing the price break type for the line item, indicating if there are quantity-based price breaks or other pricing structures. |
| PriceBreakType | String | Description of the price break type, explaining the basis for any discounts or adjustments based on quantity or other factors. |
| CreatedBy | String | The name or identifier of the user who created the response line, providing accountability for data entry. |
| CreationDate | Datetime | The date and time when the response line was created, marking when the line item was added to the negotiation. |
| LastUpdatedBy | String | The name or identifier of the user who last updated the response line, ensuring accountability for changes made. |
| LastUpdateDate | Datetime | The date and time when the response line was last updated, providing a timestamp for the most recent change. |
| Finder | String | Search or query reference related to the SupplierNegotiationResponseslines, used for filtering or looking up specific line item records in the negotiation process. |
Holds documents specifically tied to each negotiation response line, such as product specifications or compliance certificates.
| Name | Type | Description |
| SupplierNegotiationResponsesResponseNumber [KEY] | Long | Unique identifier for the response within the supplier negotiation, linking the attachment to a specific response in the negotiation process. |
| LinesLineId [KEY] | Long | Unique identifier for the line item associated with the response, linking the attachment to a specific line within the negotiation. |
| LinesResponseNumber [KEY] | Long | Unique identifier for the line item response, used to track and reference the supplier’s offer or bid for a particular line item. |
| AttachedDocumentId [KEY] | Long | Unique identifier for the attached document, used to track and manage the specific document linked to the response line. |
| LastUpdateDate | Datetime | The date and time when the attached document was last updated, providing a timestamp for the most recent modification to the document. |
| LastUpdatedBy | String | The name or identifier of the person who last updated the attachment, ensuring accountability for any changes made. |
| DatatypeCode | String | Code representing the data type of the attached document (for example, 'PDF' or 'Word'), used to classify the file type. |
| FileName | String | The name of the attached file, providing a reference for the document within the system. |
| DmFolderPath | String | Path to the folder in the document management system where the attached file is stored, assisting with locating the document in the system. |
| DmDocumentId | String | Unique identifier for the document in the document management system, enabling precise tracking and retrieval of the document. |
| DmVersionNumber | String | The version number of the attached document, used to distinguish between different iterations or versions of the same file. |
| Url | String | The URL pointing directly to the attachment, providing access to the document for users. |
| CategoryName | String | The category or classification of the attachment, helping to group and organize similar attachments for easy reference. |
| UserName | String | The name or identifier of the user associated with the attachment, indicating who uploaded or is responsible for the document. |
| Uri | String | Uniform Resource Identifier (URI) linking to the attachment, providing a consistent way to reference the document within the system. |
| FileUrl | String | URL for downloading the attachment, offering a direct link for users to access and retrieve the document. |
| UploadedText | String | Text entered during the upload of the attachment, typically used for describing the document or adding additional context to the file. |
| UploadedFileContentType | String | The content type of the uploaded file, indicating its format. |
| UploadedFileLength | Long | The size of the uploaded file in bytes, indicating the file’s size and assisting with storage management. |
| UploadedFileName | String | The original name of the file when it was uploaded, often retained for organizational or reference purposes. |
| ContentRepositoryFileShared | Bool | Flag indicating whether the file in the content repository is shared with others. If true, the file is shared; if false, it is not. |
| Title | String | The title of the attached document, summarizing the content or purpose of the file. |
| Description | String | Detailed description of the attached document, explaining its contents, relevance, or context within the negotiation. |
| ErrorStatusCode | String | Code representing the error status during the document attachment process, used to identify specific issues or failures that occurred. |
| ErrorStatusMessage | String | Message explaining the error that occurred during the document attachment process, providing insights into what went wrong. |
| CreatedBy | String | The name or identifier of the user who created the attachment record, providing accountability for the data entry. |
| CreationDate | Datetime | The date and time when the attachment record was created, offering a timestamp for when the document was initially added to the system. |
| FileContents | String | The contents of the file, typically for text-based documents, representing the raw text stored within the attachment. |
| ExpirationDate | Datetime | The expiration date of the attachment, specifying when the document will no longer be valid or accessible within the system. |
| LastUpdatedByUserName | String | The username of the individual who last updated the attachment, providing visibility into who made the most recent change. |
| CreatedByUserName | String | The username of the individual who initially created the attachment, offering insight into the origin of the document. |
| AsyncTrackerId | String | Identifier used to track asynchronous processing related to the attachment, such as file conversion or processing tasks. |
| FileWebImage | String | URL or path to an image representing the file in web interfaces, providing a visual preview of the document. |
| DownloadInfo | String | Information related to downloading the attachment, such as format, size, or instructions for accessing the document. |
| PostProcessingAction | String | Action performed on the attachment after upload, such as validation, categorization, or encryption. |
| Finder | String | Search or query reference related to the SupplierNegotiationResponseslinesattachments, used for filtering or looking up specific attachment records within the system. |
| ResponseNumber | Long | Unique identifier for the response within the supplier negotiation, linking the attachment to a specific response in the negotiation process. |
Captures additional line-level cost factors (shipping, setup fees) entered by suppliers, contributing to the final bid amount.
| Name | Type | Description |
| SupplierNegotiationResponsesResponseNumber [KEY] | Long | Unique identifier for the response within the supplier negotiation, linking the cost factor data to a specific response in the negotiation process. |
| LinesLineId [KEY] | Long | Unique identifier for the line item associated with the response, linking the cost factor to a specific line in the negotiation. |
| LinesResponseNumber [KEY] | Long | Unique identifier for the line item response, used to track and reference the supplier’s offer or bid for a particular line item within the negotiation. |
| ResponseNumber [KEY] | Long | Unique identifier for the response, used to track and reference a specific supplier's overall offer or bid in the negotiation process. |
| LineId [KEY] | Long | Unique identifier for the line item in the negotiation, used to reference and track specific line items in the negotiation process. |
| Line | String | The description or label for the line item, providing identification for each specific offer or item in the supplier’s response. |
| LineCostFactorId [KEY] | Long | Unique identifier for the cost factor associated with the line item, helping to track and manage specific cost components tied to the item. |
| CostFactorId | Long | Unique identifier for the cost factor, linking it to specific cost considerations (for example, labor, material, shipping) in the context of the negotiation. |
| CostFactor | String | The name or description of the cost factor, providing context about the specific cost component being tracked and negotiated (for example, 'Material', 'Labor'). |
| Description | String | Detailed description of the cost factor, explaining its relevance or how it impacts the cost structure of the line item. |
| TargetValue | Decimal | The target value for the cost factor, representing the expected or desired amount for the cost factor in the negotiation. |
| ResponseValue | Decimal | The value submitted by the supplier for the cost factor, indicating their proposed amount for that specific cost element. |
| PricingBasisCode | String | Code representing the pricing basis for the cost factor, indicating how the cost is calculated (for example, per unit, per hour). |
| PricingBasis | String | The pricing basis for the cost factor, describing how the cost is structured or measured (for example, 'Per unit', 'Per hour', 'Fixed rate'). |
| DisplayTargetFlag | Bool | Flag indicating whether the target value for the cost factor should be displayed in the system. If true, the target value is shown; if false, it is hidden. |
| Finder | String | Search or query reference related to the SupplierNegotiationResponseslinescostFactors, used for filtering or looking up specific cost factor records in the negotiation process. |
Groups relevant attributes (color, dimensions, performance) for a negotiation line in the supplier’s response.
| Name | Type | Description |
| SupplierNegotiationResponsesResponseNumber [KEY] | Long | Unique identifier for the response within the supplier negotiation, linking the line attribute group data to a specific response in the negotiation process. |
| LinesLineId [KEY] | Long | Unique identifier for the line item associated with the response, linking the attribute group to a specific line in the negotiation. |
| LinesResponseNumber [KEY] | Long | Unique identifier for the response associated with a line item, used to track and reference the supplier’s offer or bid for a particular line item. |
| ResponseNumber | Long | Unique identifier for the overall response, linking the line attribute group to a specific supplier’s overall offer in the negotiation. |
| LineId | Decimal | Unique identifier for the line item, used to track specific line items in the negotiation process and link them to their respective attribute groups. |
| Line | String | The description or label for the line item, providing identification for the specific item in the supplier’s response. |
| LineDescription | String | Detailed description of the line item, offering further clarification on the product or service being negotiated. |
| GroupId [KEY] | Long | Unique identifier for the group associated with the line attribute, helping to track and reference attribute groups related to the line item. |
| GroupName | String | The name of the attribute group, providing a label for the group that organizes specific characteristics or attributes for the line item. |
| Weight | Decimal | The weight or importance of the attribute group, representing how much influence the group’s score has on the overall evaluation of the line item. |
| Score | Decimal | The score assigned to the attribute group based on evaluation criteria, showing how well the line item meets the group’s requirements. |
| WeightedScore | Decimal | The weighted score of the attribute group, taking the weight of the group into account to provide an adjusted score that reflects its importance in the evaluation. |
| CreatedBy | String | The name or identifier of the user who created the line attribute group record, ensuring accountability for data entry. |
| CreationDate | Datetime | The date and time when the line attribute group record was created, providing a timestamp for when the data was entered into the system. |
| SupplierId | Long | Unique identifier for the supplier, linking the line attribute group to a specific supplier involved in the negotiation. |
| Supplier | String | The name of the supplier, identifying the company or vendor associated with the line attribute group. |
| LastUpdatedBy | String | The name or identifier of the user who last updated the line attribute group record, ensuring accountability for any changes made. |
| LastUpdateDate | Datetime | The date and time when the line attribute group was last updated, providing a timestamp for the most recent modification. |
| Finder | String | Search or query reference related to the SupplierNegotiationResponseslineslineAttributeGroups, used for filtering or looking up specific attribute group records in the negotiation process. |
Lists each attribute within an attribute group for a negotiation line, enabling detailed supplier-submitted specifications.
| Name | Type | Description |
| SupplierNegotiationResponsesResponseNumber [KEY] | Long | Unique identifier for the response within the supplier negotiation, linking the line attribute group line attribute data to a specific response in the negotiation process. |
| LinesLineId [KEY] | Long | Unique identifier for the line item associated with the response, linking the line attribute to a specific line in the negotiation. |
| LinesResponseNumber [KEY] | Long | Unique identifier for the line item response, used to track and reference the supplier’s offer or bid for a particular line item in the negotiation. |
| ResponseNumber [KEY] | Long | Unique identifier for the overall response, linking the line attribute data to a specific supplier’s overall offer in the negotiation. |
| LineId [KEY] | Long | Unique identifier for the line item, used to reference specific line items in the negotiation process and link them to their respective line attributes. |
| Line | String | The description or label for the line item, providing identification for the specific item in the supplier’s response. |
| LineDescription | String | Detailed description of the line item, offering further clarification on the product or service being negotiated. |
| GroupId | Long | Unique identifier for the group associated with the line attribute, helping to track and reference attribute groups related to the line item. |
| GroupName | String | The name of the attribute group, providing a label for the group that organizes specific characteristics or attributes for the line item. |
| AttributeId [KEY] | Long | Unique identifier for the attribute, linking it to a specific characteristic or factor being evaluated in the negotiation. |
| AttributeName | String | The name of the attribute, providing a label or description for the specific characteristic being tracked or negotiated. |
| SupplierId | Long | Unique identifier for the supplier, linking the line attribute to a specific supplier involved in the negotiation. |
| Supplier | String | The name of the supplier, identifying the company or vendor associated with the line attribute. |
| ResponseTypeCode | String | Code representing the type of response for the attribute, such as 'bid', 'offer', or 'revision'. |
| ResponseType | String | Descriptive type of the response for the attribute, providing clarity on how the supplier has responded to the attribute (for example, 'Initial', 'Amended'). |
| ValueTypeCode | String | Code representing the value type of the attribute, such as 'numeric', 'text', or 'date'. |
| ValueType | String | Descriptive value type of the attribute, indicating the kind of data expected for the attribute (for example, 'Date', 'Number', 'Text'). |
| TargetDateValue | Date | Target date for the attribute, representing the expected or required date for the specific line item in the negotiation. |
| TargetNumberValue | Decimal | Target number value for the attribute, representing the expected or required numeric value for the line item in the negotiation. |
| TargetTextValue | String | Target text value for the attribute, representing the expected or required textual response for the line item. |
| ResponseDateValue | Date | The date value provided by the supplier in their response for the attribute, indicating their proposed date. |
| ResponseNumberValue | Decimal | The numeric value provided by the supplier in their response for the attribute, indicating their proposed number. |
| ResponseTextValue | String | The text value provided by the supplier in their response for the attribute, indicating their proposed textual response. |
| Weight | Decimal | The weight or importance of the attribute, representing how much influence the attribute’s value has on the overall evaluation of the line item. |
| Score | Decimal | The score assigned to the line attribute based on evaluation criteria, reflecting how well the attribute meets the requirements of the negotiation. |
| WeightedScore | Decimal | The weighted score of the line attribute, taking the attribute’s weight into account to provide an adjusted score that reflects its importance in the evaluation. |
| CreatedBy | String | The name or identifier of the user who created the line attribute group record, ensuring accountability for data entry. |
| CreationDate | Datetime | The date and time when the line attribute group record was created, providing a timestamp for when the data was entered into the system. |
| LastUpdatedBy | String | The name or identifier of the user who last updated the line attribute group record, ensuring accountability for any changes made. |
| LastUpdateDate | Datetime | The date and time when the line attribute group was last updated, providing a timestamp for the most recent modification. |
| Finder | String | Search or query reference related to the SupplierNegotiationResponseslineslineAttributeGroupslineAttributes, used for filtering or looking up specific attribute records in the negotiation process. |
Defines tiered or location-based discounts proposed by suppliers, applied to negotiated line pricing.
| Name | Type | Description |
| SupplierNegotiationResponsesResponseNumber [KEY] | Long | Unique identifier for the response within the supplier negotiation, linking the price break data to a specific response in the negotiation process. |
| LinesLineId [KEY] | Long | Unique identifier for the line item associated with the response, linking the price break data to a specific line in the negotiation. |
| LinesResponseNumber [KEY] | Long | Unique identifier for the line item response, used to track and reference the supplier’s offer or bid for a particular line item within the negotiation. |
| ResponseNumber [KEY] | Long | Unique identifier for the overall response, linking the price break data to a specific supplier’s overall offer in the negotiation. |
| LineId [KEY] | Long | Unique identifier for the line item, used to reference specific line items in the negotiation process and link them to their respective price breaks. |
| Line | String | The description or label for the line item, providing identification for the specific item in the supplier’s response. |
| PriceBreakId [KEY] | Long | Unique identifier for the price break associated with the line item, helping to track and reference specific price adjustments in the negotiation. |
| ShipToOrganizationId | Long | Unique identifier for the ship-to organization, linking the price break data to a specific organization responsible for receiving the goods. |
| ShipToOrganization | String | The name of the organization that will receive the goods associated with the price break, providing a reference for the recipient organization. |
| ShipToLocationId | Long | Unique identifier for the ship-to location, linking the price break data to a specific physical location where the goods will be delivered. |
| ShipToLocation | String | The name or description of the location to which the goods will be shipped, providing clarity on the delivery address for the price break. |
| Quantity | Decimal | The quantity associated with the price break, representing the amount of goods for which the price break applies. |
| PriceBreakPrice | Decimal | The price for the line item when the specified quantity is met, reflecting the price after applying the price break. |
| PriceBreakPriceDiscountPercent | Decimal | The discount percentage applied to the price at the specified quantity threshold, showing the percentage reduction in price due to the price break. |
| PriceBreakResponsePrice | Decimal | The price submitted by the supplier in response to the price break, indicating the price they are offering based on the quantity and terms of the price break. |
| TargetPrice | Decimal | The target price for the line item, representing the price the supplier aims to achieve or negotiate for the item based on the price break structure. |
| PriceBreakStartDate | Date | The start date of the price break, indicating when the price break becomes valid or starts to apply for the specified quantity. |
| PriceBreakEndDate | Date | The end date of the price break, indicating when the price break expires or is no longer valid for the specified quantity. |
| PricingBasisCode | String | Code representing the pricing basis for the price break, such as 'unit', 'volume', or 'bulk', indicating how the price break is structured. |
| PricingBasis | String | Description of the pricing basis, explaining how the price break is calculated or applied (for example, 'per unit', 'per volume', 'for bulk orders'). |
| CreatedBy | String | The name or identifier of the user who created the price break record, ensuring accountability for data entry. |
| CreationDate | Datetime | The date and time when the price break record was created, providing a timestamp for when the price break was initially entered into the system. |
| LastUpdateBy | String | The name or identifier of the user who last updated the price break record, ensuring accountability for changes made to the record. |
| LastUpdateDate | Datetime | The date and time when the price break record was last updated, providing a timestamp for the most recent change. |
| Finder | String | Search or query reference related to the SupplierNegotiationResponseslinespriceBreaks, used for filtering or looking up specific price break records in the negotiation process. |
Specifies quantity-based price tiers in a supplier’s response, outlining price changes above certain order thresholds.
| Name | Type | Description |
| SupplierNegotiationResponsesResponseNumber [KEY] | Long | Unique identifier for the response within the supplier negotiation, linking the price tier data to a specific response in the negotiation process. |
| LinesLineId [KEY] | Long | Unique identifier for the line item associated with the response, linking the price tier data to a specific line in the negotiation. |
| LinesResponseNumber [KEY] | Long | Unique identifier for the line item response, used to track and reference the supplier’s offer or bid for a particular line item within the negotiation. |
| ResponseNumber [KEY] | Long | Unique identifier for the overall response, linking the price tier data to a specific supplier’s overall offer in the negotiation. |
| LineId [KEY] | Long | Unique identifier for the line item, used to reference specific line items in the negotiation process and link them to their respective price tiers. |
| Line | String | The description or label for the line item, providing identification for the specific item in the supplier’s response. |
| PriceTierId [KEY] | Long | Unique identifier for the price tier, allowing for specific tracking of pricing structures that are applied to certain quantity ranges. |
| MinimumQuantity | Decimal | The minimum quantity required for the price tier, indicating the starting quantity for which the price tier applies. |
| MaximumQuantity | Decimal | The maximum quantity for the price tier, indicating the upper limit of the quantity range within which the price tier applies. |
| Price | Decimal | The price offered for the line item within the specified quantity range of the price tier. |
| CreatedBy | String | The name or identifier of the user who created the price tier record, ensuring accountability for data entry. |
| CreationDate | Datetime | The date and time when the price tier record was created, providing a timestamp for when the tier was added to the system. |
| LastUpdatedBy | String | The name or identifier of the user who last updated the price tier record, ensuring accountability for any changes made to the tier. |
| LastUpdateDate | Datetime | The date and time when the price tier record was last updated, providing a timestamp for the most recent change. |
| Finder | String | Search or query reference related to the SupplierNegotiationResponseslinespriceTiers, used for filtering or looking up specific price tier records in the negotiation process. |
Structures supplier negotiation requirements into sections (for example, technical, legal), allowing organized input and review.
| Name | Type | Description |
| SupplierNegotiationResponsesResponseNumber [KEY] | Long | Unique identifier for the response within the supplier negotiation, linking the section data to a specific response in the negotiation process. |
| ResponseNumber [KEY] | Long | Unique identifier for the response, used to track and reference a specific supplier’s overall offer or bid in the negotiation. |
| SectionId [KEY] | Long | Unique identifier for the section associated with the negotiation response, allowing the section to be tracked and referenced individually. |
| SectionDisplayNumber | String | Display number of the section, used to visually organize and identify sections within the supplier negotiation document. |
| PricingSectionFlag | Bool | Flag indicating whether the section is related to pricing. If true, the section contains pricing information; if false, it does not. |
| Section | String | The name or title of the section, providing a reference to the content or focus of the section within the negotiation response. |
| EvaluationStageCode | String | Code representing the evaluation stage associated with the section, used to categorize the stage of the negotiation process (for example, 'Initial', 'Final'). |
| EvaluationStage | String | Descriptive label for the evaluation stage, explaining the phase of the negotiation process to which the section pertains. |
| SectionScore | Long | The score assigned to the section based on evaluation criteria, reflecting how well the section meets the requirements or expectations of the negotiation. |
| MaximumScore | Decimal | The maximum possible score that the section can achieve, used as a benchmark to assess the performance of the section in the evaluation process. |
| SectionWeight | Decimal | The weight assigned to the section, indicating its relative importance in the overall evaluation of the response. |
| SectionWeightedScore | Decimal | The weighted score of the section, taking into account the section’s weight and score to produce an adjusted score reflecting its importance. |
| CreatedBy | String | The name or identifier of the user who created the section record, ensuring accountability for data entry. |
| CreationDate | Datetime | The date and time when the section record was created, providing a timestamp for when the section was added to the system. |
| LastUpdatedBy | String | The name or identifier of the user who last updated the section record, ensuring accountability for any changes made. |
| LastUpdateDate | Datetime | The date and time when the section record was last updated, providing a timestamp for the most recent change. |
| Finder | String | Search or query reference related to the SupplierNegotiationResponsessections, used for filtering or looking up specific section records in the negotiation process. |
Lists requirement questions or prompts within each negotiation section, requesting supplier input on capabilities or compliance.
| Name | Type | Description |
| SupplierNegotiationResponsesResponseNumber [KEY] | Long | Unique identifier for the response within the supplier negotiation, linking the section requirement data to a specific response in the negotiation process. |
| SectionsResponseNumber [KEY] | Long | Unique identifier for the section response, linking the requirement data to a specific section in the supplier negotiation. |
| SectionsSectionId [KEY] | Long | Unique identifier for the section associated with the requirement, helping to track and reference the section in the negotiation process. |
| ResponseNumber [KEY] | Long | Unique identifier for the overall response, linking the section requirement data to a specific supplier’s overall offer in the negotiation. |
| SectionId | Long | Unique identifier for the section in the negotiation, used to reference the section associated with specific requirements. |
| Section | String | The name or title of the section, providing identification for the specific section in the negotiation. |
| RequirementId [KEY] | Long | Unique identifier for the requirement, allowing for specific tracking of the requirement within the section. |
| ScoreId | Long | Unique identifier for the score assigned to the requirement, linking the score to the specific requirement for evaluation. |
| ParentType | String | The type of the parent entity associated with the requirement, which could indicate whether it's part of a larger category or group in the negotiation. |
| RequirementLevel | Decimal | The level or tier of the requirement, often representing the priority or significance of the requirement in the negotiation. |
| RequirementNumber | String | The identifier or label for the requirement, providing a reference number for the specific requirement within the section. |
| QuestionId | Long | Unique identifier for the question associated with the requirement, linking the requirement to a specific question that needs to be answered in the negotiation process. |
| QuestionRevisionNumber | Int | The revision number of the question associated with the requirement, indicating the version of the question used for evaluation. |
| Requirement | String | The description or label for the requirement, explaining what is expected from the supplier in this part of the negotiation. |
| RequirementText | String | Detailed text explaining the specific terms and conditions of the requirement, providing more context and clarification. |
| Comments | String | Additional comments or notes related to the requirement, often providing further context or explanation for the supplier. |
| Hint | String | Helpful hints or guidance related to the requirement, providing additional support for understanding or fulfilling the requirement. |
| LevelCode | String | Code representing the level of the requirement, used for categorizing the requirement based on its importance or tier in the negotiation process. |
| Level | String | Descriptive label for the level of the requirement, indicating whether it's a high, medium, or low-priority requirement. |
| ResponseTypeCode | String | Code representing the type of response for the requirement, such as 'bid', 'offer', or 'revision'. |
| ResponseType | String | Descriptive type of the response for the requirement, providing clarity on how the supplier has responded (for example, 'Initial', 'Amended'). |
| RequirementTypeCode | String | Code representing the type of the requirement, such as 'technical', 'financial', or 'compliance'. |
| RequirementType | String | Descriptive type of the requirement, explaining what category the requirement falls under in the negotiation. |
| ValueTypeCode | String | Code representing the value type of the requirement, such as 'numeric', 'text', or 'date'. |
| ValueType | String | Descriptive label for the value type of the requirement, indicating whether the requirement is expected to be a number, text, or date. |
| TargetTextValue | String | The target text value for the requirement, indicating the expected or desired textual answer from the supplier. |
| TargetNumberValue | Decimal | The target numeric value for the requirement, representing the expected or desired number from the supplier. |
| TargetDateValue | Date | The target date for the requirement, representing the expected or desired date from the supplier. |
| TargetDateTimeValue | Datetime | The target date-time value for the requirement, representing the expected or desired date and time from the supplier. |
| Score | Decimal | The score assigned to the requirement based on the evaluation criteria, reflecting how well the requirement is met by the supplier. |
| MaximumScore | Decimal | The maximum possible score for the requirement, used to evaluate how well the supplier meets the expectations for that requirement. |
| Weight | Decimal | The weight assigned to the requirement, indicating its relative importance in the overall evaluation of the negotiation. |
| WeightedScore | Decimal | The weighted score of the requirement, accounting for its weight in the overall evaluation and performance of the supplier. |
| InternalNote | String | Internal notes for the requirement, often used to document internal thoughts, observations, or instructions related to the requirement. |
| CreatedBy | String | The name or identifier of the user who created the requirement record, ensuring accountability for the data entry. |
| CreationDate | Datetime | The date and time when the requirement record was created, providing a timestamp for when the requirement was entered into the system. |
| LastUpdateDate | Datetime | The date and time when the requirement record was last updated, providing a timestamp for the most recent modification. |
| LastUpdatedBy | String | The name or identifier of the user who last updated the requirement record, ensuring accountability for any changes made. |
| Finder | String | Search or query reference related to the SupplierNegotiationResponsessectionsrequirements, used for filtering or looking up specific requirement records in the negotiation process. |
Holds supporting files (drawings, certificates) attached to specific negotiation requirements, clarifying supplier responses.
| Name | Type | Description |
| SupplierNegotiationResponsesResponseNumber [KEY] | Long | Unique identifier for the response within the supplier negotiation, linking the requirement attachment data to a specific response in the negotiation process. |
| SectionsResponseNumber [KEY] | Long | Unique identifier for the section response, linking the requirement attachment data to a specific section within the supplier negotiation. |
| SectionsSectionId [KEY] | Long | Unique identifier for the section associated with the requirement, allowing tracking of the section to which the attachment is related. |
| RequirementsRequirementId [KEY] | Long | Unique identifier for the requirement associated with the attachment, providing clarity on the specific requirement that the document supports. |
| RequirementsResponseNumber [KEY] | Long | Unique identifier for the requirement response, linking the attachment to the specific response provided for that requirement. |
| AttachedDocumentId [KEY] | Long | Unique identifier for the document that is attached to the requirement, allowing for precise tracking and retrieval of the document. |
| LastUpdateDate | Datetime | The date and time when the attachment document was last updated, ensuring visibility into when the document was last modified. |
| LastUpdatedBy | String | The name or identifier of the person who last updated the attachment document, ensuring accountability for changes made. |
| DatatypeCode | String | Code representing the data type of the attached document, such as 'PDF' or 'Word', helping to classify and process the file. |
| FileName | String | The name of the attached file, providing a reference for identifying the document within the system. |
| DmFolderPath | String | Path to the folder in the document management system where the attached document is stored, facilitating easy location of the document. |
| DmDocumentId | String | Unique identifier for the document in the document management system, ensuring precise tracking and retrieval. |
| DmVersionNumber | String | Version number of the document, distinguishing between different versions of the same document. |
| Url | String | The URL pointing directly to the attachment, providing access to the document for users. |
| CategoryName | String | Category assigned to the attached document, used to classify and group related documents for easier retrieval. |
| UserName | String | The name or identifier of the user associated with the attachment, indicating who uploaded or is managing the document. |
| Uri | String | Uniform Resource Identifier (URI) linking to the attachment, providing a consistent reference for the document within the system. |
| FileUrl | String | URL for downloading the attached file, offering a direct link for users to retrieve the document. |
| UploadedText | String | Text entered during the upload process, often used for describing the document or providing additional context for the file. |
| UploadedFileContentType | String | The content type of the uploaded file, indicating its format. |
| UploadedFileLength | Long | The size of the uploaded file in bytes, providing an indication of the document’s size and helping to manage storage. |
| UploadedFileName | String | The original name of the file when it was uploaded, typically retained for reference within the system. |
| ContentRepositoryFileShared | Bool | Flag indicating whether the file is shared with others in the content repository. If true, the file is shared; if false, it is private. |
| Title | String | The title of the attached document, summarizing the content or purpose of the file. |
| Description | String | Detailed description of the attached document, explaining its relevance, contents, or role in the negotiation. |
| ErrorStatusCode | String | Code representing the error status during the document attachment process, used to identify specific issues or failures that occurred. |
| ErrorStatusMessage | String | Message explaining the error that occurred during the document attachment process, providing details about what went wrong. |
| CreatedBy | String | The name or identifier of the user who created the attachment record, ensuring accountability for data entry. |
| CreationDate | Datetime | The date and time when the attachment record was created, marking the timestamp for when the document was initially added to the system. |
| FileContents | String | The contents of the file, typically for text-based documents, representing the raw text stored within the attachment. |
| ExpirationDate | Datetime | The expiration date of the attachment, specifying when the document will no longer be valid or accessible in the system. |
| LastUpdatedByUserName | String | The username of the individual who last updated the attachment, ensuring visibility into who made the most recent modification. |
| CreatedByUserName | String | The username of the individual who initially created the attachment, offering insight into the origin of the document. |
| AsyncTrackerId | String | Identifier used to track asynchronous processing related to the attachment, such as file conversion, upload, or validation tasks. |
| FileWebImage | String | URL or path to an image representing the file in web interfaces, often used as a visual preview of the document. |
| DownloadInfo | String | Information related to downloading the attachment, such as format, size, or instructions for accessing the document. |
| PostProcessingAction | String | Action that is performed on the attachment after it has been uploaded, such as validation, categorization, or encryption. |
| Finder | String | Search or query reference related to the SupplierNegotiationResponsessectionsrequirementsattachments, used for filtering or looking up specific attachment records in the system. |
| ResponseNumber | Long | Unique identifier for the response, linking the attachment to a specific response in the negotiation process. |
Records the supplier's answers or data points for each requirement, supporting thorough analysis of submitted proposals.
| Name | Type | Description |
| SupplierNegotiationResponsesResponseNumber [KEY] | Long | Unique identifier for the response within the supplier negotiation, linking the requirement response value data to a specific response in the negotiation process. |
| SectionsResponseNumber [KEY] | Long | Unique identifier for the section response, linking the requirement response value data to a specific section within the supplier negotiation. |
| SectionsSectionId [KEY] | Long | Unique identifier for the section associated with the requirement, allowing tracking of the section to which the response value is related. |
| RequirementsRequirementId [KEY] | Long | Unique identifier for the requirement associated with the response value, providing clarity on the specific requirement that the response value supports. |
| RequirementsResponseNumber [KEY] | Long | Unique identifier for the requirement response, linking the response value to the specific response provided for that requirement. |
| ResponseNumber | Long | Unique identifier for the overall response, linking the requirement response value data to a specific supplier’s overall offer in the negotiation. |
| SectionId | Long | Unique identifier for the section in the negotiation, used to reference the section associated with specific requirement response values. |
| Section | String | The name or title of the section, providing identification for the specific section in the negotiation that contains the requirement. |
| RequirementId | Long | Unique identifier for the requirement, allowing for specific tracking of the requirement within the section. |
| RequirementNumber | String | The identifier or label for the requirement, providing a reference number for the specific requirement within the section. |
| Requirement | String | The description or label for the requirement, explaining what is expected from the supplier in this part of the negotiation. |
| RequirementLevel | Decimal | The level or tier of the requirement, often representing the priority or significance of the requirement in the negotiation process. |
| ScoreId | Long | Unique identifier for the score assigned to the requirement response, linking the score to the specific requirement response value. |
| QuestionId | Long | Unique identifier for the question associated with the requirement, linking the response value to a specific question asked in the negotiation. |
| ScoreDisplayNumber | String | Display number for the score, used for organizing and visually identifying how the requirement score is presented in the negotiation documentation. |
| RequirementValueId [KEY] | Long | Unique identifier for the value of the requirement, tracking the specific value linked to the requirement's response. |
| ResponseValueText | String | The text response provided by the supplier for the requirement, indicating their proposed or provided text value for the requirement. |
| ResponseValueNumber | Decimal | The numeric response provided by the supplier for the requirement, indicating their proposed or provided numerical value for the requirement. |
| ResponseValueDate | Date | The date response provided by the supplier for the requirement, indicating the date value they proposed or provided for the requirement. |
| ResponseValueDateTime | Datetime | The date and time response provided by the supplier for the requirement, indicating the precise date and time they proposed for the requirement. |
| IsSelectedFlag | Bool | Flag indicating whether the requirement response value is selected or not. If true, the value has been selected; if false, it has not. |
| TargetTextValue | String | The target text value for the requirement, indicating the expected or desired textual answer from the supplier. |
| TargetNumberValue | Decimal | The target numeric value for the requirement, representing the expected or desired number from the supplier. |
| TargetDateValue | Date | The target date for the requirement, representing the expected or desired date from the supplier. |
| TargetDateTimeValue | Datetime | The target date-time value for the requirement, representing the expected or desired date and time from the supplier. |
| Score | Decimal | The score assigned to the requirement response value, reflecting how well the supplier’s response meets the requirements of the negotiation. |
| CreatedBy | String | The name or identifier of the user who created the requirement response value record, ensuring accountability for data entry. |
| CreationDate | Datetime | The date and time when the requirement response value record was created, providing a timestamp for when the data was entered into the system. |
| LastUpdateDate | Datetime | The date and time when the requirement response value record was last updated, providing a timestamp for the most recent modification. |
| LastUpdatedBy | String | The name or identifier of the user who last updated the requirement response value record, ensuring accountability for any changes made. |
| Attachments | String | List of attachments associated with the requirement response value, often including documents, files, or images related to the response. |
| Finder | String | Search or query reference related to the SupplierNegotiationResponsessectionsrequirementsresponseValues, used for filtering or looking up specific response values in the negotiation process. |
Oversees key negotiation details (for example, objectives, timelines, participants) for supplier sourcing events or auctions.
| Name | Type | Description |
| AuctionHeaderId [KEY] | Long | Unique identifier for the auction header, linking the negotiation data to a specific auction event. |
| AllowAlternateLinesFlag | Bool | Flag indicating whether suppliers can create alternate response lines for each negotiation line. If true, alternate lines are allowed; if false, they are not. |
| AllowSuppliersToNegotiateRetainageFlag | Bool | Flag indicating whether suppliers can enter retainage attributes during the negotiation. If true, they are allowed; if false, they are not. |
| NegotiationTitle | String | Title or description of the purpose of the negotiation, summarizing what the negotiation is about. |
| Negotiation | String | Unique identifier for the negotiation, used to track and reference the specific negotiation instance. |
| NegotiationStatus | String | Current status of the negotiation (for example, 'Open', 'Closed', 'Pending'). |
| AmendmentDescription | String | Description of changes made to the negotiation when it is amended, providing context for the updates. |
| Synopsis | String | A summary of the negotiation, providing a brief overview of the negotiation details. |
| NegotiationTypeId | Long | Unique identifier for the type of negotiation, helping categorize the negotiation (for example, Auction, RFQ, RFI). |
| NegotiationType | String | The type of negotiation, which could include Auction, RFQ, or RFI. |
| NegotiationStyleId | Long | Unique identifier for the style of the negotiation, allowing categorization by the format or process used. |
| NegotiationStyle | String | Name of the negotiation style, which can indicate the process or method used (for example, sealed bid, open bidding). |
| LargeNegotiationFlag | Bool | Flag indicating whether the negotiation is considered large in scope, often affecting the negotiation process or criteria. |
| TwoStageEvaluationFlag | Bool | Flag indicating whether two-stage evaluation is enabled for the negotiation. If true, two-stage evaluation is used; if false, it is not. |
| BuyerId | Long | Unique identifier for the buyer, the person who created or is managing the negotiation. |
| Buyer | String | The name of the person who created the negotiation, typically the buyer or procurement manager. |
| ProcurementBUId | Long | Unique identifier for the procurement business unit associated with the negotiation, helping track the ownership of the negotiation. |
| ProcurementBU | String | Name of the procurement business unit that owns the negotiation, helping to link the negotiation to the relevant department. |
| Outcome | String | Display name of the purchasing document created at the end of the negotiation process, indicating the final result of the negotiation. |
| ApprovalAmount | Decimal | Amount used in the approval process for the negotiation, which could be the negotiation amount or the agreement amount. |
| NoteToNegotiationApprovers | String | Notes for the approvers when submitting the negotiation document for approval. |
| SourceAgreement | String | The agreement being renegotiated or referenced in the current negotiation process. |
| POStyleId | Long | Unique identifier for the purchasing document style associated with the negotiation. |
| POStyle | String | Name or description of the purchasing document style used for the negotiation. |
| PODoctypeCode | String | Code identifying the document type of the purchasing document related to the negotiation. |
| PODoctype | String | Description of the purchasing document type associated with the negotiation. |
| TechnicalStageUnlockedBy | String | The person or role that unlocked the technical stage in the negotiation. |
| TechnicalStageUnlockedDate | Datetime | The date and time when the technical stage was unlocked in the negotiation process. |
| TechnicalStageUnsealedBy | String | The person or role that unsealed the technical stage in the negotiation. |
| TechnicalStageUnsealedDate | Datetime | The date and time when the technical stage was unsealed, marking a shift in the negotiation process. |
| CommercialStageUnlockedBy | String | The person or role that unlocked the commercial stage in the negotiation. |
| CommercialStageUnlockedDate | Datetime | The date and time when the commercial stage was unlocked, marking the transition to this phase in the negotiation. |
| CommercialStageUnsealedBy | String | The person or role that unsealed the commercial stage in the negotiation. |
| CommercialStageUnsealedDate | Datetime | The date and time when the commercial stage was unsealed, allowing the transition to a new phase in the negotiation. |
| PreviewImmediatelyFlag | Bool | Flag indicating whether suppliers can view the negotiation immediately after publication but before they can respond. If true, suppliers can view the negotiation; if false, they cannot. |
| PreviewDate | Datetime | The date when suppliers are allowed to view the negotiation but are not yet allowed to respond. |
| CloseDate | Datetime | The date when the negotiation closes, ceasing to accept replies from suppliers. |
| DaysAfterOpenDate | Decimal | The number of days after the open date when the negotiation will close, defining the duration of the negotiation period. |
| StaggeredClosingFlag | Bool | Flag indicating whether staggered closing is enabled for the negotiation, allowing different lines to close at different times. |
| StaggeredClosingInterval | Decimal | The time interval between two negotiation lines when staggered closing is enabled, defining the difference in closing times. |
| FirstLineCloseDate | Datetime | The date when the first line of the negotiation closes when staggered closing is enabled. |
| AutoExtendFlag | Bool | Flag indicating whether the negotiation will automatically extend if certain conditions are met, such as the submission of new responses. |
| AutoExtendMinimumTriggerRank | Decimal | The minimum rank of response that can trigger an automatic extension of the negotiation. |
| AutoExtendAllLinesFlag | Bool | Flag indicating whether all lines should be extended automatically in case of an extension, or just the lines with winning responses. |
| AutoExtensionsNumber | Decimal | The number of times the negotiation can be extended automatically, based on predefined conditions. |
| AutoExtendTriggerPeriod | Decimal | The time period before the close date that allows responses to trigger an extension. |
| AutoExtendFromCloseDateFlag | Bool | Flag indicating whether the extension period is counted from the original close date or from the start of the negotiation extension. |
| AutoExtendDuration | Decimal | The duration of the extension applied when the negotiation is extended automatically. |
| OpenImmediatelyFlag | Bool | Flag indicating whether suppliers can respond immediately after the negotiation is published. If true, they can respond immediately; if false, they cannot. |
| OpenDate | Datetime | The date when the negotiation begins accepting replies from suppliers. |
| AwardByDate | Datetime | The date when the negotiation is expected to award the contract based on the responses received. |
| ResponseVisibilityCode | String | Code indicating when the supplier can view details from competing responses, with options like Open, Sealed, or Blind. |
| ResponseVisibility | String | Specifies when the supplier can view details from competing responses, providing visibility into how transparent the negotiation process is. |
| OverallRankingMethodCode | String | Code identifying the method used to calculate overall rankings for supplier responses, such as 'Response amount only' or 'Composite scoring'. |
| OverallRankingMethod | String | Method used to calculate the overall ranking for supplier responses, such as using response amounts or composite scoring. |
| NegotiationLayoutName | String | Layout used by Oracle Business Intelligence Publisher to generate the negotiation PDF document. |
| ResponseLayoutName | String | Layout used by Oracle Business Intelligence Publisher to generate the negotiation response PDF document. |
| ContractTermsLayout | String | Layout used by Oracle Business Intelligence Publisher to generate the contract terms PDF document for the negotiation. |
| EnableTeamScoringFlag | Bool | Flag indicating whether team scoring is enabled for evaluating negotiation requirements, allowing multiple evaluators to score the responses. |
| EnableRequirementWeightsFlag | Bool | Flag indicating whether weights are applied to requirements when calculating the total score in the negotiation. |
| EnableSectionWeightsFlag | Bool | Flag indicating whether section weights are applied when calculating the total score for the negotiation. |
| DisplayRequirementScoresFlag | Bool | Flag indicating whether the supplier can view the requirement scoring criteria during the negotiation process. |
| DefaultMaximumRequirementScore | Decimal | Default maximum score for each requirement in the negotiation, representing the highest possible score a supplier can achieve for a requirement. |
| RequisitioningBUId | Long | Unique identifier for the requisition business unit, linking the negotiation to the relevant requisition unit. |
| RequisitioningBU | String | Name of the requisition business unit that sets default values for negotiation lines. |
| PriceTiersCode | String | Code identifying the type of price tier applied in the negotiation, such as 'None', 'Price Break', or 'Quantity'. |
| PriceTiers | String | Type of price tier applied in the negotiation, with options such as 'None', 'Price Break', or 'Quantity'. |
| RankIndicatorCode | String | Code identifying how supplier replies are ranked during the negotiation, such as 'Best', '1,2,3', or 'No'. |
| RankIndicator | String | Indicator used to rank supplier replies during the negotiation, with options such as 'Best', '1,2,3', or 'No'. |
| RankingMethodCode | String | Code identifying the method used to rank supplier replies, such as 'Price' or 'Multiattribute'. |
| RankingMethod | String | Method used to rank supplier replies in the negotiation, such as 'Price' or 'Multiattribute'. |
| DisplayScoresToSuppliersFlag | Bool | Flag indicating whether suppliers can view the line attribute scoring criteria during the negotiation. |
| RestrictToInvitedSuppliersFlag | Bool | Flag indicating whether only invited suppliers can participate in the negotiation, restricting access to others. |
| RestrictToInvitedSuppliersDisplayFlag | Bool | Flag indicating whether suppliers can see if the negotiation is restricted to invited suppliers. |
| ViewNotesAndAttachmentsFlag | Bool | Flag indicating whether suppliers can view contract terms, notes, and attachments submitted by other suppliers. |
| ViewNotesAndAttachmentsDisplayFlag | Bool | Flag indicating whether suppliers can see if they are allowed to view contract terms, notes, and attachments from other suppliers. |
| RespondOnAllLinesFlag | Bool | Flag indicating whether suppliers can respond to all lines in the negotiation, or if they can respond selectively. |
| RespondOnAllLinesDisplayFlag | Bool | Flag indicating whether suppliers can view whether they are required to respond to all lines in the negotiation. |
| DisplayBestPriceBlindFlag | Bool | Flag indicating whether the best price is displayed to suppliers during a blind negotiation. |
| RequireFullQuantityFlag | Bool | Flag indicating whether the response must match the full quantity requested in the negotiation. |
| RequireFullQuantityDisplayFlag | Bool | Flag indicating whether suppliers can see if the negotiation requires responses to match the full quantity requested. |
| EnforcePreviousRoundPriceAsStartPriceFlag | Bool | Flag indicating whether the previous round’s price is used as the start price for the current round. |
| AllowMultipleResponsesFlag | Bool | Flag indicating whether suppliers can submit more than one response during each negotiation round. |
| AllowMultipleResponsesDisplayFlag | Bool | Flag indicating whether suppliers can see if they are allowed to submit multiple responses. |
| AllowResponseRevisionFlag | Bool | Flag indicating whether suppliers can revise their active replies during each negotiation round. |
| AllowResponseRevisionDisplayFlag | Bool | Flag indicating whether suppliers can see if they are allowed to revise their responses. |
| RevisedResponseLinePriceRuleCode | String | Code specifying how revised responses must modify their price, such as 'No Restriction' or 'Lower Than Previous Price'. |
| RevisedResponseLinePriceRule | String | Describes the rule for modifying revised responses' prices, including options like 'No Restriction' or 'Lower Than Previous Price'. |
| ResponseRevisionDecrementTypeCode | String | Code identifying the type of minimum price reduction in revised responses, either 'Amount' or 'Percentage'. |
| ResponseRevisionDecrementType | String | Displays the type of minimum price reduction in revised responses, either as an 'Amount' or 'Percentage'. |
| ResponseRevisionDecrementValue | Decimal | The minimum amount or percentage by which the price must be reduced in each revised response. |
| AgreementStartDate | Date | Date when the purchase agreement becomes effective, often used in renegotiations. |
| AgreementEndDate | Date | Date when the purchase agreement expires, specifying the end of the agreement. |
| PaymentTermsId | Long | Unique identifier for the payment terms applied by the supplier based on invoice due date and discount date. |
| PaymentTerms | String | Name of the payment terms the supplier applies, indicating when and how the payment for the invoice should be made. |
| CarrierId | Long | Unique identifier for the transportation company responsible for moving goods from one location to another. |
| Carrier | String | The name of the transportation company responsible for delivering the goods. |
| ModeOfTransportCode | String | Code identifying the mode of transportation used to move the goods, such as 'Land', 'Sea', or 'Air'. |
| ModeOfTransport | String | Mode of transport used to ship the goods, providing details about the transportation method. |
| ServiceLevelCode | String | Code identifying the priority of the shipping service, used to determine the speed of delivery. |
| ServiceLevel | String | Describes the service level, indicating the priority of shipping to ensure timely delivery. |
| ShippingMethod | String | Method used for shipping, combining the carrier, transport mode, and service level for complete logistics information. |
| AgreementAmount | Decimal | Total amount for the purchase agreement, typically used as a baseline for renegotiation. |
| MinimumReleaseAmount | Decimal | The minimum amount for any purchase order line that the application can release for the purchase agreement line. |
| FreightTermsCode | String | Code identifying the freight terms used in the negotiation, indicating whether the buyer or supplier pays for shipping. |
| FreightTerms | String | The freight terms used in the negotiation, specifying who bears the shipping costs. |
| FOBCode | String | Code identifying the point where the ownership of goods and risk of loss transfers from the supplier to the buyer. |
| FOB | String | Point of delivery where the ownership of goods and the cost of loss or damage transfer from the supplier to the buyer. |
| BuyerManagedTransportationFlag | Bool | Flag indicating whether the buying company is responsible for managing the transportation of goods. |
| CurrencyCode | String | Code identifying the currency used in the negotiation for pricing. |
| Currency | String | Name of the currency used in the negotiation. |
| AllowOtherResponseCurrencyFlag | Bool | Flag indicating whether suppliers can submit responses in a currency other than the negotiation's currency. |
| PricePrecision | Decimal | Number of decimal places the application displays for pricing attributes in supplier responses. |
| ConversionRateTypeCode | String | Code identifying the type of currency conversion rate used for converting responses to the negotiation currency. |
| ConversionRateType | String | Describes the type of currency conversion rate used in the negotiation process. |
| ConversionRateDate | Date | The date when the conversion rate was applied to convert the response currency to the negotiation currency. |
| DisplayRatesToSuppliersFlag | Bool | Flag indicating whether suppliers can view the currency exchange rates used in the negotiation. |
| ScoringStatusCode | String | Code representing the scoring status of the negotiation, showing whether it is in progress or completed. |
| ScoringStatus | String | Describes the current status of scoring for the negotiation, indicating whether it's still being calculated or has been finalized. |
| TechnicalStageScoringStatusCode | String | Code representing the scoring status for the technical stage of the negotiation. |
| TechnicalStageScoringStatus | String | Describes the status of scoring in the technical stage of the negotiation. |
| CommercialStageScoringStatusCode | String | Code representing the scoring status for the commercial stage of the negotiation. |
| CommercialStageScoringStatus | String | Describes the status of scoring in the commercial stage of the negotiation. |
| ContractSource | String | Source of the contract, specifying where the contract originated from, such as a prior agreement or new negotiation. |
| ContractTermsTemplateId | Decimal | Unique identifier for the contract terms template applied to the negotiation. |
| ContractTermsTemplate | String | Template used for the contract terms in the negotiation, helping to standardize agreement terms. |
| CreatedBy | String | The name or identifier of the user who created the negotiation record. |
| CreationDate | Datetime | The date and time when the negotiation record was created. |
| LastUpdateDate | Datetime | The date and time when the negotiation record was last updated. |
| LastUpdatedBy | String | The name or identifier of the user who last updated the negotiation record. |
| CoverPageText | String | Text displayed on the cover page of the negotiation document. |
| GeneralIntroductionText | String | Text that provides a general introduction or overview of the negotiation. |
| TermsInstructionText | String | Text that explains how to negotiate terms within the context of the negotiation. |
| RequirementInstructionText | String | Text that describes how to respond to each requirement in the negotiation. |
| LinesInstructionText | String | Text that provides specific instructions for the negotiation line items. |
| PrebidFlag | Bool | Flag indicating whether pre-bid is enabled in the negotiation, allowing suppliers to review the terms before submitting bids. |
| LineDecrementFlag | Bool | Flag indicating whether line-level price decrement is enabled in the negotiation, allowing suppliers to lower their prices in subsequent rounds. |
| AiDataDurationInMonths | Long | Duration, in months, for which AI data is used to influence the negotiation. |
| PersonId | Long | Unique identifier for the person managing or overseeing the negotiation process. |
| NegotiationSupplierLayoutName | String | The layout name used to generate supplier-facing documents for the negotiation in the negotiation supplier layout. |
| NegotiationBuyerLayoutName | String | The layout name used to generate buyer-facing documents for the negotiation in the negotiation buyer layout. |
| TimeRemaining | String | Text indicating the remaining time in the negotiation process, usually counting down until closing. |
| BuyerCompanyName | String | The name of the company representing the buyer in the negotiation. |
| LoggedInPerson | String | Name of the person currently logged into the system, associated with managing the negotiation. |
| Finder | String | Search or query reference used for filtering or locating specific negotiation records. |
| EffectiveDate | Date | Query parameter used to fetch resources based on their effective date, typically indicating when the negotiation or contract becomes valid. |
Maintains summary or abstract information for the negotiation, providing a concise overview of the event.
| Name | Type | Description |
| SupplierNegotiationsAuctionHeaderId [KEY] | Long | Unique identifier for the auction header, linking the abstract data to a specific auction event in the negotiation process. |
| AwardNoticePublishDate | Date | The date when the award notice is published, indicating when the winning supplier is formally notified. |
| AwardNoticePublishFlag | Bool | Flag indicating whether the award notice has been published. If true, the award notice is published; if false, it is not. |
| PostingDate | Datetime | The date and time when the abstract is posted, typically representing when the details of the negotiation are made publicly available. |
| IncludeNegotiationPDFFlag | Bool | Flag indicating whether the negotiation PDF should be included in the abstract. If true, the PDF is included; if false, it is not. |
| IncludeNegotiationAttachmentsToSupplierFlag | Bool | Flag indicating whether the negotiation attachments should be included when sharing the abstract with suppliers. If true, attachments are included; if false, they are not. |
| ResponseTabulationPublishDate | Date | The date when the response tabulation is published, marking the date when suppliers' responses are formally presented or summarized. |
| ResponseTabulationPublishFlag | Bool | Flag indicating whether the response tabulation has been published. If true, the tabulation is available; if false, it is not. |
| AbstractStatus | String | Current status of the abstract, indicating whether it is in draft, published, or some other state. |
| PostingMethod | String | Method used to post the abstract, such as electronic or paper, specifying the means by which the abstract is made available. |
| AwardNoticeText | String | Text content of the award notice, providing details about the award, including the winning supplier and terms. |
| CreationDate | Datetime | The date and time when the abstract record was created, providing a timestamp for when the abstract was initially entered into the system. |
| CreatedBy | String | The name or identifier of the person who created the abstract record, ensuring accountability for the entry of the data. |
| LastUpdateDate | Datetime | The date and time when the abstract record was last updated, providing a timestamp for the most recent modification to the record. |
| LastUpdatedBy | String | The name or identifier of the person who last updated the abstract record, ensuring accountability for changes made to the data. |
| PostedBy | String | The name or identifier of the person who posted the abstract, indicating who made it available to suppliers or other stakeholders. |
| PostAutomaticallyFlag | Bool | Flag indicating whether the abstract should be posted automatically. If true, the abstract is posted automatically based on predefined conditions; if false, manual posting is required. |
| AutomaticPostingEvent | String | The event that triggers the automatic posting of the abstract, specifying the condition or action that causes the abstract to be posted. |
| AuctionHeaderId | Long | Unique identifier for the auction header, linking the abstract to a specific auction event or negotiation. |
| Finder | String | Search or query reference related to the SupplierNegotiationsabstracts, used for filtering or looking up specific abstract records. |
| EffectiveDate | Date | This query parameter is used to fetch resources that are effective as of the specified date, typically used to determine the validity of the abstract for a given period. |
Houses descriptive flexfields for negotiation abstracts, allowing custom data points at the summary level.
| Name | Type | Description |
| SupplierNegotiationsAuctionHeaderId [KEY] | Long | Unique identifier for the auction header, linking the DFF (Descriptive Flexfield) data to a specific auction event in the negotiation process. |
| AuctionHeaderId [KEY] | Long | Unique identifier for the auction header, helping to associate the descriptive flexfield (DFF) data with a particular auction. |
| _FLEX_Context | String | The context of the DFF, which defines the area or subject for which the flexfield is applicable, providing a classification for the data. |
| _FLEX_Context_DisplayValue | String | The display value of the flexfield context, representing a human-readable label or description of the context that is used to classify the data. |
| Finder | String | Search or query reference related to the SupplierNegotiationsabstractsDFF, used for filtering or looking up specific DFF records in the negotiation process. |
| EffectiveDate | Date | This query parameter is used to fetch resources that are effective as of the specified date, helping to retrieve records valid for a particular period. |
Holds reference documents (terms, supporting files) at the negotiation header, enriching the negotiation record.
| Name | Type | Description |
| SupplierNegotiationsAuctionHeaderId [KEY] | Long | Unique identifier for the auction header, linking the attachment data to a specific auction event in the negotiation process. |
| AttachedDocumentId [KEY] | Long | Unique identifier for the attachment, serving as the primary key for each document attached to the negotiation. |
| LastUpdateDate | Datetime | The date and time when the attachment record was last updated, providing a timestamp for the most recent modification. |
| LastUpdatedBy | String | The name or identifier of the person who last updated the attachment record, ensuring accountability for changes. |
| DatatypeCode | String | Abbreviation representing the data type of the attachment. Values may include 'FILE', 'FOLDER', 'TEXT', or 'WEB_PAGE'. |
| FileName | String | The name of the file associated with the attachment, providing a reference to the document. |
| DmFolderPath | String | The path in the document management system where the attachment is stored, helping to locate the document. |
| DmDocumentId | String | Unique identifier for the document in the document management system, enabling precise tracking and retrieval. |
| DmVersionNumber | String | Version number of the attached document, distinguishing between different versions of the same file. |
| Url | String | Uniform Resource Locator (URL) that identifies the location of the attachment, providing access to the file. |
| CategoryName | String | Category of the attachment, used to classify and group related documents for easier retrieval. |
| UserName | String | The username or identifier of the person associated with the attachment, indicating who uploaded or is managing the document. |
| Uri | String | Uniform Resource Identifier (URI) linking to the attachment, providing a consistent reference for the document. |
| FileUrl | String | URL for downloading the attachment, allowing users to access the file directly. |
| UploadedText | String | Text associated with the attachment, often used to describe the contents or context of the document. |
| UploadedFileContentType | String | The content type of the uploaded file, indicating its format. |
| UploadedFileLength | Long | Size of the uploaded file in bytes, indicating the file’s storage requirements. |
| UploadedFileName | String | The original name of the file when it was uploaded, typically retained for reference. |
| ContentRepositoryFileShared | Bool | Flag indicating whether the file is shared within the content repository. If true, the file is shared; if false, it is not. |
| Title | String | Title of the attachment, often summarizing the document’s contents or purpose. |
| Description | String | Description of the attachment, providing additional context or explanation of its relevance. |
| ErrorStatusCode | String | Code identifying the error, if any, associated with the attachment, helping to track issues. |
| ErrorStatusMessage | String | Message providing details of the error, if any, encountered during the attachment process. |
| CreatedBy | String | The name or identifier of the person who created the attachment record, ensuring accountability for data entry. |
| CreationDate | Datetime | The date and time when the attachment record was created, providing a timestamp for when the document was first added. |
| FileContents | String | The contents of the attachment, typically used for text-based documents to store raw text. |
| ExpirationDate | Datetime | The date when the attachment expires, specifying when the document is no longer valid or accessible. |
| LastUpdatedByUserName | String | The username of the individual who last updated the attachment, providing visibility into who made the most recent changes. |
| CreatedByUserName | String | The username of the individual who initially created the attachment record, indicating the origin of the document. |
| AsyncTrackerId | String | Identifier used to track the processing status of asynchronous tasks related to the attachment, such as file conversion or upload. |
| FileWebImage | String | URL or path to an image representing the file in web interfaces, often used as a thumbnail or preview of the document. |
| DownloadInfo | String | JSON object containing metadata and information needed to programmatically retrieve the attachment file. |
| PostProcessingAction | String | The action that is triggered after an attachment is uploaded, such as validation, categorization, or further processing. |
| AuctionHeaderId | Long | Unique identifier for the auction header, linking the attachment data to a specific auction event. |
| Finder | String | Search or query reference related to the SupplierNegotiationsattachments, used for filtering or looking up specific attachment records. |
| EffectiveDate | Date | This query parameter is used to fetch resources that are effective as of the specified date, ensuring the retrieved records are relevant for the requested period. |
Identifies internal team members collaborating on the negotiation, specifying roles (for example, evaluator, observer).
| Name | Type | Description |
| SupplierNegotiationsAuctionHeaderId [KEY] | Long | Unique identifier for the auction header, linking the collaboration team member data to a specific auction event in the negotiation. |
| TeamMemberId [KEY] | Decimal | Unique identifier for each team member involved in the collaboration, enabling precise tracking of team participation. |
| LastNotifiedDate | Datetime | The date and time when the collaboration team member was last notified, providing a timestamp for the most recent communication sent to the member. |
| PersonId | Long | Unique identifier for the person assigned to the collaboration team, helping to track the individual participating in the negotiation. |
| TeamMember | String | Name of the collaboration team member, identifying the person involved in the negotiation process. |
| AccessCode | String | Abbreviation that identifies the access level granted to the team member. Values include 'FULL' or 'VIEW_ONLY', determining the level of interaction the team member has with the negotiation. |
| Access | String | Describes the level of access granted to the collaboration team member, such as 'Full' for complete access or 'View Only' for limited visibility, based on predefined settings. |
| PriceVisibilityFlag | Bool | Flag indicating whether the team member has visibility into price details during the evaluation process. If true, the member can view prices; if false, they cannot. The default value is true. |
| SupplierMessagesCode | String | Abbreviation that specifies the access level to message suppliers for each team member. Options include 'ORA_NO_ACCESS', 'ORA_RECEIVE_ONLY', or 'ORA_SEND_AND_RECEIVE', controlling the member's ability to interact with suppliers. |
| SupplierMessages | String | Describes the level of access the team member has to send or receive messages from suppliers, with options such as 'No access', 'Receive only', or 'Send and receive'. |
| TaskName | String | The name or title of the task assigned to the collaboration team member, indicating the specific responsibility or action they need to complete. |
| TaskTargetDate | Date | The target date when the application expects the collaboration team member to complete the assigned task, helping to track progress and deadlines. |
| TaskCompletionDate | Datetime | The actual date and time when the collaboration team member completed the task, providing a timestamp for when the work was finished. |
| CreatedBy | String | The name or identifier of the person who created the collaboration team member record, ensuring accountability for data entry. |
| CreationDate | Datetime | The date and time when the collaboration team member record was created, marking the initial addition of the member to the system. |
| LastUpdateDate | Datetime | The date and time when the collaboration team member record was last updated, providing a timestamp for the most recent changes. |
| LastUpdatedBy | String | The name or identifier of the person who last updated the collaboration team member record, ensuring accountability for changes made. |
| ScoringTeamNames | String | The names of the team members responsible for scoring the responses, listing the individuals involved in the evaluation process. |
| AuctionHeaderId | Long | Unique identifier for the auction header, linking the collaboration team data to a specific auction event in the system. |
| Finder | String | Search or query reference used for filtering or locating specific collaboration team member records in the negotiation process. |
| EffectiveDate | Date | This query parameter is used to fetch resources that are effective as of the specified date, ensuring that only relevant data for the given period is retrieved. |
Employs internal descriptive flexfields at the negotiation header level, adding fields for specialized data capture.
| Name | Type | Description |
| SupplierNegotiationsAuctionHeaderId [KEY] | Long | Unique identifier for the auction header, linking the descriptive flexfield (DFF) data to a specific negotiation event. |
| AuctionHeaderId [KEY] | Long | Unique identifier for the negotiation, which is used to track and reference the specific negotiation instance. The supplier cannot view this flexfield. |
| _FLEX_Context | String | The context name for the DFF, which provides a classification for the flexfield data, such as details about the negotiation lines. The supplier cannot view this flexfield. |
| _FLEX_Context_DisplayValue | String | Display value of the DFF context, which provides a human-readable label or description for the flexfield context. This field is not visible to the supplier. |
| Finder | String | Search or query reference used to locate or filter specific records related to the SupplierNegotiationsDFF, helping in the retrieval of relevant data. |
| EffectiveDate | Date | The date when the DFF data becomes effective, ensuring that only records valid as of the specified date are retrieved in queries. |
Details products and services being sourced in the negotiation, including specifications, baseline pricing, or quantity.
| Name | Type | Description |
| SupplierNegotiationsAuctionHeaderId [KEY] | Long | Unique identifier for the auction header, linking the negotiation line data to a specific auction event in the negotiation process. |
| AuctionHeaderId [KEY] | Long | Unique identifier for the auction event, linking the specific negotiation lines to the overall negotiation event. |
| LineId [KEY] | Decimal | Unique identifier for each negotiation line, helping to track the specific details of a line in the negotiation. |
| Line | String | The number that identifies the specific negotiation line, which helps to differentiate between various lines within the negotiation. |
| ParentLine | String | The number identifying a parent line in the negotiation, indicating whether the line belongs to a group or lot, and referencing an existing parent line in the negotiation. |
| Requisition | String | Requisition number associated with the negotiation line, providing a reference to the purchase request that initiated the negotiation. |
| RequisitionLine | String | Requisition line number associated with the specific line of the negotiation, linking it to the corresponding line in the requisition. |
| SourceAgreement | String | The source agreement that the current negotiation line is based on, used to track any renegotiation or reference to an existing agreement. |
| SourceAgreementLine | String | The source agreement line number that corresponds to the negotiation line, linking it to the original agreement. |
| LineCloseDate | Datetime | Date and time when the negotiation line closes, marking the end of the negotiation period for that specific line in a staggered or extended negotiation. |
| SequenceNumber | Int | Number specifying the order in which lines are added to the negotiation using a web service, providing a sequence for the negotiation lines. |
| ParentSequenceNumber | Int | Sequence number of the parent line to which a child line is added, helping to organize lines hierarchically in groups or lots. |
| GroupType | String | Type of negotiation line, such as line, group, group line, lot, or lot line, categorizing the line type. A list of accepted values is defined in the lookup type Negotiation Line Type. |
| GroupTypeCode | String | Abbreviation identifying the type of negotiation line, such as line, group, group line, lot, or lot line, used for classification in the negotiation process. |
| PriceAndQuantityEnabledFlag | Bool | Flag indicating whether each RFI (request for information) line can include price and quantity details. If true, price and quantity are allowed; if false, they are not. |
| UnitTargetPrice | Decimal | Preferred price that the procurement organization aims to pay for the negotiation line, excluding any cost factors. |
| DisplayUnitTargetPriceFlag | Bool | Flag indicating whether the supplier can view the unit target price. If true, the supplier can see the target price; if false, they cannot. |
| LineDescription | String | A description of the negotiation line, providing additional details or context for the specific line in the negotiation. |
| RequisitioningBU | String | The name of the requisition business unit that acts as a client to the procurement business unit handling the negotiation. |
| RequisitioningBUId | Long | Unique identifier for the requisition business unit associated with the negotiation line, linking it to the procurement organization. |
| LineType | String | The name of the line type, indicating whether the line is for items or services. A list of accepted values is defined in the lookup type ORDER TYPE. |
| LineTypeId | Long | Unique identifier for the line type, indicating whether the line represents items or services in the negotiation. |
| Item | String | Name of the inventory item associated with the negotiation line, identifying the specific goods or services being negotiated. |
| ItemId | Long | Unique identifier for the inventory item, used to track and reference the item within the negotiation. |
| ItemRevision | String | The revision number of the inventory item associated with the negotiation line, providing version control for item specifications. |
| CategoryName | String | The name of the purchasing category associated with the negotiation line, categorizing the item or service for procurement purposes. |
| CategoryId | Long | Unique identifier for the purchasing category associated with the negotiation line, linking the item or service to the relevant category. |
| Quantity | Decimal | Quantity of the item in the negotiation line, representing the amount being negotiated for procurement. |
| EstimatedQuantity | Decimal | Estimated quantity of the item in the negotiation line, providing a projection of the required amount. |
| UOM | String | Unit of measure for the item in the negotiation line, specifying the standard measurement for quantity (for example, 'each', 'kg'). |
| UOMCode | String | Abbreviation identifying the unit of measure for the item in the negotiation line, offering a compact reference for the measurement unit. |
| ShipToLocation | String | The name of the location where the item will be shipped, or where the negotiated service will be performed, specifying the destination. |
| ShipToLocationId | Long | Unique identifier for the location where the item will be shipped, used to track and reference the delivery point. |
| RequestedDeliveryDate | Date | Date when the application requests that the item or service is delivered, providing the expected timeline for delivery. |
| RequestedShipDate | Date | Date when the application requests that the item is shipped, specifying the desired shipping date. |
| CurrentPrice | Decimal | Current price that the procurement organization is paying for the item or service, representing the agreed-upon cost in the negotiation. |
| TargetPrice | Decimal | The price that the procurement organization prefers to pay for the negotiation line, guiding the negotiation strategy. |
| DisplayTargetPriceFlag | Bool | Flag indicating whether the supplier can view the target price for the negotiation line. If true, the supplier can see the target price; if false, they cannot. |
| ResponseRevisionLineDecrementValue | Decimal | The minimum amount or percentage by which the line price must be reduced in each revised response, helping to track price adjustments. |
| StartPrice | Decimal | The highest price allowed for the supplier to enter in response to the negotiation line, providing an upper limit for the pricing. |
| RetainageRate | Decimal | Percentage of the amount requested that will be withheld before payments are released to the contractor, typically used to ensure completion. |
| MaximumRetainageAmount | Decimal | The maximum amount of retainage that can be withheld for the negotiation line, specifying the financial cap for withheld amounts. |
| NoteToSuppliers | String | A note to suppliers, providing additional instructions, information, or context related to the negotiation line. |
| AllowAlternateLinesFlag | Bool | Flag indicating whether the supplier can create alternate response lines for each negotiation line. If true, alternate lines are allowed; if false, they are not. |
| EstimatedTotalAmount | Decimal | Estimated total amount for the service or item in the negotiation line, providing a financial projection for the entire line. |
| MinimumReleaseAmount | Decimal | The minimum amount in any purchase order line that can be released for the purchase agreement, establishing the smallest allowed release value. |
| PriceBreakType | String | Type of price break applied to the negotiation line, specifying how price breaks are calculated (for example, single purchase order or cumulative across orders). |
| PriceBreakTypeCode | String | Code identifying the type of price break applied, such as 'CUMULATIVE' or 'NON-CUMULATIVE', determining how price reductions are applied. |
| SuppliersCanModifyPriceBreaksFlag | Bool | Flag indicating whether suppliers can modify price breaks set by the procurement organization. If true, modification is allowed; if false, it is not. |
| CreationDate | Datetime | The date and time when the negotiation line record was created, providing a timestamp for when the data was entered. |
| CreatedBy | String | The name or identifier of the person who created the negotiation line record, ensuring accountability for data entry. |
| LastUpdateDate | Datetime | The date and time when the negotiation line record was last updated, providing a timestamp for the most recent changes. |
| LastUpdatedBy | String | The name or identifier of the person who last updated the negotiation line record, ensuring accountability for changes made. |
| Finder | String | Search or query reference used for locating or filtering specific negotiation line records in the system. |
| EffectiveDate | Date | This query parameter is used to fetch resources that are effective as of the specified date, ensuring that only relevant data for the given period is retrieved. |
Manages line-level attachments (drawings, product sheets) for negotiation lines, ensuring clarity in requested goods or services.
| Name | Type | Description |
| SupplierNegotiationsAuctionHeaderId [KEY] | Long | Unique identifier for the auction header, linking the attachment data to a specific auction event in the negotiation process. |
| LinesAuctionHeaderId [KEY] | Long | Unique identifier for the auction header related to the specific negotiation line attachment, helping to track the attachment in the context of the line. |
| LinesLineId [KEY] | Decimal | Unique identifier for the negotiation line associated with the attachment, helping to link the document to a specific line in the negotiation. |
| AttachedDocumentId [KEY] | Long | Primary key identifying the attachment, uniquely assigned by the system when the user attaches a document to a negotiation line. |
| LastUpdateDate | Datetime | The date and time when the attachment record was last updated, providing a timestamp for the most recent change to the record. |
| LastUpdatedBy | String | The username or identifier of the user who last updated the attachment record, ensuring accountability for changes made. |
| DatatypeCode | String | Abbreviation identifying the data type of the attachment. Accepted values include 'FILE', 'FOLDER', 'TEXT', or 'WEB_PAGE', specifying the format or type of the attachment. |
| FileName | String | The name of the file associated with the attachment, providing a reference to the document. |
| DmFolderPath | String | The folder path in the document management system (DMS) where the attachment is stored, helping to locate the document within the system. |
| DmDocumentId | String | Unique identifier for the document in the document management system, ensuring precise tracking and retrieval of the attached file. |
| DmVersionNumber | String | Version number of the attached document, used for version control and to track different versions of the same document. |
| Url | String | URI (Uniform Resource Identifier) linking to the attachment, providing a consistent reference for accessing the document. |
| CategoryName | String | The category to which the attachment belongs, providing a way to classify and group related documents. |
| UserName | String | The login credentials of the user who created the attachment record, tracking who uploaded the file. |
| Uri | String | URI (Uniform Resource Identifier) that uniquely identifies the attachment, offering a consistent reference for the document across systems. |
| FileUrl | String | The URL of the attachment, used to access or download the file directly from the system. |
| UploadedText | String | Text content associated with the attachment, often used to describe the document or provide additional context. |
| UploadedFileContentType | String | The content type of the uploaded file, indicating its format. |
| UploadedFileLength | Long | The length of the attached file in bytes, providing information on the file size. |
| UploadedFileName | String | The original file name when the attachment was uploaded, typically retained for reference. |
| ContentRepositoryFileShared | Bool | Flag indicating whether the attachment is shared within the content repository. If true, the file is shared; if false, it is not. |
| Title | String | The title of the attachment, summarizing the contents or purpose of the document. |
| Description | String | A description of the attachment, providing additional context or details about the content of the document. |
| ErrorStatusCode | String | Code identifying any errors associated with the attachment, helping to track issues during the attachment process. |
| ErrorStatusMessage | String | Message providing details about the error, if any, encountered during the attachment process. |
| CreatedBy | String | The name or identifier of the user who created the attachment record, ensuring accountability for the data entry. |
| CreationDate | Datetime | The date and time when the attachment record was created, marking when the document was initially added to the system. |
| FileContents | String | The contents of the attachment, typically used for text-based documents to store raw text data. |
| ExpirationDate | Datetime | The date when the contents of the attachment expire, indicating when the document is no longer valid or accessible. |
| LastUpdatedByUserName | String | The username of the person who last updated the attachment record, providing visibility into who made the most recent changes. |
| CreatedByUserName | String | The username of the person who created the attachment record, indicating who initially uploaded the document. |
| AsyncTrackerId | String | An identifier used to track the status of asynchronous tasks related to the attachment, such as file processing or conversion. |
| FileWebImage | String | Base64 encoded image of the file, displayed in .png format if the attachment is a convertible image, providing a visual preview of the document. |
| DownloadInfo | String | JSON object represented as a string, containing metadata and information used to programmatically retrieve the file attachment. |
| PostProcessingAction | String | Name of the action that can be performed after the attachment is uploaded, such as categorization or further processing. |
| AuctionHeaderId | Long | Unique identifier for the auction header, linking the attachment data to a specific auction event. |
| Finder | String | Search or query reference used for locating or filtering specific attachment records within the system. |
| EffectiveDate | Date | This query parameter is used to fetch resources that are effective as of the specified date, ensuring that only relevant data for the given period is retrieved. |
Tracks cost factors (transport, warranty, extras) at the negotiation line level, influencing total evaluated cost.
| Name | Type | Description |
| SupplierNegotiationsAuctionHeaderId [KEY] | Long | Unique identifier for the auction header, linking the cost factor data to a specific auction event in the negotiation. |
| LinesAuctionHeaderId [KEY] | Long | Unique identifier for the auction header related to the negotiation line cost factor, helping to track the cost factor within the context of the line. |
| LinesLineId [KEY] | Decimal | Unique identifier for the negotiation line associated with the cost factor, helping to link the cost factor to a specific line in the negotiation. |
| AuctionHeaderId [KEY] | Long | Unique identifier for the auction event, associating the cost factor to the overall auction process. |
| LineId [KEY] | Decimal | Unique identifier for the negotiation line, ensuring that the cost factor is linked to the correct negotiation line. |
| Line | Double | Numeric value identifying the negotiation line, which helps to reference the line in the context of the cost factor. |
| LineDescription | String | Description of the negotiation line associated with the cost factor, providing additional context for the specific line. |
| LineCostFactorId [KEY] | Decimal | Unique identifier for the specific cost factor associated with the negotiation line, helping to track the cost elements within the negotiation. |
| Description | String | Detailed description of the cost factor, explaining its nature and how it affects the negotiation line. |
| CostFactorId | Long | Unique identifier for the cost factor, allowing the application to track and manage different cost elements. |
| CostFactor | String | Name of the cost factor, providing a label for the cost element that influences the negotiation line. |
| PricingBasisCode | String | Abbreviation identifying the basis used to calculate the cost factor, helping to define how the cost is derived. Values include different pricing models defined in the lookup type PON_PRICING_BASIS. |
| PricingBasis | String | The method used to calculate the cost factor, specifying the basis on which the cost is determined. This value corresponds to the list of accepted pricing bases in the lookup type PON_PRICING_BASIS. |
| TargetValue | Decimal | The target value for the cost factor, representing the intended value that the cost factor should aim for in the negotiation. |
| DisplayTargetFlag | Bool | Flag indicating whether the supplier can view the target value for the cost factor. If true, the supplier can see the target value; if false, they cannot. The default value is false. |
| Finder | String | Search or query reference used for locating or filtering specific cost factor records within the system, aiding in the retrieval of relevant data. |
| EffectiveDate | Date | The date when the cost factor data becomes effective, ensuring that only records valid as of the specified date are retrieved in queries. |
Uses descriptive flexfields for negotiation lines, capturing additional data beyond standard fields.
| Name | Type | Description |
| SupplierNegotiationsAuctionHeaderId [KEY] | Long | Unique identifier for the auction header, linking the descriptive flexfield (DFF) data to a specific negotiation event. |
| LinesAuctionHeaderId [KEY] | Long | Unique identifier for the auction header related to the negotiation line, allowing the system to associate flexfield data with a specific line within the auction. |
| LinesLineId [KEY] | Decimal | Unique identifier for the negotiation line associated with the DFF, helping to track flexfield data specific to each line in the negotiation. |
| AuctionHeaderId [KEY] | Long | Value that uniquely identifies the negotiation event, providing a reference to the auction associated with the negotiation. This flexfield is not visible to the supplier. |
| LineNumber [KEY] | Decimal | Number that identifies the specific negotiation line within the auction, used for referencing and organizing lines. This flexfield is not visible to the supplier. |
| _FLEX_Context | String | The context name for the DFF, which categorizes the data for specific details about the negotiation lines. This field is not visible to the supplier. |
| _FLEX_Context_DisplayValue | String | The display value of the flexfield context, providing a human-readable label or description. This field is not visible to the supplier. |
| Finder | String | Search or query reference used for locating or filtering specific DFF records related to negotiation lines within the system. |
| EffectiveDate | Date | The date when the DFF data becomes effective, ensuring that only valid records as of the specified date are retrieved. |
Defines attribute groups for negotiation lines, grouping characteristic sets for more complex products or services.
| Name | Type | Description |
| SupplierNegotiationsAuctionHeaderId [KEY] | Long | Unique identifier for the auction header, linking the attribute group data to a specific auction event in the negotiation. |
| LinesAuctionHeaderId [KEY] | Long | Unique identifier for the auction header related to the negotiation line attribute group, allowing the system to associate the group with a specific auction event. |
| LinesLineId [KEY] | Decimal | Unique identifier for the negotiation line associated with the attribute group, helping to track and manage the group data in the context of the line. |
| AuctionHeaderId | Long | Unique identifier for the auction, linking the negotiation line attribute group data to the overall auction event. |
| LineId | Decimal | Unique identifier for the negotiation line, associating the attribute group with a specific line in the negotiation. |
| Line | String | Number that identifies the negotiation line associated with the attribute group, helping to reference the group within the context of the line. |
| LineDescription | String | Description of the negotiation line associated with the attribute group, providing additional context for the specific line. |
| GroupId [KEY] | Long | Unique identifier for the attribute group, helping to track and manage groups of related attributes within the negotiation. |
| GroupName | String | Name of the attribute group, used to classify and organize different attributes for easier management and referencing. |
| CreationDate | Datetime | The date and time when the attribute group record was created, marking the initial entry of the group into the system. |
| CreatedBy | String | The name or identifier of the person who created the attribute group record, ensuring accountability for data entry. |
| LastUpdateDate | Datetime | The date and time when the attribute group record was last updated, providing a timestamp for the most recent changes to the group. |
| LastUpdatedBy | String | The name or identifier of the person who last updated the attribute group record, ensuring accountability for modifications. |
| Finder | String | Search or query reference used for locating or filtering specific attribute group records in the negotiation process. |
| EffectiveDate | Date | This query parameter is used to fetch resources that are effective as of the specified date, ensuring that only valid records for the given period are retrieved. |
Lists each distinct attribute within a line attribute group, giving evaluators granular insight into supplier bids.
| Name | Type | Description |
| SupplierNegotiationsAuctionHeaderId [KEY] | Long | Unique identifier for the auction header, linking the line attribute group data to a specific auction event in the negotiation. |
| LinesAuctionHeaderId [KEY] | Long | Unique identifier for the auction header related to the negotiation line attribute group, ensuring the system associates the attributes with the correct auction. |
| LinesLineId [KEY] | Decimal | Unique identifier for the negotiation line associated with the attribute group, allowing for precise tracking and management of attributes linked to the negotiation line. |
| AuctionHeaderId [KEY] | Long | Unique identifier for the auction, which associates the line attribute data to the overall auction event. |
| LineId [KEY] | Decimal | Unique identifier for the negotiation line, linking the line attribute group to a specific line in the negotiation process. |
| Line | String | The number identifying the negotiation line associated with the attribute group, helping to organize and track the line attributes. |
| LineDescription | String | Description of the negotiation line associated with the attribute group, providing additional context for the specific line in the negotiation. |
| GroupId | Long | Unique identifier for the attribute group, which helps to categorize and manage related attributes in the negotiation line. |
| GroupName | String | The name of the attribute group, used to classify and organize different line attributes for easier management and referencing. |
| AttributeId [KEY] | Decimal | Unique identifier for the specific attribute within the attribute group, ensuring the precise tracking of individual attributes in the negotiation. |
| AttributeName | String | The name of the attribute, providing a label for the specific attribute in the negotiation line. |
| ResponseType | String | Specifies the required response type for the line attribute. Valid values include 'required', 'optional', or 'not needed', as defined in the lookup type PON_ATTRIBUTE_RESPONSE_TYPE. |
| ResponseTypeCode | String | Abbreviation identifying whether the response for the line attribute is required. Valid values are 'REQUIRED', 'OPTIONAL', and 'DISPLAY_ONLY', as defined in the lookup type PON_ATTRIBUTE_RESPONSE_TYPE. |
| ValueType | String | Display name of the data type for the attribute response, such as 'text', 'number', 'date', or 'URL'. A list of accepted values is defined in the lookup type Attribute Value Type. |
| ValueTypeCode | String | Abbreviation identifying the type of value for the attribute response. Valid values are 'TXT', 'NUM', 'DAT', and 'URL', as defined in the lookup type PON_AUCTION_ATTRIBUTE_TYPE. |
| TargetDateValue | Date | Target date value for the attribute, representing the preferred or desired date associated with the attribute. |
| TargetNumberValue | Decimal | Target number value for the attribute, representing the preferred or desired numeric value for the attribute. |
| TargetTextValue | String | Target text or URL value for the attribute, representing the preferred or desired textual or URL response. |
| DisplayTargetFlag | Bool | Flag indicating whether the supplier can view the target value for the attribute. If true, the supplier can see the target value; if false, they cannot. The default value is false. |
| Weight | Decimal | The weight of the line attribute, indicating its importance relative to other line attributes when calculating the total line score. |
| CreationDate | Datetime | The date and time when the attribute group record was created, marking the initial entry of the attribute group into the system. |
| CreatedBy | String | The name or identifier of the person who created the attribute group record, ensuring accountability for data entry. |
| LastUpdateDate | Datetime | The date and time when the attribute group record was last updated, providing a timestamp for the most recent changes. |
| LastUpdatedBy | String | The name or identifier of the person who last updated the attribute group record, ensuring accountability for modifications. |
| acceptableResponseScoreValues | String | The range of acceptable scores for responses to the attribute, indicating what values are considered acceptable for scoring purposes. |
| Finder | String | Search or query reference used for locating or filtering specific attribute group records within the negotiation process. |
| EffectiveDate | Date | This query parameter is used to fetch resources that are effective as of the specified date, ensuring that only relevant data for the given period is retrieved. |
Identifies recommended suppliers for a specific negotiation line, guiding targeted invitations or shortlisting.
| Name | Type | Description |
| SupplierNegotiationsAuctionHeaderId [KEY] | Long | Unique identifier for the auction header, linking the supplier recommendation data to a specific auction event in the negotiation process. |
| LinesAuctionHeaderId [KEY] | Long | Unique identifier for the auction header related to the negotiation line, helping to track supplier recommendations within the context of the auction. |
| LinesLineId [KEY] | Decimal | Unique identifier for the negotiation line associated with the supplier recommendation, ensuring precise tracking of supplier data for each line. |
| LineSuppRecommId [KEY] | Long | Unique identifier for the supplier recommendation associated with the negotiation line, allowing for the specific identification of recommended suppliers. |
| AuctionHeaderId | Long | Unique identifier for the auction, linking the recommended supplier data to the overall auction event. |
| LineNumber | Decimal | Number identifying the negotiation line associated with the recommended supplier, helping to organize and track the recommendations per line in the negotiation. |
| SupplierName | String | Name of the supplier being recommended for the negotiation line, providing clear identification of the supplier in the recommendation. |
| SupplierId | Long | Unique identifier for the supplier, helping to track the specific supplier that is being recommended for the negotiation. |
| SupplierSiteName | String | Name of the supplier's site associated with the recommendation, specifying the location from which the supplier operates. |
| AiScore | Decimal | The AI-generated score assigned to the supplier for the negotiation line, helping to evaluate the supplier's fit for the line based on algorithmic analysis. |
| SupplierScenario1Count | Long | Count of scenario 1 responses from the supplier, helping to track supplier performance in different negotiation scenarios. |
| SupplierSiteId | Long | Unique identifier for the supplier site, ensuring precise tracking of the supplier's location and its association with the recommendation. |
| SupplierScenario5Count | Long | Count of scenario 5 responses from the supplier, tracking how many responses the supplier has in this scenario. |
| SupplierScenario4Count | Long | Count of scenario 4 responses from the supplier, tracking how many responses the supplier has in this scenario. |
| SupplierScenario3Count | Long | Count of scenario 3 responses from the supplier, helping to track the supplier’s performance in different negotiation conditions. |
| SupplierScenario2Count | Long | Count of scenario 2 responses from the supplier, indicating how the supplier has responded to specific conditions. |
| Finder | String | Search or query reference used for locating or filtering specific supplier recommendation records within the system. |
| EffectiveDate | Date | This query parameter is used to fetch resources that are effective as of the specified date, ensuring only valid records are retrieved for the given period. |
Stores line-level price break data (volume discounts, date-based pricing) to refine cost evaluations.
| Name | Type | Description |
| SupplierNegotiationsAuctionHeaderId [KEY] | Long | Unique identifier for the auction header, linking the price break data to a specific auction event in the negotiation process. |
| LinesAuctionHeaderId [KEY] | Long | Unique identifier for the auction header related to the negotiation line price break, ensuring the system associates the price break with the correct auction. |
| LinesLineId [KEY] | Decimal | Unique identifier for the negotiation line associated with the price break, helping to track and manage the price break for a specific line. |
| AuctionHeaderId [KEY] | Long | Unique identifier for the auction, linking the price break data to the overall auction event in the negotiation. |
| LineId [KEY] | Decimal | Unique identifier for the negotiation line, associating the price break data with a specific line in the negotiation. |
| Line | String | Number identifying the negotiation line, used to track and organize the price break in the context of the specific line. |
| LineDescription | String | Description of the negotiation line associated with the price break, providing additional context for the specific line in the negotiation. |
| PriceBreakId [KEY] | Decimal | Unique identifier for the price break, allowing for tracking and management of the specific price break in the negotiation process. |
| ShipToOrganizationId | Long | Unique identifier for the inventory organization where the supplier ships the item, helping to track shipping details related to the price break. |
| ShipToOrganization | String | Name of the inventory organization where the supplier ships the item, helping to specify the location involved in the price break. |
| ShipToLocationId | Long | Unique identifier for the location where the supplier ships the item, tracking the shipping details of the price break. |
| ShipToLocation | String | Name of the location where the supplier ships the item, helping to specify the receiving location involved in the price break. |
| Quantity | Decimal | The quantity involved in the price break, determining the volume or amount eligible for the price adjustment. |
| TargetPrice | Decimal | The target price for the price break, indicating the price the procurement organization aims to achieve under the terms of the price break. |
| PriceBreakStartDate | Date | The date when the price break becomes effective, marking the start of the period when the price break applies. |
| PriceBreakEndDate | Date | The date when the price break expires, indicating the end of the period during which the price break is valid. |
| CreatedBy | String | The name or identifier of the user who created the price break record, ensuring accountability for data entry. |
| CreationDate | Datetime | The date and time when the price break record was created, marking the initial entry of the price break into the system. |
| LastUpdatedBy | String | The name or identifier of the user who last updated the price break record, ensuring accountability for modifications. |
| LastUpdateDate | Datetime | The date and time when the price break record was last updated, providing a timestamp for the most recent changes to the record. |
| Finder | String | Search or query reference used for locating or filtering specific price break records within the system. |
| EffectiveDate | Date | This query parameter is used to fetch resources that are effective as of the specified date, ensuring that only relevant price break records for the given period are retrieved. |
Holds quantity-based pricing tiers for negotiation lines, capturing cost variations that apply once certain purchase thresholds are reached.
| Name | Type | Description |
| SupplierNegotiationsAuctionHeaderId [KEY] | Long | Unique identifier for the auction header, linking the price tier data to a specific auction event in the negotiation process. |
| LinesAuctionHeaderId [KEY] | Long | Unique identifier for the auction header related to the negotiation line price tier, ensuring the system associates the price tier with the correct auction. |
| LinesLineId [KEY] | Decimal | Unique identifier for the negotiation line associated with the price tier, allowing for the precise tracking and management of price tiers per negotiation line. |
| AuctionHeaderId [KEY] | Long | Unique identifier for the auction, linking the price tier data to the overall auction event in the negotiation. |
| LineId [KEY] | Decimal | Unique identifier for the negotiation line, associating the price tier data with a specific line in the negotiation process. |
| Line | String | Number identifying the negotiation line associated with the price tier, helping to track and organize the price tier within the context of the line. |
| LineDescription | String | Description of the negotiation line associated with the price tier, providing additional context for the specific line. |
| PriceTierId [KEY] | Decimal | Unique identifier for the price tier, helping to track and manage the specific price tier in the negotiation process. |
| MinimumQuantity | Decimal | The lowest quantity limit for the price tier, specifying the minimum quantity required to qualify for this particular price tier. |
| MaximumQuantity | Decimal | The highest quantity limit for the price tier, specifying the maximum quantity allowed within this tier. |
| TargetPrice | Decimal | The target price for the price tier, representing the desired price for the specified quantity range in the negotiation. |
| CreatedBy | String | The name or identifier of the user who created the price tier record, ensuring accountability for the data entry. |
| CreationDate | Datetime | The date and time when the price tier record was created, marking the initial entry of the price tier into the system. |
| LastUpdatedBy | String | The name or identifier of the user who last updated the price tier record, ensuring accountability for modifications. |
| LastUpdateDate | Datetime | The date and time when the price tier record was last updated, providing a timestamp for the most recent changes to the record. |
| Finder | String | Search or query reference used for locating or filtering specific price tier records within the system. |
| EffectiveDate | Date | This query parameter is used to fetch resources that are effective as of the specified date, ensuring that only relevant price tier records for the given period are retrieved. |
Lists the sourcing activities (for example, approvals, messages, updates) performed within a negotiation’s lifecycle.
| Name | Type | Description |
| SupplierNegotiationsAuctionHeaderId [KEY] | Long | Unique identifier for the auction header, linking the activity data to a specific auction event in the negotiation process. |
| ActivityPersonId | Long | Unique identifier for the person associated with the activity, helping to track which person performed the activity in the negotiation. |
| ActivityTime | Datetime | The date and time when the activity occurred, providing a timestamp for the activity in the context of the negotiation. |
| AuctionHeaderId [KEY] | Long | Unique identifier for the auction, linking the activity data to the overall auction event in the negotiation process. |
| AuditId [KEY] | Long | Unique identifier for the audit record, ensuring that each activity is traceable and accountable for compliance and record-keeping. |
| Activity | String | Description of the specific activity performed during the negotiation, helping to provide context for the actions taken in the negotiation process. |
| PersonName | String | Name of the person who performed the activity, providing identification of the individual responsible for the action. |
| DisplayPhoneNumber | String | Phone number of the person who performed the activity, made visible for communication purposes related to the activity. |
| EmailAddress | String | Email address of the person who performed the activity, providing a contact method for follow-up regarding the activity. |
| DisplayName | String | Display name of the person associated with the activity, showing how the person is identified in the system or for reporting purposes. |
| DocumentNumber | String | Unique identifier for the document associated with the activity, providing a reference number for the related document in the negotiation process. |
| Finder | String | Search or query reference used for locating or filtering specific negotiation activity records within the system. |
| EffectiveDate | Date | This query parameter is used to fetch resources that are effective as of the specified date, ensuring that only valid records for the given period are retrieved. |
Marks suppliers that are preselected or recommended for a negotiation, streamlining invitations and bid evaluations.
| Name | Type | Description |
| SupplierNegotiationsAuctionHeaderId [KEY] | Long | Unique identifier for the auction header, linking the recommended supplier data to a specific auction event in the negotiation process. |
| SupplierId | Long | Unique identifier for the supplier, allowing the system to track the specific supplier being recommended for the negotiation. |
| SupplierSiteId | Long | Unique identifier for the supplier's site, ensuring precise tracking of the site associated with the recommended supplier. |
| AiScore | Decimal | AI-generated score assigned to the supplier, helping to evaluate the supplier’s suitability based on algorithmic analysis for the negotiation. |
| NumberOfLinesCovered | Long | Number of negotiation lines covered by the recommended supplier, indicating the scope of the supplier’s involvement in the negotiation. |
| BestMatch | String | Indicates whether the supplier is the best match for the negotiation, based on the criteria and evaluation of their responses. |
| AuctionHeaderId | Long | Unique identifier for the auction, linking the recommended supplier data to the overall auction event. |
| HeaderSuppRecommId [KEY] | Long | Unique identifier for the header-level supplier recommendation, helping to track the recommendation at the header level in the negotiation process. |
| SupplierName | String | The name of the supplier being recommended for the negotiation, providing clear identification of the supplier. |
| SupplierSiteName | String | Name of the supplier’s site associated with the recommendation, specifying the location from which the supplier operates. |
| Finder | String | Search or query reference used for locating or filtering specific supplier recommendation records within the system. |
| EffectiveDate | Date | This query parameter is used to fetch resources that are effective as of the specified date, ensuring that only valid records for the given period are retrieved. |
Specifies the currencies accepted for negotiation responses, along with exchange rates to normalize bids against the negotiation currency.
| Name | Type | Description |
| SupplierNegotiationsAuctionHeaderId [KEY] | Long | Unique identifier for the auction header, linking the response currency data to a specific auction event in the negotiation process. |
| AuctionHeaderId [KEY] | Long | Unique identifier for the auction, helping to associate the response currency data with the overall auction event. |
| ResponseCurrencyId [KEY] | Decimal | Unique identifier for the response currency, allowing precise tracking and management of the specific currency used for responses in the negotiation. |
| ResponseCurrencyCode | String | Code representing the response currency, used to identify the currency type used by the supplier in their response. |
| ResponseCurrency | String | Name of the response currency, providing a clear identification of the currency used by the supplier in their response. |
| ResponseCurrencyDescription | String | Description of the response currency, providing additional context or information about the currency type used. |
| ConversionRate | Decimal | Conversion rate used to convert the response currency into the negotiation currency, ensuring accurate financial comparisons and calculations. |
| PricePrecision | Decimal | Number of decimal places that the application uses to display the price for the response currency, ensuring accurate price representation. |
| NegotiationCurrencyCode | String | Code representing the negotiation currency, helping to specify the currency that the negotiation is based on. |
| CreatedBy | String | The name or identifier of the user who created the response currency record, ensuring accountability for data entry. |
| CreationDate | Datetime | The date and time when the response currency record was created, marking the initial entry of the currency data into the system. |
| LastUpdateDate | Datetime | The date and time when the response currency record was last updated, providing a timestamp for the most recent changes. |
| LastUpdatedBy | String | The name or identifier of the user who last updated the response currency record, ensuring accountability for modifications. |
| Finder | String | Search or query reference used for locating or filtering specific response currency records within the system. |
| EffectiveDate | Date | This query parameter is used to fetch resources that are effective as of the specified date, ensuring that only relevant records for the given period are retrieved. |
Defines teams responsible for evaluating or scoring suppliers’ bids, including their assigned negotiation roles.
| Name | Type | Description |
| SupplierNegotiationsAuctionHeaderId [KEY] | Long | Unique identifier for the auction header, linking the scoring team data to a specific auction event in the negotiation process. |
| AuctionHeaderId [KEY] | Long | Unique identifier for the auction, helping to associate the scoring team data with the overall auction event. |
| DisplaySequenceNumber | Decimal | Sequence number used to determine the display order of scoring teams, ensuring the teams are presented in the correct order during the negotiation. |
| ScoringTeamId [KEY] | Long | Unique identifier for the scoring team, allowing precise tracking and management of the team responsible for evaluating the negotiation. |
| ScoringTeam | String | Name of the scoring team, providing clear identification of the team assigned to evaluate the negotiation responses. |
| ScoringInstructions | String | Instructions given to the scoring team, providing guidelines and criteria for evaluating responses in the negotiation process. |
| ScoringDeadline | Date | The deadline by which the scoring team must complete their evaluations, helping to ensure timely decision-making in the negotiation process. |
| CreatedBy | String | The name or identifier of the user who created the scoring team record, ensuring accountability for data entry. |
| CreationDate | Datetime | The date and time when the scoring team record was created, marking the initial entry of the team into the system. |
| LastUpdateDate | Datetime | The date and time when the scoring team record was last updated, providing a timestamp for the most recent changes. |
| LastUpdatedBy | String | The name or identifier of the user who last updated the scoring team record, ensuring accountability for modifications. |
| Finder | String | Search or query reference used for locating or filtering specific scoring team records within the system. |
| EffectiveDate | Date | This query parameter is used to fetch resources that are effective as of the specified date, ensuring that only valid records for the given period are retrieved. |
Lists individual members in each scoring team, capturing their roles and responsibilities in the bid evaluation process.
| Name | Type | Description |
| SupplierNegotiationsAuctionHeaderId [KEY] | Long | Unique identifier for the auction header, linking the scoring team member data to a specific auction event in the negotiation process. |
| ScoringteamsAuctionHeaderId [KEY] | Long | Unique identifier for the auction header related to the scoring team, ensuring the team members are associated with the correct auction event. |
| ScoringteamsScoringTeamId [KEY] | Long | Unique identifier for the scoring team, helping to associate the team member data with the specific team responsible for evaluation in the negotiation. |
| AuctionHeaderId [KEY] | Long | Unique identifier for the auction, linking the scoring team member data to the overall auction event. |
| TeamId [KEY] | Long | Unique identifier for the team within the scoring group, allowing precise tracking of the team member's association with a specific scoring team. |
| TeamMemberId [KEY] | Long | Unique identifier for the team member, ensuring the system can track the individual evaluator’s participation in the negotiation process. |
| TeamMember | String | Name of the team member, providing identification for the person responsible for evaluating responses in the negotiation. |
| CreatedBy | String | The name or identifier of the user who created the scoring team member record, ensuring accountability for data entry. |
| CreationDate | Datetime | The date and time when the scoring team member record was created, marking the initial entry of the team member into the system. |
| LastUpdatedBy | String | The name or identifier of the user who last updated the scoring team member record, ensuring accountability for modifications. |
| LastUpdateDate | Datetime | The date and time when the scoring team member record was last updated, providing a timestamp for the most recent changes. |
| Finder | String | Search or query reference used for locating or filtering specific scoring team member records within the system. |
| EffectiveDate | Date | This query parameter is used to fetch resources that are effective as of the specified date, ensuring that only valid records for the given period are retrieved. |
Breaks down a negotiation into logical sections (for example, commercial requirements, technical specs, contractual terms).
| Name | Type | Description |
| SupplierNegotiationsAuctionHeaderId [KEY] | Long | Unique identifier for the auction header, linking the section data to a specific auction event in the negotiation process. |
| SectionId [KEY] | Long | Unique identifier for the section, allowing the system to track and manage each distinct section of the negotiation. |
| SectionDisplayNumber | String | Display number for the section, helping to order and present the sections in the correct sequence during the negotiation. |
| PricingSectionFlag | Bool | Indicates whether the section is related to pricing. If true, the section involves pricing; if false, it does not. |
| Section | String | Name or title of the requirement section, providing a label to identify the section within the negotiation process. |
| EvaluationStageCode | String | Abbreviation that uniquely identifies the evaluation stage in a two-stage RFQ (Request for Quotation). This code helps distinguish between different stages of evaluation. |
| EvaluationStage | String | Name of the evaluation stage in a two-stage RFQ (Request for Quotation). Typically includes values like 'Technical' or 'Commercial', helping to categorize the evaluation process. |
| ScoringTeamId | Long | Unique identifier for the scoring team assigned to evaluate the section, linking the section to the responsible team. |
| ScoringTeam | String | Name of the scoring team responsible for evaluating the section, providing clear identification of the team in charge of the assessment. |
| SectionWeight | Decimal | The relative importance of the section compared to other sections in the negotiation. This weight affects the overall score calculation for the requirements. |
| CreatedBy | String | The name or identifier of the user who created the section record, ensuring accountability for the data entry. |
| CreationDate | Datetime | The date and time when the section record was created, marking the initial entry of the section into the system. |
| LastUpdateDate | Datetime | The date and time when the section record was last updated, providing a timestamp for the most recent changes. |
| LastUpdatedBy | String | The name or identifier of the user who last updated the section record, ensuring accountability for modifications. |
| AuctionHeaderId | Long | Unique identifier for the auction, linking the section data to the overall auction event. |
| Finder | String | Search or query reference used for locating or filtering specific section records within the system. |
| EffectiveDate | Date | This query parameter is used to fetch resources that are effective as of the specified date, ensuring that only valid records for the given period are retrieved. |
Enables creation of structured negotiation requirements or questions, requesting detailed information from bidding suppliers.
| Name | Type | Description |
| SupplierNegotiationsAuctionHeaderId [KEY] | Long | Unique identifier for the auction header, linking the requirement data to a specific auction event. This ID connects the requirement to its corresponding auction and can be found in the auction-related tables in the system. |
| SectionsSectionId [KEY] | Long | Unique identifier for the section within the auction, associating each requirement to a specific section. This value helps categorize requirements within the overall structure of the auction. |
| SectionId | Long | Unique identifier for the section, providing a consistent reference to the section in which the requirement is located. This is used to organize and manage requirements in the auction. |
| Section | String | Name or title of the section containing the requirement. This provides clarity on what part of the negotiation or auction the requirement belongs to. Accepted values can be found in the auction setup under 'Section' names. |
| RequirementId [KEY] | Long | Unique identifier for each requirement, used to track and reference specific requirements throughout the negotiation process. This ID helps differentiate each requirement within the section. |
| ScoreId | Long | Unique identifier for the scoring method associated with the requirement. This ties the requirement to its scoring criteria, which could be based on predefined or custom scoring methods. |
| ParentType | String | Defines the parent entity to which the requirement is linked, such as Supplier or Supplier site. Accepted values include 'Supplier' and 'Supplier Site', which can be found in the lookup type PON_SUPPLIER_LEVEL. |
| RequirementLevel | Decimal | Indicates the importance or priority level of the requirement. This value is used to weigh the requirement relative to others in the scoring process, determining how heavily it influences the overall score. |
| RequirementNumber | String | Unique number assigned to each requirement, helping to organize and reference them easily during negotiations. This number can be seen in the requirement catalog or auction documentation. |
| QuestionId | Long | Unique identifier for the question tied to the requirement. This ID links the requirement to the specific query or request the supplier must answer. |
| QuestionRevisionNumber | Int | Revision number of the question associated with the requirement, indicating if the question has been updated or modified. This helps track changes made to requirements. |
| PricingRequirementFlag | Bool | Indicates whether the requirement is related to pricing. If true, the requirement involves pricing information; if false, it does not. This can be cross-referenced with other pricing-related requirements in the auction. |
| Requirement | String | The name or title of the requirement, summarizing the key expectation or condition that the supplier must meet. This description can be found in the auction or negotiation documentation. |
| RequirementText | String | Text description providing detailed context for the requirement. This text clarifies what is being asked from the supplier and often includes additional instructions. |
| Hint | String | Helpful text displayed to suppliers to guide their response to the requirement. The hint offers additional clarification or advice to ensure correct and complete responses. |
| LevelCode | String | Abbreviation indicating the supplier level that the requirement applies to, such as 'Supplier' or 'Supplier Site'. Accepted values for this field are listed in the lookup type PON_SUPPLIER_LEVEL. |
| Level | String | Defines the supplier level for the requirement, providing clarity on whether the requirement applies to the supplier or their site. Accepted values include 'Supplier' and 'Supplier Site', which can be referenced in PON_SUPPLIER_LEVEL lookup. |
| ResponseTypeCode | String | Abbreviation indicating the required response type for the requirement, such as 'Required', 'Optional', 'Display Only', or 'Internal'. These values define the supplier's obligations regarding the requirement and can be found in the lookup type PON_HDR_ATTR_RESPONSE_TYPE. |
| ResponseType | String | Describes whether the response to the requirement is mandatory, optional, for display only, or for internal use. Accepted values are 'Required', 'Optional', 'Display Only', and 'Internal', defined in the lookup type PON_HDR_ATTR_RESPONSE_TYPE. |
| RequirementTypeCode | String | Abbreviation identifying the response type required for the requirement, such as 'Text Entry Box', 'Multiple Choice with Multiple Selections', or 'Multiple Choice with Single Selection'. These are found in the lookup type PON_REQUIREMENT_TYPE. |
| RequirementType | String | Specifies the format of the response expected for the requirement, such as 'Text Entry Box' or 'Multiple Choice'. Accepted values include 'Text Entry Box', 'Multiple Choice with Multiple Selections', or 'Multiple Choice with Single Selection', listed in the PON_REQUIREMENT_TYPE lookup. |
| ValueTypeCode | String | Abbreviation identifying the type of value expected for the requirement response, such as 'TXT' for text, 'NUM' for numbers, 'DAT' for dates, or 'URL' for web addresses. Refer to PON_REQ_RESPONSE_TYPE for accepted values. |
| ValueType | String | Defines the type of value the supplier should provide for the requirement, such as 'Single Line Text', 'Multiple Line Text', 'Number', 'Date', 'DateTime', or 'URL'. Accepted values are defined in the PON_REQ_RESPONSE_TYPE lookup. |
| TargetTextValue | String | The target text or URL that the supplier must match or respond with. This serves as the reference value for text-based responses, such as a specific URL or predefined text. |
| TargetNumberValue | Decimal | The target numeric value for the requirement, which suppliers need to match or align with in their responses. |
| TargetDateValue | Date | The target date value for the requirement, indicating the date that the supplier should reference in their response. |
| TargetDateTimeValue | Datetime | The target date and time value for the requirement, specifying an exact moment that the supplier must meet in their response. |
| DisplayTargetFlag | Bool | Indicates whether the target value should be visible to the supplier. If true, the supplier can see the target value; if false, they cannot. Default is false. |
| AttachmentsFromSuppliersCode | String | Abbreviation identifying whether supplier attachments are allowed, optional, or required. Accepted values include 'Not Allowed', 'Optional', or 'Required'. These can be found in the lookup type PON_REQ_ALLOW_ATTACHMENT. |
| AttachmentsFromSuppliers | String | Specifies the supplier attachment requirement for each requirement. Values include 'Not Allowed', 'Optional', or 'Required', as defined in the PON_REQ_ALLOW_ATTACHMENT lookup. |
| AllowCommentsFromSuppliersFlag | Bool | Indicates whether suppliers can provide comments on the requirement. If true, comments are allowed; if false, they are not. Default is false. |
| ScoringMethodCode | String | Abbreviation for the scoring method used to evaluate the supplier’s response, such as 'Automatic', 'Manual', or 'None'. These values are found in the lookup type PON_SCORING_TYPE. |
| ScoringMethod | String | Describes the method used to score the supplier’s response, with possible values including 'Automatic', 'Manual', or 'None'. This is used to standardize the evaluation process. |
| Weight | Decimal | Represents the relative importance of the requirement compared to other requirements in the negotiation. This weight is used to calculate the overall score for the requirement. |
| MaximumScore | Decimal | The maximum score a supplier can receive for a requirement response, setting the highest possible evaluation for the response. |
| KnockoutScore | Decimal | The minimum score required for the response to be considered acceptable and remain on the shortlist. Responses below this score are excluded. |
| CreatedBy | String | The name or identifier of the user who created the requirement record, ensuring accountability for data entry. |
| CreationDate | Datetime | The date and time when the requirement record was created, marking its initial entry into the system. |
| LastUpdateDate | Datetime | The date and time when the requirement record was last updated, indicating when the most recent changes were made. |
| LastUpdatedBy | String | The name or identifier of the user who last updated the requirement record, ensuring accountability for modifications. |
| AuctionHeaderId | Long | Unique identifier linking the requirement to the overall auction event, ensuring the requirement is associated with the correct auction. |
| Finder | String | Search reference used to filter or locate specific requirement records within the system. It aids in searching and managing requirements efficiently. |
| EffectiveDate | Date | This parameter is used to fetch resources that are valid as of the specified date, ensuring only relevant and up-to-date records are retrieved. |
Lists scoring rules or acceptable answers for each requirement, helping evaluators rate supplier responses consistently.
| Name | Type | Description |
| SupplierNegotiationsAuctionHeaderId [KEY] | Long | Unique identifier for the auction header, linking the acceptable response score values to a specific auction event. This ID connects the response score data to its corresponding auction and can be found in the auction-related tables in the system. |
| SectionsSectionId [KEY] | Long | Unique identifier for the section within the auction, associating each acceptable response score value to a specific section. This value helps categorize and organize acceptable responses in the auction. |
| RequirementsRequirementId [KEY] | Long | Unique identifier for each requirement, allowing tracking and reference for acceptable response score values within that requirement. This ID ensures proper association between response values and their corresponding requirements. |
| SectionId | Long | Unique identifier for the section containing the requirement, used to group and manage the requirements within the auction structure. |
| Section | String | Name or title of the section containing the acceptable response score values. This helps identify what part of the negotiation or auction the response values belong to. |
| RequirementId | Long | Unique identifier for the requirement associated with the acceptable response score values, ensuring the correct alignment of responses with their corresponding requirements. |
| ScoreId [KEY] | Long | Unique identifier for the scoring criteria tied to the acceptable response score values. This helps differentiate the various score definitions used for the different requirements. |
| TargetFlag | Bool | Indicates whether the value is set as a target response value for the requirement. If true, the value is used as a target; if false, it is not. Default is false. |
| NoResponseFlag | Bool | Indicates whether the response should be marked as 'No Response'. This flag is set to true if no response is provided for the requirement. |
| ScoreDisplayNumber | String | Display number for the score, used to present a reference number for how the score should be displayed. |
| TextValue | String | Text value that the user enters for the requirement, applicable for text-based attributes. This value is used when the requirement expects a text response. |
| NumberFromRange | Decimal | Lowest value in a range for number-based attributes. This value sets the minimum acceptable value for the requirement. |
| NumberToRange | Decimal | Highest value in a range for number-based attributes. This value sets the maximum acceptable value for the requirement. |
| DateFromRange | Date | Start date in a range for date-based attributes. This value sets the earliest acceptable date for the requirement. |
| DateToRange | Date | End date in a range for date-based attributes. This value sets the latest acceptable date for the requirement. |
| DateTimeFromRange | Datetime | Start date and time in a range for date and time-based attributes. This value sets the earliest acceptable date and time for the requirement. |
| DateTimeToRange | Datetime | End date and time in a range for date and time-based attributes. This value sets the latest acceptable date and time for the requirement. |
| AttachmentsFromSuppliersCode | String | Abbreviation identifying the requirement for each supplier attachment. Possible values include 'Not Allowed', 'Optional', or 'Required', as defined in the lookup type PON_REQ_ALLOW_ATTACHMENT. |
| AttachmentsFromSuppliers | String | Defines whether supplier attachments are required for the requirement. Accepted values include 'Not Allowed', 'Optional', or 'Required', found in the lookup type PON_REQ_ALLOW_ATTACHMENT. |
| Score | Decimal | The score assigned to the acceptable response for the requirement, indicating the evaluation of the response. This score is used in the overall assessment of the supplier’s response. |
| CreatedBy | String | The name or identifier of the user who created the acceptable response score values record, ensuring accountability for data entry. |
| CreationDate | Datetime | The date and time when the acceptable response score values record was created, marking its entry into the system. |
| LastUpdateDate | Datetime | The date and time when the acceptable response score values record was last updated, indicating when it was most recently modified. |
| LastUpdatedBy | String | The name or identifier of the user who last updated the record, ensuring accountability for changes made. |
| AuctionHeaderId | Long | Unique identifier linking the acceptable response score values to the overall auction event, ensuring that these scores are associated with the correct auction. |
| Finder | String | A search reference used to filter or locate specific acceptable response score value records within the system. It helps in managing and retrieving the correct records. |
| EffectiveDate | Date | This parameter is used to fetch resources that are valid as of the specified date, ensuring only up-to-date records are retrieved for the negotiation. |
Stores supplementary files associated with specific negotiation requirements, such as reference documents or images.
| Name | Type | Description |
| SupplierNegotiationsAuctionHeaderId [KEY] | Long | Unique identifier for the auction header, linking the attachment to a specific auction event. This ID connects the attachment data to its corresponding auction and can be found in the auction-related tables in the system. |
| SectionsSectionId [KEY] | Long | Unique identifier for the section within the auction, associating each attachment to a specific section. This helps categorize and organize attachments in the auction. |
| RequirementsRequirementId [KEY] | Long | Unique identifier for each requirement, allowing tracking and reference for attachments related to that requirement. This ID ensures proper association between attachments and their corresponding requirements. |
| AttachedDocumentId [KEY] | Long | Primary key that the system generates for each document attached, allowing each attachment to be uniquely identified. |
| LastUpdateDate | Datetime | Date and time when the record was last updated. This field provides a timestamp for when the attachment record was modified. |
| LastUpdatedBy | String | Name or identifier of the user who last updated the record. This field tracks who modified the attachment data. |
| DatatypeCode | String | Abbreviation that identifies the type of data in the attachment. Accepted values include 'FILE', 'FOLDER', 'TEXT', or 'WEB_PAGE', helping categorize the type of attachment. |
| FileName | String | Name of the attached file, typically representing the original file name when it was uploaded. |
| DmFolderPath | String | Folder path of the attachment in the document management system. This value helps locate where the attachment is stored within the system. |
| DmDocumentId | String | Unique identifier assigned to the document by the document management system, allowing the system to track and manage the document. |
| DmVersionNumber | String | Version number of the attached document. This ensures that different versions of the same document can be tracked and accessed. |
| Url | String | Uniform Resource Locator (URL) of the attachment. This provides the web address for accessing the document. |
| CategoryName | String | Category of the attachment, helping to group and classify attachments based on their purpose or content type. |
| UserName | String | Login credentials of the user who created the attachment record. This field tracks who originally uploaded the attachment. |
| Uri | String | Uniform Resource Identifier (URI) of the attachment, offering a unique link to the document. |
| FileUrl | String | URL that points directly to the location of the attachment, enabling access to the document through a standard web browser. |
| UploadedText | String | Text associated with the attachment, often used for metadata or additional context about the document. |
| UploadedFileContentType | String | The content type of the attachment, indicating its format |
| UploadedFileLength | Long | Size of the file in bytes. This indicates the file's storage size, helping the system manage disk space. |
| UploadedFileName | String | Name of the file uploaded to the system. This typically reflects the original file name at the time of upload. |
| ContentRepositoryFileShared | Bool | Indicates whether the file is shared or not. If true, the file is shared; if false, it is not. The default value is false. |
| Title | String | Title of the attachment. This field is used to provide a brief, human-readable identifier for the document. |
| Description | String | Description of the attachment, providing additional context and details about the document's content. |
| ErrorStatusCode | String | Abbreviation identifying any error related to the attachment. This could include values like 'FILE_TOO_LARGE' or 'UPLOAD_FAILED'. |
| ErrorStatusMessage | String | Text describing the error encountered during the attachment process. This message provides more detailed information about the error condition. |
| CreatedBy | String | Name or identifier of the user who created the attachment record. This tracks the original uploader. |
| CreationDate | Datetime | Date and time when the attachment was first created in the system. This field provides a timestamp for when the attachment record was initiated. |
| FileContents | String | The actual contents of the attachment, typically stored in a binary format or Base64 encoding. |
| ExpirationDate | Datetime | Date when the contents of the attachment expire or are no longer considered valid. This field helps manage document lifecycle. |
| LastUpdatedByUserName | String | The user name of the person who last updated the record. This helps in identifying who made the last change to the attachment data. |
| CreatedByUserName | String | The user name of the person who created the attachment record. This tracks the user responsible for the initial upload. |
| AsyncTrackerId | String | An identifier used for tracking the uploaded files asynchronously, helping to monitor the upload process if done in the background. |
| FileWebImage | String | Base64-encoded image representing the file, typically used for previewing file content (for example, thumbnail for PDF or image file). |
| DownloadInfo | String | JSON string containing information used to programmatically retrieve a file attachment, such as access credentials and location. |
| PostProcessingAction | String | Name of the action that can be performed after the attachment is uploaded, such as 'extract text' or 'generate preview'. |
| AuctionHeaderId | Long | Links the attachment to a specific auction, ensuring the attachment is associated with the correct auction event. |
| Finder | String | Search reference used for filtering or locating specific attachment records in the system. |
| EffectiveDate | Date | This field is used to fetch records that are valid as of the specified date, ensuring only relevant and up-to-date attachments are included in results. |
Houses descriptive flexfields at the negotiation header for supplier-specific data, capturing additional attributes not in standard fields.
| Name | Type | Description |
| SupplierNegotiationsAuctionHeaderId [KEY] | Long | Unique identifier for the auction header in the supplier negotiation. This ID is used to associate the supplier negotiation data with a specific auction. This value can be found in the auction data tables. |
| _FLEX_Context | String | Descriptive flexfield (DFF) context name for the details about supplier negotiations. This context provides additional flexible fields used to capture supplier-specific data during the negotiation process. The context value defines the purpose or area of the flexfield. You can find the context names in the 'Descriptive Flexfields' section of the Setup and Maintenance work area. |
| _FLEX_Context_DisplayValue | String | This field displays the DFF context for the supplier negotiation. The 'Context Display Value' is the user-friendly name of the flexfield context that is used to categorize the data. It is configured in the Descriptive Flexfield setup for the relevant negotiation areas. |
| AuctionHeaderId | Long | Unique identifier that links to the negotiation process. The AuctionHeaderId identifies a specific negotiation and helps in connecting various negotiation-related data to that auction. It is used to link the negotiation with its specific auction header and can be found in auction or negotiation tables. |
| Finder | String | Search or filter reference for locating supplier negotiation records in the system. This field is used to perform searches for specific data and can be part of query filters in user interface or reporting tools. |
| EffectiveDate | Date | The date that specifies when the record is valid or effective. This parameter is used to fetch resources that are valid as of the specified start date. Effective date ensures that only the most relevant data for a given time period is included. You can use it for filtering data based on business rules or specific periods. |
Shows suppliers invited or participating in the negotiation, logging their bids, statuses, and communication history.
| Name | Type | Description |
| SupplierNegotiationsAuctionHeaderId [KEY] | Long | Unique identifier for the auction header in the supplier negotiation. This ID links the supplier negotiation records to the specific auction in which the supplier is participating. The auction header ID is part of the primary key for negotiation data and is found in the auction data tables. |
| AuctionHeaderId [KEY] | Long | Unique identifier for the auction process that is associated with supplier negotiations. It links supplier records to the negotiation event and can be found in the auction setup and negotiation tables. |
| SupplierInvitationId [KEY] | Long | Unique identifier for the supplier invitation sent for the negotiation. This ID helps track the specific invitation that was extended to a supplier to participate in a particular negotiation. The invitation ID is stored in the supplier invitation tables. |
| Supplier | String | Name of the supplier company invited to respond to the negotiation. This is the legal entity or company that the procurement team wants to engage with during the negotiation process. The name is typically stored in the supplier master data or supplier records. |
| SupplierId | Long | Unique identifier for the supplier company that was invited to respond to the negotiation. This ID is used to differentiate between multiple suppliers and is a key reference in the supplier data tables. |
| SupplierSite | String | Name of the specific supplier site where the goods or services are being provided from. This is important when dealing with suppliers who may have multiple operational sites. Supplier site names are maintained in the supplier site data. |
| SupplierSiteId | Long | Unique identifier for the specific supplier site associated with the supplier. This value links supplier negotiation data to the exact location or facility of the supplier, and can be found in the supplier site master data. |
| SupplierContact | String | Name of the employee representing the supplier during communication with the buying organization. This is typically the account manager or the primary contact person for the negotiation. |
| SupplierContactId | Long | Unique identifier for the supplier contact person. This ID allows the system to track interactions with specific employees representing the supplier and can be found in the contact data tables. |
| RequestedSupplier | String | Name of the supplier that the application invites to respond to the negotiation during the approval pending process. This field identifies suppliers who have been sent an invitation to participate. |
| RequestedSupplierId | Long | Unique identifier for the supplier invited to respond to the negotiation during approval pending. This ID is used to differentiate between multiple suppliers invited for negotiation in a pending state. |
| RequestedSupplierContact | String | Name of the contact person at the supplier invited to respond to the negotiation during approval pending. This person is the main point of communication for the supplier during this stage. |
| RequestedSupplierContactId | Long | Unique identifier for the contact person at the supplier invited to respond to the negotiation during approval pending. This ID is used to track the specific individual in the contact data system. |
| AdditionalContactEmail | String | Email address of any additional contact at the supplier for receiving communication related to the negotiation. This field allows for more than one contact to be associated with a supplier. |
| ResponseCurrency | String | Currency code used for the supplier’s response in the negotiation. It indicates the currency in which the supplier will quote their price, and the list of accepted values can be found in the Currency Codes table or lookup. |
| ResponseCurrencyCode | String | Short code representing the currency used in the supplier's response. For example, USD for U.S. Dollar, EUR for Euro. Accepted values are defined in the system’s Currency Code lookup. |
| ConversionRate | Decimal | Rate used to convert the supplier's response currency to the negotiation's base currency. Conversion rates are generally managed by the system and can be retrieved from the financial or exchange rate tables. |
| PricePrecision | Decimal | Defines the number of decimal places to which prices are displayed or rounded. This setting ensures consistent pricing across responses and can be found in the pricing setup or financial parameters. |
| SupplierNumber | Long | Unique number assigned to each supplier in the system. This identifier links the supplier’s financial and transaction data to the supplier negotiation records. |
| CreatedBy | String | Name of the user who created the supplier negotiation record. This helps track the origin of the data entry and is typically stored in user management or audit tables. |
| CreationDate | Datetime | Date and time when the supplier negotiation record was created. This is used for tracking the lifecycle of the negotiation and can be found in the system’s audit logs. |
| LastUpdateDate | Datetime | Date and time when the supplier negotiation record was last updated. This is used to track any changes made to the record and can be found in the system’s change logs. |
| LastUpdatedBy | String | Name of the user who last updated the supplier negotiation record. This field helps to trace back the latest changes in the record. |
| NotifyAllSupplierContactsFlag | Bool | Indicates whether notifications should be sent to all contacts of the supplier. If true, all listed contacts will receive notifications. If false, only the primary contact or additional email will receive notifications. The default value is false. |
| Finder | String | Search term or filter used to locate the supplier negotiation records in the system. This can be used in reports or for querying the system to retrieve relevant supplier data. |
| EffectiveDate | Date | Date from which the record is effective. Used to fetch resources that are active as of the specified date. This parameter ensures data relevancy within a certain time period and can be adjusted in the filtering criteria. |
Implements line-level access restrictions, ensuring certain suppliers only see or bid on designated negotiation lines.
| Name | Type | Description |
| SupplierNegotiationsAuctionHeaderId [KEY] | Long | Unique identifier for the auction header in the supplier negotiation record. This ID links the supplier's line access restrictions to the specific auction process. It can be found in the auction data tables. |
| SuppliersAuctionHeaderId [KEY] | Long | Unique identifier for the auction header related to the supplier's access restrictions. It helps associate the supplier with the specific auction event and is found in the auction setup tables. |
| SuppliersSupplierInvitationId [KEY] | Long | Unique identifier for the supplier invitation associated with the line access restriction. This ID helps track the supplier's participation and can be found in the invitation records. |
| AuctionHeaderId [KEY] | Long | Unique identifier for the auction process to which the supplier's line access restrictions apply. It connects the supplier with the auction process and is available in the auction event tables. |
| SupplierInvitationId [KEY] | Long | Unique identifier for the supplier invitation within the negotiation process. This ID helps track invitations sent to suppliers and is stored in the invitation management tables. |
| LineId [KEY] | Decimal | Unique identifier for the specific negotiation line. This ID is used to link the supplier’s access restriction to a particular line in the auction or negotiation and is found in the negotiation line tables. |
| Line | String | Number or identifier that specifies the negotiation line. This value allows the system to reference specific lines within the auction or negotiation process and is used in reporting or filtering data. |
| LineDescription | String | Text description of the negotiation line. This provides more context or details about the line and is typically stored in the line data or negotiation details. |
| CreatedBy | String | Name or identifier of the user who created the record for the supplier’s line access restriction. This helps trace the origin of the record and is available in user or audit logs. |
| CreationDate | Datetime | Date and time when the supplier’s line access restriction record was created. This helps track when restrictions were applied and is logged in system activity or audit trails. |
| LastUpdatedBy | String | Name or identifier of the user who last updated the supplier’s line access restriction record. This field allows for tracking changes made to the record and is found in audit or modification logs. |
| LastUpdateDate | Datetime | Date and time when the supplier’s line access restriction record was last updated. This helps monitor when changes were made and is recorded in the system's history or modification logs. |
| Finder | String | Search term or filter used to locate supplier line access restriction records in the system. This could be used in system queries, reports, or filtering functions to retrieve specific supplier data. |
| EffectiveDate | Date | Date from which the record is effective. This helps determine which resources are active as of the specified date and is used for filtering and managing time-sensitive data. |
Manages qualification areas, like compliance or financial stability, for assessing supplier eligibility and performance.
| Name | Type | Description |
| QualAreaId [KEY] | Long | Unique identifier for the qualification area. This ID links the specific qualification area to the supplier qualification process. It can be found in the qualification area data tables. |
| OriginalQualAreaId | Long | Original identifier for the qualification area, if the current area is a revision. This helps trace the original area in the history of changes. It can be found in the qualification area revision data. |
| Revision | Int | Revision number of the qualification area. This helps track the version history of the qualification area. The revision number is stored in the qualification area versioning system. |
| QualArea | String | Name or title of the qualification area. This value typically represents the category or topic being evaluated during the qualification process. It is available in the qualification area listing. |
| QualAreaDescription | String | Textual description of the qualification area. This provides more context and details about the qualification area. The description is stored in the qualification area details. |
| QualAreaStatus | String | Current status of the qualification area. Valid values include 'Active', 'Inactive', and 'Expired'. The status helps track whether the area is currently in use or archived. Review the list of accepted values in the qualification management system. |
| QualAreaStatusCode | String | Abbreviation of the qualification area status. For example, 'ACT' for active, or 'INA' for inactive. Accepted values are found in the lookup type for qualification status codes. |
| GlobalFlag | Bool | Indicates whether the qualification area is global or region-specific. If true, the area is applicable globally. If false, it applies only to specific regions or business units. |
| InformationOnlyFlag | Bool | Indicates if the qualification area is for informational purposes only. If true, the area is not used in active evaluations but is available for reference. |
| LatestRevisionFlag | Bool | Indicates whether this revision is the latest version. If true, this is the most recent revision of the qualification area. |
| QualAreaLevelCode | String | Abbreviation identifying the qualification area's level (for example, 'Basic', 'Advanced'). This helps determine the depth or complexity of the qualification area. The list of accepted levels can be found in the qualification level lookup. |
| QualAreaLevel | String | Full name describing the qualification area's level (for example, 'Basic', 'Advanced'). This value categorizes the qualification area based on its depth and is typically found in qualification system settings. |
| ProcurementBUId | Long | Unique identifier for the procurement business unit associated with the qualification area. This helps link the qualification area to the appropriate procurement department. |
| ProcurementBU | String | Name of the procurement business unit associated with the qualification area. It indicates the department or division handling the qualification. |
| OwnerId | Long | Unique identifier for the owner of the qualification area. This is the person or group responsible for managing the qualification area. |
| Owner | String | Name of the owner of the qualification area. This individual or group is responsible for overseeing and updating the qualification area. |
| SubjectCode | String | Code that identifies the subject of the qualification area. The subject can be a category or theme within the procurement process. Accepted values are available in the qualification area subject lookup. |
| Subject | String | Name of the subject of the qualification area. It provides a brief description of the topic or category of evaluation, such as 'Supplier Management' or 'Compliance'. |
| StandardsOrganizationCode | String | Code that identifies the standards organization relevant to the qualification area. A list of accepted values is defined in the organization standards lookup. |
| StandardsOrganization | String | Name of the standards organization associated with the qualification area. This could be an industry-recognized body that defines standards for the qualification process. |
| ActivationDate | Datetime | The date when the qualification area becomes active. This date is important for tracking when the area can be used in evaluations. |
| EnableScoringFlag | Bool | Indicates whether scoring is enabled for the qualification area. If true, suppliers are scored based on their responses; otherwise, scoring is not applicable. |
| AutoAcceptResponsesFlag | Bool | Indicates if responses to the qualification area are automatically accepted. If true, responses are automatically marked as accepted without manual review. |
| AutoPopulateResponsesFlag | Bool | Indicates whether responses are automatically populated from existing data repositories. If true, previous responses are pre-filled during evaluation. |
| AutoEvaluateQualFlag | Bool | Indicates if qualification area responses are automatically evaluated. If true, responses are evaluated based on predefined criteria; otherwise, manual evaluation is required. |
| ExpirationReminderTypeCode | String | Abbreviation for the type of expiration reminder. Possible values include 'DAYS' or 'WEEKS'. This determines the frequency of reminders sent before the qualification area expires. |
| ExpirationReminderType | String | Description of the type of expiration reminder. It could include options like 'Days', 'Weeks', or 'Months'. Accepted values are defined in the expiration reminder type lookup. |
| ExpirationReminderPeriod | Int | Number of days, weeks, or months before expiration when the reminder will be sent. For example, if set to 30, a reminder will be sent 30 days before expiration. |
| RequalifyExpirationFlag | Bool | Indicates whether the qualification area will require requalification upon expiration. If true, the supplier must requalify to continue participating. |
| QualificationDurationTypeCode | String | Code that defines the type of duration for the qualification area (for example, 'YEAR', 'MONTH'). Accepted values are defined in the qualification duration type lookup. |
| QualificationDurationType | String | Name of the type of duration for the qualification area (for example, 'Year', 'Month'). This helps define how long the qualification area remains valid before requiring updates. |
| QualificationDuration | Int | Length of time for which the qualification area is valid. For example, a duration of 12 means the qualification is valid for 12 months. |
| ShowQualToSupplierFlag | Bool | Indicates whether the qualification area is visible to the supplier. If true, suppliers can view and respond to the qualification; otherwise, it is hidden. |
| ShowQualSuppRespFlag | Bool | Indicates whether supplier responses to the qualification area are visible. If true, suppliers can see responses from others; if false, they cannot. |
| ShowQualInterRespFlag | Bool | Indicates whether internal responses to the qualification area are visible. If true, internal responses are displayed for review; if false, they are hidden. |
| NoteToSupplier | String | Text note that provides additional information or instructions to the supplier regarding the qualification area. |
| RequalifyResponseFlag | Bool | Indicates whether suppliers need to provide new responses upon requalification. If true, suppliers must submit new responses; otherwise, existing responses are retained. |
| SingleQualAutoInitFlag | Bool | Indicates whether the qualification process should automatically initialize for a single qualification. If true, the process begins automatically for each new qualification. |
| QualificationOwnerId | Long | Unique identifier for the qualification area owner, who is responsible for managing the qualification process. |
| QualificationOwnerName | String | Name of the owner of the qualification area. This is the person or group responsible for overseeing the qualification process. |
| QualAreaSurveyFlag | Bool | Indicates whether the qualification area is part of a survey. If true, the area is included in a survey sent to suppliers. |
| SectionName | String | Name of the section that the qualification area belongs to. This helps categorize the qualification within larger documents or surveys. |
| Finder | String | Search term or filter used to locate the qualification area record in the system. |
Stores attachments for qualification areas, such as policy files or reference documents supporting the qualification criteria.
| Name | Type | Description |
| SupplierQualificationAreasQualAreaId [KEY] | Long | Unique identifier for the qualification area to which the attachment is linked. This ID connects the attachment to a specific qualification area. You can find this ID in the qualification area management system. |
| AttachedDocumentId [KEY] | Long | Unique identifier for the attached document. It is the primary key created when a document is uploaded. This can be found in the document management system where the file is stored. |
| LastUpdateDate | Datetime | The date and time when the attachment was last updated. This helps track when the document was modified or replaced. |
| LastUpdatedBy | String | Name of the user who last updated the attachment. This field identifies the individual who made changes to the document record. |
| DatatypeCode | String | Abbreviation identifying the data type of the attachment. Accepted values include 'FILE', 'FOLDER', 'TEXT', or 'WEB_PAGE'. These values can be found in the data type lookup configuration. |
| FileName | String | Name of the file uploaded as the attachment. This is the actual name of the file that was attached and stored. |
| DmFolderPath | String | Path to the folder where the document is stored in the document management system (DMS). This provides the location within the repository. |
| DmDocumentId | String | Unique identifier of the document in the document management system. This ID is used to retrieve the document from the repository. |
| DmVersionNumber | String | Version number of the attached document. It helps track the document's version history and can be found in the version control section of the document management system. |
| Url | String | URL (Uniform Resource Locator) to access the attachment. This is the web link pointing to the location of the file in the system. |
| CategoryName | String | Category assigned to the attachment. This field is used to group similar types of documents together in the document management system. |
| UserName | String | The login credentials of the user who uploaded the attachment. This helps identify who was responsible for adding the document. |
| Uri | String | Uniform Resource Identifier (URI) that uniquely identifies the attachment within the system. The URI is often used for programmatic access to the file. |
| FileUrl | String | URL of the attachment file. This link can be used to download or view the document directly. |
| UploadedText | String | Text content extracted from the uploaded file. This field is applicable if the attachment is a text-based document. |
| UploadedFileContentType | String | The content type of the uploaded file, indicating its format. |
| UploadedFileLength | Long | Size of the uploaded file in bytes. This field shows how large the file is and can be found in the file metadata. |
| UploadedFileName | String | Name of the uploaded file as it appears in the document repository. This can be different from the original file name if it was modified during upload. |
| ContentRepositoryFileShared | Bool | Indicates whether the file is shared with others. If true, the file is accessible by authorized users, otherwise it is not. This setting is managed in the content repository configuration. |
| Title | String | Title of the attachment. This is a short description or title that summarizes the content of the attachment. |
| Description | String | Detailed description of the attachment. This field provides context and more information about the file for users reviewing the document. |
| ErrorStatusCode | String | Code that identifies any errors associated with the attachment. If any issues occurred during upload or processing, this code is used to indicate the error type. Accepted values can be found in the error code lookup. |
| ErrorStatusMessage | String | Message explaining the error, if any, associated with the attachment. This provides more context about the issue and can be found in the error logs. |
| CreatedBy | String | The name of the user who created the attachment record in the system. This is the individual who first uploaded the document. |
| CreationDate | Datetime | The date and time when the attachment was first uploaded to the system. |
| FileContents | String | Content of the file in text form, if applicable. This field may be used for textual files or to display a preview of the document's contents. |
| ExpirationDate | Datetime | Date when the attachment will expire. After this date, the file may be archived or removed from the system, depending on retention policies. |
| LastUpdatedByUserName | String | Username of the individual who last updated the attachment. This helps track modifications made to the document record. |
| CreatedByUserName | String | Username of the individual who originally created the attachment. This identifies the person who uploaded the document. |
| AsyncTrackerId | String | Unique identifier used to track the asynchronous processing of the attachment upload. This can be useful for monitoring the upload status. |
| FileWebImage | String | Base64-encoded image of the file displayed as a web image in .png format if the document is an image that can be converted to a web-viewable format. |
| DownloadInfo | String | JSON object containing information necessary for programmatic retrieval of the attachment. This can be used by developers to automate the file retrieval process. |
| PostProcessingAction | String | Action that can be performed after the file is uploaded, such as indexing, virus scanning, or conversion. This is defined by post-upload processing rules. |
| Finder | String | Search term or filter used to locate the attachment within the system. This helps users find specific attachments based on keywords or tags. |
| QualAreaId | Long | Unique identifier for the qualification area that the attachment is linked to. This ID connects the attachment to a specific qualification area. |
Connects qualification areas to specific business units, indicating which organizational segments require those assessments.
| Name | Type | Description |
| SupplierQualificationAreasQualAreaId [KEY] | Long | Unique identifier for the qualification area to which the business unit access is linked. This ID connects the business unit access record to a specific qualification area. You can find this ID in the qualification area management section of your system. |
| QualAreaBUAccessId [KEY] | Long | Unique identifier for the qualification area business unit access. This ID represents the specific access rights assigned to a business unit for a qualification area. This can be found in the business unit access management section. |
| QualAreaId | Long | Unique identifier for the qualification area. This ID links the qualification area to other relevant records in the system. It can be found in the qualification area setup or configuration section. |
| ProcurementBUId | Long | Unique identifier for the procurement business unit (BU) that is responsible for the qualification area. This ID is used to manage the access and responsibilities of procurement teams. You can find this ID in the procurement business unit management area. |
| ProcurementBU | String | The name of the procurement business unit (BU) that is responsible for managing the qualification area. This field links the qualification area to a specific procurement unit. The list of procurement business units can be found in the procurement setup section. |
| QualificationOwnerId | Long | Unique identifier for the owner of the qualification area. This ID refers to the person or department responsible for the qualification area. It can be found in the qualification area ownership settings or personnel management section. |
| QualificationOwnerName | String | The name of the individual or team that owns and manages the qualification area. This helps identify the person or group responsible for the qualification area within the system. |
| Finder | String | Search term or keyword used to locate the qualification area business unit access record. This can be used to filter and search within the qualification area business unit records. |
Defines possible results (for example, pass, fail, conditional) for a qualification area, aiding standardized supplier evaluations.
| Name | Type | Description |
| SupplierQualificationAreasQualAreaId [KEY] | Long | Unique identifier for the qualification area to which the outcome is associated. This ID links the outcome to a specific qualification area. You can find this ID in the qualification area management section of your system. |
| QualAreaOutcomeId [KEY] | Long | Unique identifier for the outcome associated with the qualification area. This ID connects the outcome record to its corresponding qualification area. It can be found in the qualification outcomes management section. |
| QualAreaId | Long | Unique identifier for the qualification area. This ID represents the qualification area where the outcome applies. It links the outcome to the qualification area and can be found in the qualification area setup or configuration section. |
| DisplaySequence | Int | The display sequence number indicates the order in which the outcomes appear. This value is used to determine the positioning of outcomes in the qualification area display. The default sequence can be set in the outcome configuration settings. |
| OutcomeName | String | The name or label given to the outcome of the qualification process. This helps identify the type or description of the outcome (for example, 'Pass', 'Fail'). It can be customized in the outcome configuration section. |
| FromScore | Int | The minimum score required to achieve the outcome. This value defines the lower limit of scores that qualify for this outcome. You can find the score range configuration in the qualification scoring settings. |
| ToScore | Int | The maximum score required to achieve the outcome. This value defines the upper limit of scores that qualify for this outcome. This can be set alongside the 'FromScore' field in the scoring configuration section. |
| ActiveFlag | Bool | Indicates whether the outcome is currently active and valid. If true, the outcome is active and can be applied to the qualification process; if false, the outcome is inactive and will not be applied. The default value is true. |
| NotificationFlag | Bool | Indicates whether notifications should be sent when this outcome is triggered. If true, an automated notification will be sent to the relevant parties. The default value is false. |
| KnockoutOutcomeFlag | Bool | Indicates whether this outcome is a knockout criterion, meaning that if the outcome is achieved, the supplier or participant is eliminated from the qualification process. If true, the outcome is a knockout; if false, it is a non-knockout outcome. |
| Finder | String | Search term or keyword used to locate the qualification area outcome record. This can be used to filter and search within the qualification area outcomes list. |
Lists questions for a given qualification area, capturing the required data to assess supplier compliance or capability.
| Name | Type | Description |
| SupplierQualificationAreasQualAreaId [KEY] | Long | Unique identifier for the qualification area to which the question is associated. This ID links the question to a specific qualification area. It can be found in the qualification area management section of your system. |
| QualAreaQuestionId [KEY] | Long | Unique identifier for the question associated with the qualification area. This ID connects the question record to its corresponding qualification area and can be found in the question setup section. |
| QualAreaId | Long | Unique identifier for the qualification area. This ID represents the qualification area in which the question resides. It can be found in the qualification area setup or configuration section. |
| DisplaySequence | Int | The display sequence number indicates the order in which the question appears. This value is used to determine the positioning of the question within the qualification area. The default sequence can be set in the question configuration settings. |
| QuestionId | Long | Unique identifier for the question. This ID distinguishes the question from others in the system and links to the relevant qualification area. It is used throughout the qualification process and can be found in the question management section. |
| Question | String | The text of the question being asked in the qualification area. This is the actual content of the question, which can be customized based on the needs of the qualification process. |
| QuestionStatus | String | The status of the question, indicating whether it is active, inactive, or under review. Accepted values include 'Active', 'Inactive', and 'Under Review'. These values can be configured in the question status settings. |
| Weight | Decimal | The weight assigned to the question, indicating its importance relative to other questions in the qualification process. This weight is used when calculating the overall qualification score. The default weight can be set in the scoring configuration. |
| KnockoutScore | Int | The score threshold that determines whether a supplier or participant is knocked out based on their response to this question. If the participant's score is below this threshold, they are disqualified from the qualification process. This score can be set in the qualification scoring rules. |
| Finder | String | Search term or keyword used to locate the qualification area question record. This term is used to filter and search within the qualification area questions list. |
Collects the actual answers suppliers provide to qualification questions, forming a record for subsequent review.
| Name | Type | Description |
| QuestionId | Long | Unique identifier for the question. This ID is used to link the response to the specific question. It can be found in the question setup or configuration section of the system. |
| Question | String | Text or identifier of the question that the supplier or internal responder answers. This is defined by the user during the creation of the qualification process. |
| SupplierId | Long | Unique identifier for the supplier who is providing the response. It helps link the response to a specific supplier in the system. |
| Supplier | String | The name of the supplier providing the response. This is the company's name associated with the SupplierId. |
| SupplierSiteId | Long | Unique identifier for the supplier site where the supplier is based. It can be found in the supplier site management section. |
| SupplierSite | String | Name of the supplier site associated with the supplier. This helps to link the response to the specific location of the supplier. |
| ResponseDate | Datetime | The date when the response to the question is submitted. This is tracked for record-keeping and follow-up purposes. |
| InternalResponderId | Long | Unique identifier for the internal responder who is responsible for answering the question. It can be found in the internal responder or team management section. |
| InternalResponder | String | Name of the internal responder assigned to provide answers to the question. This is typically a representative from the buying organization. |
| SupplierContactId | Long | Unique identifier for the supplier contact responsible for submitting the response. This ID can be found in the contact management section. |
| SupplierContact | String | Name of the supplier contact who submitted the response. This person is the key point of communication for the supplier. |
| QuestionText | String | The actual text of the question as asked during the qualification process. This is used to reference the full question being answered. |
| QuestionRevision | Int | The revision number of the question. This helps track changes or updates to the question over time. |
| ResponderComments | String | Additional comments or notes provided by the responder when submitting the response. This allows for clarification or explanation of the provided answers. |
| AcceptanceNote | String | Any notes entered by the responder during the acceptance of the qualification response. This can include additional instructions or confirmations. |
| ResponseRepositoryId [KEY] | Long | Unique identifier for the repository where the responses are stored. This ID helps track the storage location of the response data. |
| ResponseStatusCode | String | Code representing the status of the response. Common values include 'Accepted', 'Pending', or 'Rejected'. Refer to the lookup type PON_RESPONSE_STATUS for accepted values. |
| ResponseStatus | String | Human-readable status of the response, indicating its current state in the process. Common values include 'Accepted', 'Pending', or 'Rejected'. This is linked to the ResponseStatusCode. |
| FirstSubmissionDate | Datetime | The date when the first submission of the response was made. This is useful for tracking the initial response date. |
| ResponseArchiveDate | Datetime | The date when the response was archived. This is used for record-keeping and audit purposes. |
| AcceptanceDate | Datetime | The date when the response was formally accepted by the responsible party. This tracks when the qualification process considers the response final. |
| AcceptedById | Long | Unique identifier for the person who accepted the qualification response. This ID links to the individual who authorized the response acceptance. |
| AcceptedBy | String | Name of the person who accepted the response. This is typically an internal representative from the purchasing or qualification team. |
| DataSourceTypeCode | String | Code representing the source type of the response data. Accepted values include 'System', 'Manual', and 'File Import'. This can be found in the data source configuration section. |
| DataSourceType | String | Human-readable type of the data source for the response. Values like 'System', 'Manual', and 'File Import' are used to categorize the source of the response. |
| DataSourceId | Long | Unique identifier for the source from which the response was received. This could link to a database, file, or manual entry system. |
| ResponderTypeCode | String | Code that represents the type of responder. Accepted values include 'Supplier', 'Internal', 'Admin'. Refer to the lookup type PON_RESPONDER_TYPE for full list. |
| ResponderType | String | Human-readable type of responder, which indicates whether the response was submitted by a supplier, internal responder, or admin. |
| OriginalQuestionId | Long | Original identifier for the question if it was modified or revised. This links the current question response to the original version. |
| SurrogateResponseFlag | Bool | Indicates whether the response was provided by a surrogate (someone other than the intended responder). Accepted values are 'true' or 'false'. |
| SurrogateEntryDate | Datetime | Date when the surrogate entered the response on behalf of the intended responder. |
| SurrogateEnteredById | Long | Unique identifier for the person who entered the surrogate response. This ID links to the individual responsible for submitting the surrogate response. |
| SurrogateEnteredBy | String | Name of the person who entered the surrogate response. This is typically an internal user or team member. |
| ProcurementBU | String | Name of the procurement business unit that the supplier site belongs to. This links the response to the relevant business unit. |
| ProcurementBUId | Long | Unique identifier for the procurement business unit associated with the supplier site. |
| AggregateResponseFlag | Bool | Indicates whether the response is an aggregate of multiple submissions. Accepted values are 'true' or 'false'. Default is 'false'. |
| Finder | String | Search term or keyword used to locate the supplier qualification question response record. This is used to filter and search within the responses. |
Captures detailed data points (for example, numeric values, text inputs) for each question response, enabling in-depth analysis.
| Name | Type | Description |
| SupplierQualificationQuestionResponsesResponseRepositoryId [KEY] | Long | Unique identifier for the repository storing the responses. This ID links to the data source or location where the responses are saved. |
| AcceptableResponseId | Long | Unique identifier for an acceptable response. This ID refers to the response configuration in the qualification system. |
| AcceptableResponseText | String | Text representing an acceptable response. This describes what qualifies as an acceptable answer to the question. |
| ResponseRepositoryValueId [KEY] | Long | Unique identifier for the value in the response repository. This ID links the specific value entered by the responder to the overall response data. |
| ResponseRepositoryId | Long | Unique identifier for the repository where the responses are stored. This helps locate the collection of responses in the database or system. |
| ResponseValueDate | Date | Date value provided by the responder. This value is applicable when the question expects a date as a response. |
| ResponseValueDatetime | Datetime | Date and time value provided by the responder. This value is applicable for questions requiring a specific date and time. |
| ResponseValueNumber | Decimal | Numeric value provided by the responder. This value applies when the question expects a numerical response. |
| ResponseValueText | String | Text value provided by the responder. This is used when the question expects a text-based response (for example, freeform text or short answer). |
| CriticalResponseFlag | Bool | Indicates whether the response is critical for the qualification process. If true, the response is considered crucial for decision-making. Accepted values are 'true' or 'false'. |
| Finder | String | Search term or keyword used to locate the response record in the system. This is helpful for filtering and searching within the qualification responses. |
Associates supporting documents or certificates with question responses, demonstrating supplier qualifications or compliance.
| Name | Type | Description |
| SupplierQualificationQuestionResponsesResponseRepositoryId [KEY] | Long | Unique identifier for the repository storing the responses. This ID helps link the specific attachment to the response repository where the responses are saved. |
| ValuesResponseRepositoryValueId [KEY] | Long | Unique identifier for the value within the response repository. This ID links the specific response value to the document or attachment in the response repository. |
| AttachedDocumentId [KEY] | Long | Unique identifier for the document attached to the response. This ID refers to the document stored in the system associated with the supplier's response. |
| LastUpdateDate | Datetime | Date and time when the attachment record was last updated. This is useful for tracking changes to the attachment details. |
| LastUpdatedBy | String | User who last updated the attachment record. This helps track who modified the attachment details. |
| DatatypeCode | String | Abbreviation that identifies the data type of the attachment. Accepted values include 'FILE', 'FOLDER', 'TEXT', or 'WEB_PAGE', which specify the type of the attachment. |
| FileName | String | The name of the file attached to the response. This is the original filename as provided when the document was uploaded. |
| DmFolderPath | String | Path in the document management system (DMS) where the attachment is stored. This path provides the location of the file within the system. |
| DmDocumentId | String | Unique identifier for the document in the document management system (DMS). This ID links to the document stored in the system. |
| DmVersionNumber | String | Version number of the attached document. This number helps track the versioning of attachments and whether multiple versions exist. |
| Url | String | Uniform Resource Locator (URL) that identifies the location of the attached document. This URL can be used to access the attachment directly. |
| CategoryName | String | Category under which the attachment is classified. This can help organize the attachment based on type or usage, such as 'Legal' or 'Technical'. |
| UserName | String | The username of the person who uploaded the document or attachment. This is useful for identifying who contributed the attachment. |
| Uri | String | Uniform Resource Identifier (URI) that identifies the attachment. It is used to access the file or locate it within the document management system. |
| FileUrl | String | URL pointing to the location of the attachment. This link can be used to download or view the file. |
| UploadedText | String | Text content that was uploaded along with the attachment. This is typically a description or metadata related to the attachment. |
| UploadedFileContentType | String | The content type of the uploaded file, indicating its format. |
| UploadedFileLength | Long | Length in bytes of the uploaded file. This gives an idea of the file size. |
| UploadedFileName | String | The name of the file as uploaded by the user. This could include a timestamp or unique identifier. |
| ContentRepositoryFileShared | Bool | Indicates whether the file is shared across multiple users or systems. If true, the file is shared; if false, it is not. The default value is 'false'. |
| Title | String | The title or name of the attachment. This can provide context for the file's content or purpose. |
| Description | String | A textual description of the attached file's content, purpose, or relevance to the qualification process. |
| ErrorStatusCode | String | Error code associated with the attachment. If an error occurs, this code helps identify the problem. |
| ErrorStatusMessage | String | Message describing the error associated with the attachment. This can help with troubleshooting if there is an issue with the attachment. |
| CreatedBy | String | User who created the attachment record. This is the individual responsible for initially uploading the file. |
| CreationDate | Datetime | Date and time when the attachment record was created. This helps track when the document was first added to the system. |
| FileContents | String | The actual content of the attachment in text format, if applicable. This field may contain metadata or extracted text from the file. |
| ExpirationDate | Datetime | Date when the attachment expires or is no longer considered valid. This is useful for time-sensitive documents. |
| LastUpdatedByUserName | String | Username of the user who last updated the attachment record. This allows tracking of who modified the attachment details. |
| CreatedByUserName | String | Username of the user who created the attachment record. |
| AsyncTrackerId | String | Identifier used for tracking asynchronous file uploads or processing. This helps monitor the status of file uploads or transformations. |
| FileWebImage | String | Base64 encoded image of the file if the source is a convertible image (for example, for image files converted to PNG format). |
| DownloadInfo | String | JSON object containing information used to programmatically retrieve the attached file. This includes data about the file's location and access. |
| PostProcessingAction | String | Action that can be performed after the attachment is uploaded. This may include actions like 'extract text' or 'convert format'. |
| Finder | String | Search term or keyword that helps find this attachment record in the system. This is helpful for filtering and locating the attachment easily. |
| ResponseRepositoryId | Long | Unique identifier for the repository where the responses and attachments are stored. This ID links the attachment to the relevant response repository. |
Defines the questions used in supplier qualification, covering areas like safety standards or financial viability.
| Name | Type | Description |
| QuestionId [KEY] | Long | Unique identifier for the question. This ID is used to reference the specific question in the system. |
| Revision | Int | Number that identifies the revision of this question. Revision 0 is the base revision, and subsequent revisions are created as updates to the original question. |
| Question | String | The question text or identifier entered by the user. This is the actual question to be displayed to responders. |
| QuestionLevelCode | String | Abbreviation that identifies whether the question is relevant to a supplier or to a supplier site. Accepted values are defined in the lookup type 'POQ_QUESTION_LEVEL'. This can be reviewed in the Setup and Maintenance work area, in the Manage Standard Lookups task. |
| QuestionLevel | String | The level at which the question is relevant, either to the supplier or to the supplier site. |
| ResponderTypeCode | String | Abbreviation identifying the type of responder for the question. Valid values are 'SUPPLIER', 'INTERNAL', or 'AUTOMATIC'. Refer to the lookup type 'POQ_RESPONDER_TYPE' for accepted values, available in the Setup and Maintenance work area. |
| ResponderType | String | Value identifying the type of responder for the question. Valid types include 'SUPPLIER', 'INTERNAL', or 'AUTOMATIC'. |
| SupplierAttributeFlag | Bool | Indicates whether the question is mapped to an attribute from the supplier profile. If true, it is mapped; if false, it is not. The default value is false. |
| SupplierAttributeCode | String | Abbreviation identifying the supplier attribute this question is mapped to. Valid values include 'ADDITIONAL_INFORMATION', 'BUSINESS_CLASSIFICATION', 'CORPORATE_PROFILE', 'INCOME_TAX', 'PRODUCTS_AND_SERVICES', 'SUPPLIER_SITE', or 'TRANSACTION_TAX'. |
| SupplierAttribute | String | The specific supplier attribute that this question is mapped to. |
| QuestionTypeCode | String | Abbreviation identifying the type of question. Valid values are 'MCSS' (multiple choice single selection), 'MCMS' (multiple choice multiple selection), or 'INPUT_BOX' (text entry box). Refer to the lookup type 'POQ_QUESTION_TYPE' for valid values. |
| QuestionType | String | The type of question, such as 'multiple choice single selection', 'multiple choice multiple selection', or 'text entry box'. |
| QuestionStatusCode | String | Abbreviation identifying the status of the question. Accepted values are defined in the lookup type 'POQ_QUESTION_STATUS'. This can be reviewed in the Setup and Maintenance work area. |
| QuestionStatus | String | Value identifying the current status of the question (for example, 'ACTIVE', 'INACTIVE'). |
| OwnerId | Long | Unique identifier for the owner of the question. This identifies who owns or is responsible for the question. |
| Owner | String | Name of the owner of the question. |
| DisplayPreferredResponseFlag | Bool | Indicates whether the preferred response should be displayed to the supplier, if available. If true, it is displayed; if false, it is not. Default is false. |
| CriticalQuestionFlag | Bool | Indicates whether the question is critical for evaluation. If true, the question is critical for assessment; if false, it is not. Default is false. |
| ResponseRequiredFlag | Bool | Indicates whether a response is required for this question. If true, a response must be provided; if false, it is optional. Default is true. |
| AllowResponderCommentsFlag | Bool | Indicates whether the responder can provide free text comments when responding to the question. If true, comments can be entered; if false, they cannot. Default is false. |
| QuestionText | String | The full text of the question as it will be displayed to responders on a questionnaire. For POST operations, this should be in Base64 encoded format. |
| QuestionHint | String | Additional information or instructions provided to responders to help them answer the question correctly. |
| SubjectCode | String | Abbreviation identifying the subject associated with the question for search purposes. Accepted values are defined in the lookup type 'POQ_SUBJECT'. This can be reviewed in the Setup and Maintenance work area. |
| Subject | String | The subject associated with the question, used for search filtering. |
| StandardsOrganizationCode | String | Abbreviation identifying the standards organization that provides the source for this requirement. Accepted values are defined in the lookup type 'POQ_STDS_ORG'. This can be reviewed in the Setup and Maintenance work area. |
| StandardsOrganization | String | The standards organization that provides the source for the requirement. |
| ResponseTypeCode | String | Abbreviation identifying the type of response expected for the question, specifying the data type. Accepted values are defined in the lookup type 'POQ_RESPONSE_TYPE'. This can be reviewed in the Setup and Maintenance work area. |
| ResponseType | String | The type of response expected, such as 'single-line text', 'multiple-line text', 'number', 'date', 'datetime', or 'URL'. |
| PreferredResponseDate | Date | The preferred response value for questions where the response type is date. |
| PreferredResponseDatetime | Datetime | The preferred response value for questions where the response type is date and time. |
| PreferredResponseNumber | Decimal | The preferred response value for questions where the response type is a number. |
| PreferredResponseText | String | The preferred response value for questions with text-based responses (single-line, multi-line text, or URL). |
| ScoringMethodCode | String | Abbreviation identifying the scoring method for the question. Default value is 'NONE'. Accepted values are defined in the lookup type 'ORA_POQ_QUES_SCORING_METHOD'. This can be reviewed in the Setup and Maintenance work area. |
| ScoringMethod | String | The method used for scoring the question, such as 'NONE' for no scoring, 'MANUAL' for manual scoring, or other predefined methods. |
| MaximumScore | Int | The maximum score a responder can achieve for the question. This is used when the question is manually or automatically scored. |
| ScoreForNoResponse | Int | The score automatically assigned to optional questions when no response is provided. |
| ScoringApproachCode | String | Abbreviation identifying the scoring approach for this question. Accepted values are defined in the lookup type 'ORA_POQ_QUES_SCORING_APPROACH'. This can be reviewed in the Setup and Maintenance work area. |
| ScoringApproach | String | The approach used for scoring, such as 'Automatic' for multiple-choice questions, or other predefined approaches. |
| AttachmentAllowedCode | String | Abbreviation that identifies whether responders can attach documents with their responses. Accepted values are defined in the lookup type 'POQ_QUESTION_RESPONSE_ATTACH'. This can be reviewed in the Setup and Maintenance work area. |
| AttachmentAllowed | String | Indicates whether responders are allowed to attach documents when submitting their responses. Values include 'Not Allowed', 'Optional', or 'Required'. |
| LatestRevisionFlag | Bool | Indicates whether the revision is the latest revision of the question. If true, it is the latest; if false, it is not. Default is false. |
| QuestionPlainText | String | Plain text version of the question to be displayed to responders. |
| QuestionSurveyFlag | Bool | Indicates whether the question is part of a survey with multiple internal responses. If true, multiple responses are allowed; if false, only a single response is allowed. Default is false. |
| Finder | String | Search term or keyword to locate the question easily in the system. |
Lists potential valid answers or response choices for a qualification question, ensuring standardized input options.
| Name | Type | Description |
| SupplierQualificationQuestionsQuestionId [KEY] | Long | Unique identifier for the question that this acceptable response applies to. This ID links the acceptable response to a specific question. |
| AcceptableResponseId [KEY] | Long | Unique identifier for the acceptable response. This ID is used to reference and track the response within the system. |
| QuestionId | Long | Unique identifier for the question to which the acceptable response applies. This links the response to a specific question. |
| DisplaySequence | Int | Defines the order in which the acceptable responses should appear to the responder on the questionnaire for the specific question. |
| ResponseText | String | The text that represents a manually entered acceptable response value. This text is displayed as an option to the responder. |
| AttachmentAllowedCode | String | Abbreviation that identifies whether the responder is allowed to attach any documents to their responses. Valid values include 'ALLOWED', 'NOT_ALLOWED', or 'OPTIONAL'. This is defined in the lookup type 'POQ_QUESTION_RESPONSE_ATTACH'. |
| AttachmentAllowed | String | Indicates whether the responder is allowed to attach documents with their responses. Possible values include 'Allowed', 'Not Allowed', or 'Optional'. These values are defined in the lookup type 'POQ_QUESTION_RESPONSE_ATTACH'. |
| PreferredResponseFlag | Bool | Indicates whether the response is the preferred response for this question when evaluating responses. If true, this is the preferred response; if false, it is not. Default value is false. |
| CategoryId | Long | Unique identifier for the category to which this acceptable response belongs. This ID links the response to a specific category. |
| Category | String | Category of the acceptable response. This provides context for the type of response and helps in organizing and grouping responses. |
| ParentCategoryId | Long | Unique identifier for the parent category. This ID links the response category to a higher-level category, forming a category hierarchy. |
| PurchasingCategoryFlag | Bool | Indicates whether the response belongs to a purchasing category. If true, the response is associated with a purchasing category; if false, it is not. |
| AttributeId | Long | Unique identifier for the attribute linked to the acceptable response. This ID refers to a specific attribute associated with the response. |
| AttributeCode | String | Abbreviation that identifies the attribute associated with the acceptable response. This code provides further details about the nature of the response. |
| AttributeValueCode | String | Abbreviation identifying the specific value code for the attribute. This code is used to track the specific value for the attribute associated with the response. |
| OriginalAcceptableResponseId | Long | Unique identifier for the original acceptable response associated with a question revision. This ID links the original response to any subsequent revisions of the question. |
| Score | Int | Score automatically assigned to the response if the user selects the corresponding acceptable response. This score is used to evaluate the response during the scoring process. |
| CriticalResponseFlag | Bool | Indicates whether this response is critical for evaluation. If true, the response is critical for evaluation; if false, it is not. The default value is false. |
| ExcludeScoringFlag | Bool | Indicates whether the response is excluded from scoring. If true, the response is not scored; if false, the response is included in the scoring. The default value is false. |
| Finder | String | Search keyword or term used to locate the acceptable response in the system. |
Indicates subsequent branching logic for a given response, posing follow-up questions based on the initial answer.
| Name | Type | Description |
| SupplierQualificationQuestionsQuestionId [KEY] | Long | Unique identifier for the question in the 'SupplierQualificationQuestionsacceptableResponsesbranches' table. This ID links to the main question in the system that the branch response applies to. |
| AcceptableresponsesAcceptableResponseId [KEY] | Long | Unique identifier for the acceptable response related to the branching logic. This ID references the response that triggers the branching. |
| QuestionBranchesId [KEY] | Long | Unique identifier for the question branch. This ID is used to uniquely identify a specific branch logic that associates a response with a follow-up question. |
| AcceptableResponseId | Long | Unique identifier for the acceptable response that links the branch logic. This ID defines which response will trigger the branching logic. |
| DisplaySequence | Int | Specifies the order in which the branching question should be displayed when the user selects a particular acceptable response. The sequence number helps to define the display flow of the questions. |
| BranchToQuestionId | Long | Unique identifier for the follow-up question to which the user will be directed once they select the acceptable response. This ID helps in guiding the user to the next relevant question in the flow. |
| Question | String | Text or identifier of the branching question. This is the question that will appear when the branch logic is triggered by the selected response. |
| Finder | String | Search keyword or term used to locate the branching logic or response in the system. This is helpful for identifying or retrieving the branching logic during searches. |
| QuestionId | Long | Unique identifier for the question that applies to this branching response logic. This ID links the branching logic to a specific question. |
Holds documents (images, policy PDFs) linked to a question, giving respondents extra context or references.
| Name | Type | Description |
| SupplierQualificationQuestionsQuestionId [KEY] | Long | Unique identifier for the question to which the attachment is associated. This ID links the attachment to a specific question. |
| AttachedDocumentId [KEY] | Long | Unique identifier for the attachment. This primary key is generated by the application when a document is attached to a question. The ID helps in tracking and referencing the attachment. |
| LastUpdateDate | Datetime | Timestamp of when the attachment was last updated. This helps in tracking changes made to the attachment. |
| LastUpdatedBy | String | Username of the person who last updated the attachment. This provides traceability for any modifications to the attachment. |
| DatatypeCode | String | Abbreviation that identifies the type of data in the attachment. Accepted values typically include FILE, FOLDER, TEXT, or WEB_PAGE. |
| FileName | String | Name of the attachment file. This field stores the original name of the file that was uploaded. |
| DmFolderPath | String | Path within the document management system where the attachment is stored. |
| DmDocumentId | String | Unique identifier for the document in the document management system. This helps in linking the document to the system for retrieval. |
| DmVersionNumber | String | Version number of the attachment. It identifies the specific version of the document in case of updates or revisions. |
| Url | String | URL (Uniform Resource Locator) that directly locates the attachment in the system. |
| CategoryName | String | Category associated with the attachment. This could be used to group similar types of attachments, such as contracts or proposals. |
| UserName | String | Username of the person who uploaded the attachment. This helps identify the uploader of the document. |
| Uri | String | Uniform Resource Identifier (URI) that identifies the location of the attachment in the system. |
| FileUrl | String | Full URL (Uniform Resource Locator) used to access the attachment. |
| UploadedText | String | Text content that may be included in the attachment. This could be descriptive or textual content related to the file. |
| UploadedFileContentType | String | The content type of the uploaded file, indicating its format. |
| UploadedFileLength | Long | Size of the uploaded file, typically in bytes. This field is used to track the file size. |
| UploadedFileName | String | Name of the uploaded file as it is stored in the system after the upload. |
| ContentRepositoryFileShared | Bool | Indicates whether the file is shared with others. Acceptable values: true (shared) or false (not shared). The default value is false. |
| Title | String | Title of the attachment. This is a short description of the document to provide context to users. |
| Description | String | Description of the attachment. This provides more detailed information about the attachment's content. |
| ErrorStatusCode | String | Error code associated with the attachment, if any. This code helps identify the issue with the attachment if it fails to upload or has problems. |
| ErrorStatusMessage | String | Descriptive text explaining the error encountered while uploading or processing the attachment. |
| CreatedBy | String | Username of the person who initially created or uploaded the attachment. |
| CreationDate | Datetime | Date and time when the attachment was originally created or uploaded. |
| FileContents | String | Textual or encoded representation of the file contents. This is typically used for previewing text-based files. |
| ExpirationDate | Datetime | Date when the attachment's content is set to expire or become invalid. |
| LastUpdatedByUserName | String | Username of the person who last modified or updated the attachment. |
| CreatedByUserName | String | Username of the person who created or uploaded the attachment, useful for tracking origins. |
| AsyncTrackerId | String | Identifier used for tracking asynchronous file uploads, if the system handles file uploads in the background. |
| FileWebImage | String | Base64-encoded image representation of the file, used for displaying the file as an image, such as a .png preview. |
| DownloadInfo | String | JSON string containing information needed to retrieve the attachment programmatically. |
| PostProcessingAction | String | Action to be performed after the attachment is uploaded, such as indexing or virus scanning. |
| Finder | String | Search keyword used to locate the attachment in the system. This is helpful for users to quickly search for specific documents. |
| QuestionId | Long | Unique identifier for the question that this attachment is linked to. This helps to associate the document with the specific qualification question. |
Applies scoring rules (for example, numeric weighting) to question responses, letting evaluators quantify supplier qualification results.
| Name | Type | Description |
| SupplierQualificationQuestionsQuestionId [KEY] | Long | Unique identifier for the qualification question to which this score is associated. This links the score to a specific question. |
| QuestionScoreId [KEY] | Long | Unique identifier for the score record associated with a specific question. This ID helps in tracking and referencing individual scoring records for a question. |
| QuestionId | Long | Unique identifier for the question related to this scoring record. This connects the score to the particular question being evaluated. |
| Score | Int | The numerical score to be assigned to responses that fall within the range defined by `FromResponseValue` and `ToResponseValue`. This value indicates how well a response aligns with the expected answer range. |
| FromResponseValue | Decimal | The lowest acceptable response value for this scoring row. If this field is NULL, then there is no minimum threshold for the score range. This allows flexibility in defining scoring ranges. |
| ToResponseValue | Decimal | The highest acceptable response value for this scoring row. If this field is NULL, there is no maximum threshold for the score range. This means responses can be accepted above the specified upper value. |
| CriticalResponseFlag | Bool | Indicates whether the score range is critical for evaluation. Acceptable values: true (critical for evaluation) or false (not critical). The default value is false. This flag helps in identifying important score ranges. |
| Finder | String | Search term used to locate the scoring record in the system. This keyword helps users to quickly find the associated question score when performing queries. |
Tracks geographic data (country, region) for supplier addresses, enforcing location-based validations during registration.
| Name | Type | Description |
| GeographyIdentifierId [KEY] | Long | Unique identifier for the geography record. This identifier is used to reference and distinguish different geographical records within the supplier registration system. |
| CountryCode | String | The country code associated with the geographical area. This code should follow the ISO 3166-1 alpha-2 standard, which consists of two-letter country codes. For example, 'US' for the United States or 'IN' for India. |
| GeographyType | String | The type of geography associated with the supplier's address. Accepted values can include 'Region', 'District', 'Country', 'State', and 'City', depending on the structure of the address system. Review the values in the setup. |
| IdentifierType | String | The type of identifier used to categorize the geography. Common values include 'ZIP Code', 'Postal Code', and 'Region ID', depending on the classification system used for geographies. |
| GeographyValue | String | The actual value of the geography, such as the ZIP code, state name, or region name. This field contains the specific data for the geography in question. |
| StartDate | Date | The start date for the validity of the geography. This field defines the beginning of the period during which the geographical area is considered applicable to the supplier's registration. |
| EndDate | Date | The end date for the validity of the geography. This field indicates the expiration or conclusion date of the geographical area’s relevance to the supplier's registration. |
| GeographyLevel2Value | String | A more specific geographical value within level 2 of the geography hierarchy. This might refer to a province, state, or region depending on the country's address structure. |
| GeographyLevel3Value | String | A more specific geographical value within level 3 of the geography hierarchy. This might refer to a district, city, or neighborhood. |
| GeographyLevel4Value | String | A more specific geographical value within level 4 of the geography hierarchy. This might refer to a sub-district, locality, or zone. |
| GeographyLevel5Value | String | A more specific geographical value within level 5 of the geography hierarchy. This might refer to a specific block or sector within a city or area. |
| PrimaryGeographyFlag | Bool | Indicates whether this geography is the primary one for the supplier's address. Acceptable values: true (primary) or false (not primary). This flag marks the most important geography level for the supplier. |
| PrimaryGeographyLevel2Flag | Bool | Indicates whether this geography is the primary geography for level 2 (for example, state or region). Acceptable values: true (primary) or false (not primary). |
| PrimaryGeographyLevel3Flag | Bool | Indicates whether this geography is the primary geography for level 3 (for example, district or city). Acceptable values: true (primary) or false (not primary). |
| PrimaryGeographyLevel4Flag | Bool | Indicates whether this geography is the primary geography for level 4 (for example, sub-district or locality). Acceptable values: true (primary) or false (not primary). |
| PrimaryGeographyLevel5Flag | Bool | Indicates whether this geography is the primary geography for level 5 (for example, block or sector). Acceptable values: true (primary) or false (not primary). |
| Finder | String | Search term used to locate the geography record in the system. This keyword is helpful for users to easily find the specific geographical record when querying the database. |
| GeographyValueParam | String | Additional parameter or custom value associated with the geography. This can be used for custom filtering or querying based on specific geographical criteria. |
Defines distinct layouts for addresses in various countries, aligning supplier registration with local postal standards.
| Name | Type | Description |
| CountryCode [KEY] | String | The country code associated with the address style format. This code should follow the ISO 3166-1 alpha-2 standard, which consists of two-letter country codes. For example, 'US' for the United States or 'IN' for India. |
| CountryName | String | The full name of the country associated with the address style format. This name should match the official English name of the country as recognized internationally, such as 'United States' or 'India'. |
| StyleFormatCode | String | A unique code that identifies the specific style format used for address formatting in the supplier registration. This code may vary depending on how address styles are organized and configured in the system. |
| StyleFormatName | String | The name of the address style format. This name describes the format used for addressing and could include terms like 'Standard Format', 'Postal Format', or 'Custom Format'. |
| BindCountryCode | String | The country code that is bound to the style format. This refers to the country whose address formatting guidelines are being applied. It helps to identify the appropriate style format to use for that particular country. |
| BindStyleCode | String | A unique code that binds the style format to a specific address style. This can be a reference to the particular address structure, like whether it follows a 'Standard' or 'Custom' style for that country. |
| Finder | String | Search term or keyword that helps locate and identify the address style format within the system. This field aids in quick lookup and query of the style format records. |
Describes how address components (street, city, postal code) are placed in a given address format layout.
| Name | Type | Description |
| SupplierRegistrationAddressStyleFormatsCountryCode [KEY] | String | The country code associated with the address style format layout. This code should follow the ISO 3166-1 alpha-2 standard, consisting of two-letter country codes. For example, 'US' for the United States or 'IN' for India. |
| AttributeLabel | String | A label describing the attribute used in the address style format layout. This label typically serves as a human-readable name for the field or section of the address, such as 'Street Name', 'City', or 'Postal Code'. |
| AttributeName | String | The technical or system name for the address attribute. This is typically used in coding or backend systems and represents the attribute's variable name, such as 'street_name' or 'postal_code'. |
| GeographyLevel | Int | The level of geography to which the address field belongs, such as '1' for country, '2' for region/state, or '3' for city. This helps in structuring the address data based on geographical hierarchy. |
| GeographyType | String | The type of geography that the attribute pertains to, such as 'Country', 'State', 'City', or 'District'. This defines the geographic component of the address field. |
| MandatoryFlag | Bool | Indicates whether the address attribute is mandatory for completion. If true, the field is required; if false, the field is optional. For example, 'true' could be set for a postal code field, while 'false' might apply to an optional second address line. |
| LineNumber | Int | The line number in the address layout. This defines the sequence in which address components (like street or city) are displayed in the final address format. |
| Position | Int | The specific position of an address component within a line. For example, the position might refer to whether the street address appears before the city or vice versa. |
| UppercaseFlag | Bool | Indicates whether the address field should be converted to uppercase. If true, all values for this field (for example, street names, cities) will be displayed in uppercase letters. |
| DelimiterBefore | String | The character or string used as a delimiter before the address component. For example, this could be a comma, a space, or a specific punctuation mark that separates address elements. |
| DelimiterAfter | String | The character or string used as a delimiter after the address component. Similar to 'DelimiterBefore', this marks the separation between components in the address layout. |
| BindCountryCode | String | The country code to which the address style format layout is bound. This links the layout format to a specific country (for example, 'US' for the United States, 'IN' for India), influencing how the address fields are displayed and formatted. |
| BindStyleCode | String | A code that binds the address layout to a specific style format. This could correspond to a predefined address style (like 'Postal', 'Standard', or 'Custom') that dictates how the fields are organized. |
| CountryCode | String | The country code used for the address style format layout. This code follows the ISO 3166-1 alpha-2 standard, which uses two-letter codes to represent countries (for example, 'US' for the United States). |
| Finder | String | A search term or keyword used to quickly locate the address style format layout in the system. This can help users find the layout by its relevant attributes or configuration names. |
Presents valid bank branch lookups for supplier bank account setup, ensuring precise banking details in registrations.
| Name | Type | Description |
| BranchPartyId [KEY] | Long | Unique identifier for the branch party in the system. It refers to the entity or party associated with the bank branch in the supplier registration system. |
| BankBranchName | String | The name of the bank branch. This field typically contains the full branch name as provided by the bank. |
| BranchNumber | String | A unique identifier or number assigned to the bank branch by the financial institution. This number may be used for transactions or in systems where a unique identification for each branch is required. |
| BankName | String | The name of the bank to which the branch belongs. This is typically the full legal name of the bank. |
| BindBankHomeCountry | String | The country where the bank is headquartered. This country code is typically based on the ISO 3166-1 standard, such as 'US' for the United States or 'IN' for India. |
| BindBankName | String | The name of the bank to which this branch is affiliated. This field provides the exact name as defined in the system or financial institution records. |
| BindBankNumber | String | The identifier for the bank, which could be a SWIFT code, IBAN, or other banking code used to uniquely identify the bank branch within financial systems. |
| BindBankPartyNumber | String | The unique identifier for the party or entity associated with the bank. This number is used for linking the branch information to the correct financial institution or party in the system. |
| BindBranchName | String | The name of the bank branch as it is registered in the system. This is typically the official name used to identify the branch in the banking network. |
| BindBranchNumber | String | The number associated with the specific bank branch, used for transactions or identification within financial systems. It may be unique within the bank. |
| BindBranchPartyNumber | String | The unique identifier assigned to the branch party in the system, used for associating the branch with a specific party or organizational entity. |
| BindEFTSWIFTCode | String | The SWIFT code or EFT (Electronic Funds Transfer) code for the bank branch. This code is used for international transactions to identify the bank branch. |
| Finder | String | A search term or keyword used to locate the bank branch records in the system. This can be based on any relevant attribute such as branch name, number, or other identifying features. |
| SearchTerm | String | A generic term used for searching and filtering the bank branch records in the system. This could include branch name, bank name, or other relevant descriptors used to locate the branch. |
Lists recognized banks usable in supplier registration flows, allowing accurate banking information and payment routing.
| Name | Type | Description |
| BankName | String | The full legal name of the bank. This is typically the name that the bank is known by in public records and financial systems. |
| BankNumber | String | A unique identifier or number assigned to the bank. This could be a local number, SWIFT code, or other institution-specific identifier used in banking transactions. |
| BankPartyId [KEY] | Long | A unique identifier that corresponds to the bank party in the system, used to associate a bank to a specific entity or party within the system. |
| BindBankName | String | The official name of the bank as referenced in the system. This is the name used for internal identification and may be used for processing bank-related transactions. |
| BindBankNameAlt | String | An alternate name or alias for the bank that may be used in certain contexts. This could be a shortened or more commonly recognized version of the full bank name. |
| BindBankNumber | String | The identifier for the bank assigned in the system. This could be an internal number, an IBAN, or a SWIFT code used to uniquely identify the bank in financial systems. |
| BindBankPartyNumber | String | The identifier associated with the bank's party or entity. This number is used to link the bank to the correct organizational entity or legal structure. |
| BindCountryName | String | The country in which the bank is based or headquartered. This value should correspond to the full country name, such as 'United States' or 'Germany.' |
| BindDescription | String | A description of the bank or additional details about the bank's role, features, or characteristics as relevant in the supplier registration process. |
| BindHomeCountryCode | String | The code representing the country where the bank is located. This code typically follows the ISO 3166-1 standard, such as 'US' for the United States or 'IN' for India. |
| BindTaxpayerIdNumber | String | The taxpayer identification number for the bank. This unique identifier is used for tax and regulatory purposes and can be required in financial transactions. |
| Finder | String | A search term or keyword used to locate records of banks in the system. This could be based on any attribute such as bank name, number, or other identifying information. |
| SearchTerm | String | A term used for searching and filtering bank records in the system. It can be any relevant descriptor used to locate the bank, including bank name, number, or country. |
Lists agencies authorized to certify supplier business classifications (for example, small business, minority-owned), ensuring accurate accreditation data.
| Name | Type | Description |
| CertifyingAgencyId [KEY] | Long | A unique identifier for the certifying agency in the system. This ID is used to link the agency to specific records or certifications. |
| CertifyingAgency | String | The name of the certifying agency. This is typically the official organization responsible for issuing certifications for the supplier in relevant industries. |
| Description | String | A detailed description of the certifying agency, including the scope of its certifications and the industries or areas it governs. |
| ClassificationCode | String | A code used to classify the certifying agency based on its type or area of expertise. This code can represent various agency classifications, such as industry sector or certification type. Accepted values may vary based on the industry. |
| Finder | String | A search term or keyword that allows for easy retrieval of certifying agencies in the system. This could be based on the agency's name, classification, or other relevant terms. |
Enables retrieval of prospective and spend-authorized registration configurations, controlling mandatory fields and setup details for supplier signups.
| Name | Type | Description |
| SupplierRegistrationConfigId [KEY] | Long | A unique identifier for the supplier registration configuration. This ID is used to link the configuration settings to specific supplier registration processes. |
| SupplierEntityCode | String | The code used to identify the type or category of the supplier entity. This could represent various types of supplier organizations, such as manufacturer, service provider, or distributor. Accepted values may depend on the supplier classification system. |
| ProspectiveConfigCode | String | A configuration code used to specify the setup or requirements for a prospective supplier. This code could define certain qualification or registration criteria for suppliers that are being considered for inclusion in the system. |
| SpendAuthorizedConfigCode | String | A configuration code used to define the authorized spending limits or conditions for a supplier. This code typically controls which suppliers are authorized to engage in transactions based on predefined spend limits or categories. |
| Finder | String | A search term or keyword used to locate and retrieve configurations in the system. This could include terms related to the configuration name, code, or other identifiers that help users easily find the relevant configuration. |
Defines supplier registration flow options (for example, attachments required, tax ID fields), shaping the onboarding experience and required data.
| Name | Type | Description |
| SupplierRegistrationOptionsId [KEY] | Long | A unique identifier for the supplier registration options configuration. This ID links the specific registration options to the supplier setup process. |
| ExternalRegRequireTaxIdFlag | Bool | Indicates whether a tax identification number is required for external registration. If true, the registration process mandates the supplier to provide a valid tax ID. If false, the tax ID is not required. |
| ExternalRegRequireAttachCode | String | A code that specifies whether external registration requires the submission of specific attachments, such as documents or certificates. The code helps determine what documents are mandatory for registration. |
| IBANSupportedCountries | String | A list of countries where International Bank Account Numbers (IBAN) are supported for the supplier's bank account details. This field helps to define which regions can use IBAN for international transactions. |
| LoqateEnabledFlag | Bool | Indicates whether the Loqate service is enabled for address validation during registration. If true, Loqate is used to validate and standardize address data provided by the supplier. |
| LoqateURL | String | The URL for the Loqate service used in address validation. This URL is used to connect to the Loqate API for address verification. |
| DfEnabledFlag | Bool | Indicates whether the Df (Dynamic Forms) service is enabled for the supplier registration process. If true, dynamic forms are used to collect supplier information during registration. |
| ObnEnabledFlag | Bool | Indicates whether the OBN (Open Business Network) service is enabled for the registration process. If true, suppliers will be integrated with OBN for sharing and validation of business information. |
| DfObnAccessToken | String | The access token required to authenticate with the Df OBN service. This token ensures secure communication between the registration system and OBN for data exchange. |
| DfObnURI | String | The Uniform Resource Identifier (URI) that points to the Df OBN service endpoint. This URI is used to connect to the OBN service for exchanging data and validating business credentials. |
| DisplayContactUserAccountFlag | Bool | Indicates whether the contact user's account details are displayed during the supplier registration process. If true, the account information of the contact user is shown; otherwise, it is hidden. |
| BankAccountAttachments | String | Specifies the types of attachments required for bank account validation during the registration process. This may include bank statements or other relevant documents. |
| Finder | String | A search term or keyword used to locate supplier registration options. This can be used to quickly identify and retrieve specific registration configurations or criteria. |
Enumerates valid country dialing codes for supplier phone numbers, aligning registration data with international standards.
| Name | Type | Description |
| PhoneCountryCodeId [KEY] | Long | A unique identifier for the phone country code. This ID links each specific country code to the supplier registration process. |
| PhoneCountryCode | String | The international phone country code that corresponds to the supplier's location. It is used to format and validate phone numbers entered during registration. For example, '1' for the United States or '44' for the United Kingdom. |
| TerritoryShortName | String | A short name or abbreviation representing the territory or country associated with the phone country code. For instance, 'US' for the United States or 'UK' for the United Kingdom. |
| TerritoryCode | String | A longer code representing the territory or country associated with the phone country code. This could be an official country code such as 'USA' for the United States or 'GBR' for the United Kingdom. |
| PhoneLength | Decimal | The standard length of phone numbers, excluding the area code, for the specified territory. This value helps in validating phone numbers and ensuring they meet local standards. |
| AreaCodeLength | Decimal | The length of the area code for phone numbers in the specified territory. It is important for validating whether the area code provided by the supplier matches the expected format. |
| TrunkPrefix | String | The trunk prefix used for dialing within the country. For instance, in the United States, the trunk prefix is '1', while in other countries, it may vary. |
| IntlPrefix | String | The international dialing prefix used to make international calls from the specified country. For example, the international dialing prefix is '011' in the United States and '00' in many European countries. |
| ValidationProc | String | The validation procedure or algorithm used to verify the phone number format. This field specifies how the system checks if a phone number is valid for the given territory, including rules for length and structure. |
| TimezoneId | Long | A unique identifier for the time zone associated with the phone country code. This is used to ensure that business hours and other time-sensitive details are properly aligned with the supplier's time zone. |
| FndTerritoryCode | String | An additional code used to represent the country or territory in other systems or processes. This could be a code used internally within the organization or a region-specific code. |
| Finder | String | A search term or keyword used to locate a specific phone country code entry. This can help quickly identify and retrieve the correct phone code configuration for a given territory. |
Retrieves categories (for example, office supplies, IT services) used to classify supplier offerings during registration.
| Name | Type | Description |
| CategoryName | String | The name of the product or service category. This field categorizes the supplier's products and services to facilitate sorting, searching, and reporting. It is used to group similar types of products and services together. Example values might include 'Electronics,' 'Software,' or 'Furniture.' |
| CategoryId [KEY] | Long | A unique identifier for each product or service category. This ID is used internally to link each category to specific supplier records. The category ID helps maintain consistency in the categorization system. |
| CategoryDescription | String | A detailed description of the category, providing additional context about the type of products or services included in that category. It helps users understand what types of goods or services fall under this category. For example, 'Electronics' might include computers, mobile phones, and accessories. |
| ParentCategoryId | Long | A unique identifier for the parent category, if this category is a subcategory. It indicates the higher-level category to which this category belongs. For instance, a 'Mobile Phones' category might have a parent category of 'Electronics.' |
| PurchasingCatFlag | Bool | A flag that indicates whether the category is used for purchasing purposes. If true, this category is available for use in purchasing processes. If false, the category is not used in purchasing workflows, but might still be useful for other organizational purposes, such as inventory management. |
| Finder | String | A search term or keyword used to locate specific product or service categories. This field can contain terms that help users quickly find categories when searching in the system. For example, 'laptops,' 'software,' or 'building materials.' |
| SearchKeyword | String | Keywords associated with the category that help improve searchability. These keywords are typically used by search engines or internal search tools to assist users in finding categories more easily. They can be synonyms or related terms to help with navigation and search accuracy. |
Tracks subcategories under primary product and service classifications, enabling multi-level supplier categorization.
| Name | Type | Description |
| SupplierRegistrationProductsAndServicesLOVCategoryId [KEY] | Long | A unique identifier for each product or service category in the child categories. This ID links the category to the parent category in the system, facilitating the organization of products and services into a hierarchical structure. |
| CategoryName | String | The name of the child product or service category. This name represents a subgroup of products or services that fall under a larger parent category. For example, a child category could be 'Smartphones' under the parent category 'Electronics.' |
| CategoryId [KEY] | Long | A unique identifier for the child category. This ID is used within the system to uniquely identify and reference the child category. It helps manage subcategories and their related products or services. |
| CategoryDescription | String | A detailed description of the child category. This field provides additional information about the types of products or services included in the category. It helps users better understand what is offered within that specific child category. |
| ParentCategoryId | Long | The unique identifier for the parent category to which this child category belongs. It is used to establish a relationship between parent and child categories, helping to organize products and services in a hierarchical structure. For example, 'Laptops' might have a parent category of 'Computers.' |
| PurchasingCatFlag | Bool | A flag indicating whether this child category is used in the purchasing process. If true, this category can be selected during procurement workflows. If false, it might be used for other purposes such as classification or reporting, but not for purchasing. |
| Finder | String | A search term or keyword used to locate the child category. This term helps users find the category quickly when searching through the system. Example search terms might include 'Mobile Phones,' 'Desktops,' or 'Home Appliances.' |
| SearchKeyword | String | Keywords that help improve searchability for the child category. These terms are used by search tools to make it easier for users to find relevant categories. Keywords could include synonyms, related terms, or specific product names tied to the child category. |
Handles supplier-provided answers to registration questionnaires, capturing additional information like financial details or compliance data.
| Name | Type | Description |
| SupplierRegistrationKey [KEY] | String | A unique identifier assigned to each supplier registration. This key links the supplier’s registration details with questionnaire responses, ensuring that the responses are tied to the correct supplier. |
| QuestnaireRespHeaderId [KEY] | Long | A unique identifier for the questionnaire response header. This ID groups related questionnaire responses together, providing a reference point for all questions and answers within a specific questionnaire. |
| QuestnaireId | Long | The unique identifier of the questionnaire being answered. This ID is used to reference the specific questionnaire to which the responses belong. |
| QuestnaireTypeCode | String | An abbreviation or code that identifies the type of questionnaire. The code helps classify questionnaires based on their purpose or the kind of information they gather. Accepted values are typically defined in the lookup type for questionnaire types. |
| QuestionnaireType | String | A textual description of the type of questionnaire. This field provides a more readable reference to the type of questions being asked, such as 'Supplier Registration' or 'Compliance Check.' |
| ProcurementBUId | Long | A unique identifier for the procurement business unit (BU) associated with the supplier's questionnaire response. This ID links the response to the specific business unit responsible for managing the procurement process. |
| ProcurementBU | String | The name of the procurement business unit that is responsible for the supplier’s questionnaire. This name helps identify the unit within the organization that is overseeing supplier registration and qualification. |
| ResponseStatusCode | String | An abbreviation that identifies the current status of the questionnaire response. Examples might include values like 'PENDING,' 'COMPLETED,' or 'REJECTED.' Accepted values are defined in the lookup type for response statuses. |
| ResponseStatus | String | A textual description of the current status of the questionnaire response. This status reflects whether the response has been submitted, reviewed, or needs further action. |
| Introduction | String | An introductory text or explanation provided at the beginning of the questionnaire. This field can be used to offer context or instructions to the supplier before they begin answering the questions. |
| SupplierRegId | Long | The unique identifier for the supplier registration process. This ID links the supplier's questionnaire responses to their official registration within the system. |
| SupplierId | Long | The unique identifier for the supplier who completed the questionnaire. This ID is used to tie the responses to the specific supplier and retrieve their details. |
| SupplierName | String | The name of the supplier who provided the questionnaire responses. This field represents the full legal name of the supplier organization. |
| Finder | String | A search term or keyword that helps locate the supplier registration questionnaire responses within the system. This term can be used to streamline searches for specific responses or supplier details. |
Facilitates attachments (for example, supporting documents) to questionnaire responses, adding evidence or documentation during supplier onboarding.
| Name | Type | Description |
| SupplierRegistrationQuestionnaireResponsesQuestnaireRespHeaderId [KEY] | Long | A unique identifier for the header of the questionnaire response. This ID links the attached documents to the specific questionnaire response header. |
| SupplierRegistrationQuestionnaireResponsesSupplierRegistrationKey [KEY] | String | A unique key that links the attachment to the supplier’s registration process. It ensures that the attachment is associated with the correct supplier registration record. |
| AttachedDocumentId [KEY] | Long | A unique identifier assigned to the attached document. This ID is generated when a document is attached to the questionnaire response and is used to track the file. |
| LastUpdateDate | Datetime | The date and time when the attached document was last updated. This field is used to track the most recent modification to the attachment. |
| LastUpdatedBy | String | The user who last updated the attached document. This field records who made the most recent change to the attachment. |
| DatatypeCode | String | An abbreviation that identifies the type of data for the attached document. Values might include 'FILE', 'TEXT', 'IMAGE', or 'PDF'. A list of accepted values is typically defined in a lookup type. |
| FileName | String | The name of the file attached to the questionnaire response. This field represents the file name as it was uploaded. |
| DmFolderPath | String | The folder path in the document management system (DMS) where the attached document is stored. |
| DmDocumentId | String | A unique identifier for the document in the document management system (DMS). This ID is used to track the document in the system. |
| DmVersionNumber | String | The version number of the attached document in the document management system (DMS). Each update to the document is assigned a new version number. |
| Url | String | The URL where the attached document can be accessed. This link points directly to the document in the system. |
| CategoryName | String | The category to which the attached document belongs. This could help classify the document, such as 'Contract', 'Invoice', or 'Supplier Form'. |
| UserName | String | The username of the person who uploaded the document. This field tracks the user responsible for the document attachment. |
| Uri | String | A uniform resource identifier (URI) pointing to the location of the document in the system. |
| FileUrl | String | The URL of the attached document, providing access to the file for viewing or downloading. |
| UploadedText | String | Any additional text associated with the uploaded document, such as comments or descriptions provided by the user when uploading the file. |
| UploadedFileContentType | String | The content type of the uploaded file, indicating its format. |
| UploadedFileLength | Long | The size of the uploaded file, measured in bytes. |
| UploadedFileName | String | The name of the file as it was uploaded. This might differ from the original file name if the system renames the file during the upload process. |
| ContentRepositoryFileShared | Bool | Indicates whether the file is shared in the content repository. If true, the file is shared; if false, it is not. |
| Title | String | The title or name given to the attached document. This might provide a more descriptive label than the file name. |
| Description | String | A brief description of the document attached. This field is used to describe the content or purpose of the document. |
| ErrorStatusCode | String | An abbreviation that identifies any error encountered with the document attachment process. For example, this might include values like 'UPLOAD_FAILED' or 'INVALID_FORMAT'. |
| ErrorStatusMessage | String | A detailed message describing the error encountered with the document attachment process. This provides more information about the error described in the 'ErrorStatusCode'. |
| CreatedBy | String | The user who created the attachment record. This field tracks who initially uploaded the document. |
| CreationDate | Datetime | The date and time when the attachment was created. This marks when the document was first uploaded into the system. |
| FileContents | String | The content of the file in a Base64-encoded string format. This field holds the actual content of the file that was uploaded. |
| ExpirationDate | Datetime | The date and time when the attached document expires. After this date, the document may no longer be accessible or may be flagged for review. |
| LastUpdatedByUserName | String | The username of the person who last updated the document record. This field tracks who made changes to the document or its metadata. |
| CreatedByUserName | String | The username of the person who initially created the attachment record, typically the person who uploaded the document. |
| AsyncTrackerId | String | An identifier used for tracking the status of asynchronous file uploads or processing activities. |
| FileWebImage | String | The web image of the file, typically stored in Base64 encoding, representing the file visually if it is an image or document that can be displayed. |
| DownloadInfo | String | A JSON object in string format containing information that can be used to programmatically retrieve the file attachment, such as download URL or authentication details. |
| PostProcessingAction | String | The name of an action that can be performed after the document is uploaded. This could include actions like 'APPROVE', 'REVIEW', or 'ARCHIVE'. |
| Finder | String | A search term or keyword used to locate the document attachment within the system. This term helps streamline document searches for specific content. |
| QuestnaireRespHeaderId | Long | The unique identifier for the questionnaire response header that the document is attached to. This links the document to the specific response. |
| SupplierRegistrationKey | String | The unique identifier for the supplier registration associated with this document. This ensures the attachment is linked to the correct supplier's registration record. |
Organizes questionnaire content into logical sections, grouping related questions for clarity and streamlined completion.
| Name | Type | Description |
| SupplierRegistrationQuestionnaireResponsesQuestnaireRespHeaderId [KEY] | Long | A unique identifier for the header of the questionnaire response. This ID links the response sections to the specific questionnaire response header. |
| SupplierRegistrationQuestionnaireResponsesSupplierRegistrationKey [KEY] | String | A unique key that links the response section to the supplier’s registration process, ensuring the section is associated with the correct supplier registration record. |
| QuestnaireRespSectionId [KEY] | Long | A unique identifier for the questionnaire response section. This ID tracks the specific section in the questionnaire response. |
| QuestnaireRespHeaderId | Long | The ID of the header associated with the questionnaire response. This links the response section to the specific response header. |
| QuestnaireSectionId | Long | A unique identifier for the section within the questionnaire. This ID allows the system to reference specific sections in a questionnaire. |
| DisplaySequence | Int | The order in which the section is displayed to the responder. This ensures that sections are shown in the correct sequence during the questionnaire process. |
| SectionName | String | The name of the section in the questionnaire. This represents the title or identifier of the section being answered by the supplier. |
| SectionCompletedFlag | String | Indicates whether the section has been completed. It may have values such as 'Yes' or 'No'. This flag helps track the completion status of the section. |
| SectionDisplayedFlag | Bool | Indicates whether the section is displayed to the user. A value of 'true' means the section is visible; 'false' means the section is hidden. |
| SectionGeneratedFlag | Bool | Indicates whether the section was generated dynamically. If 'true', the section was generated based on certain conditions or rules. If 'false', the section is static. |
| Finder | String | A search term or keyword used to locate the response section within the system. This helps in performing searches or filtering sections based on specific terms. |
| SupplierRegistrationKey | String | The unique key assigned to the supplier registration. This ensures the response section is correctly linked to the supplier’s registration process. |
Stores the supplier’s answers to each question in a section, capturing all responses for thorough review.
| Name | Type | Description |
| SupplierRegistrationQuestionnaireResponsesQuestnaireRespHeaderId [KEY] | Long | A unique identifier for the header of the questionnaire response. This ID links all related questionnaire responses within the system. |
| SupplierRegistrationQuestionnaireResponsesSupplierRegistrationKey [KEY] | String | A unique key that links the questionnaire responses to the supplier’s registration process. This ensures the responses are associated with the correct supplier. |
| QuestionnaireresponsesectionsQuestnaireRespSectionId [KEY] | Long | A unique identifier for the specific section in the questionnaire response. This ID links the response to a section within the questionnaire. |
| QuestnaireResponseId [KEY] | Long | A unique identifier for the response given to the specific question in the questionnaire. This allows tracking of the answer. |
| QuestnaireRespHeaderId | Long | ID linking the response to the questionnaire header. This allows the system to associate the section response to a larger questionnaire. |
| QuestnaireRespSectionId | Long | Unique identifier for the section within the questionnaire that the response belongs to. It helps organize and group related questions. |
| QuestnaireQuestionId | Long | Unique identifier for the question in the questionnaire. It helps track specific questions and their responses. |
| ParentQuestnaireQuestId | Long | ID of the parent question if the current question is part of a branching or dependent set of questions. |
| DisplayNumber | String | The order or number displayed for the question within the section. This number helps in organizing the sequence in which questions are presented. |
| QuestionId | Long | ID of the specific question within the questionnaire. It helps identify which question is being answered. |
| QuestionName | String | The name or identifier of the question being answered. This is typically the title or label of the question. |
| QuestionTypeCode | String | Abbreviation that identifies the type of question. Valid values include multiple choice and text input. Accepted values can be found in the lookup type PON_QUESTION_TYPE. |
| QuestionType | String | The type of the question. Values can include Multiple Choice or Text Entry. A list of accepted types is defined in the lookup type PON_QUESTION_TYPE. |
| ResponseTypeCode | String | Abbreviation that identifies the type of response expected for the question. Common types include Text, Number, and Date. Accepted values are defined in the lookup type PON_RESPONSE_TYPE. |
| ResponseType | String | The type of response expected for the question, such as Text, Number, Date. The full list of accepted response types can be found in the lookup type PON_RESPONSE_TYPE. |
| QuestionText | String | The actual text of the question that will be displayed to the responder. This is the content that the supplier will read and answer. |
| QuestionHint | String | A hint or additional guidance that may be displayed with the question to help responders understand how to answer. |
| DisplayPreferredRespFlag | Bool | Indicates if the preferred response (if any) should be displayed to the responder. If true, the preferred response will be shown. Default is false. |
| PreferredResponseText | String | The preferred response to the question, if defined. This text represents the recommended answer. |
| PreferredResponseDate | Date | The preferred response value for a question where the expected response type is a date. |
| PreferredResponseDatetime | Datetime | The preferred response value for a question where the expected response type is a datetime. |
| PreferredResponseNumber | Decimal | The preferred response value for a question where the expected response type is a number. |
| AttachmentAllowedCode | String | Abbreviation indicating whether attachments are allowed for the response. Accepted values include YES, NO, and CONDITIONAL. A list of valid values is defined in the lookup type PON_QUESTION_ATTACHMENT. |
| AttachmentAllowed | String | Indicates whether attachments are allowed with the response. Values include YES, NO, or CONDITIONAL. |
| ResponseRequiredFlag | Bool | Indicates whether a response is required for the question. If true, the response is mandatory. If false, the response is optional. |
| AllowRespCommentFlag | Bool | Indicates whether responders can provide additional comments for the question. If true, comments are allowed; if false, comments are not allowed. |
| ResponseComments | String | Comments provided by the responder when submitting their response. |
| QuestionDisplayedFlag | Bool | Indicates whether the question is displayed to the user. If true, the question will be shown; if false, it will be hidden. |
| BranchLevel | Int | Indicates the level of branching for this question, if applicable. A higher value indicates a deeper level of branching in the questionnaire. |
| ParentAccResponseId | Long | ID of the parent acceptable response, if this response is part of a branching question set. |
| QuestionPlainText | String | Plain-text version of the question text, displayed to the responder. |
| SupplierAttributeFlag | Bool | Indicates whether the question is mapped to a supplier profile attribute. If true, the question relates to an attribute in the supplier profile. |
| RegReadOnlyFlag | Bool | Indicates whether the question is read-only during the registration process. If true, the question cannot be modified by the responder. |
| CategoryCode | String | The category code associated with the question for classification purposes. Accepted values can be found in the lookup type PON_QUESTION_CATEGORY. |
| Category | String | The category associated with the question for classification purposes. A list of accepted categories can be found in the lookup type PON_QUESTION_CATEGORY. |
| Finder | String | A keyword or search term used to locate the question or related responses. |
| SupplierRegistrationKey | String | The unique key that links the question response to the supplier’s registration process. |
Maintains files attached to specific questions in a supplier’s registration questionnaire, supporting claims or validations.
| Name | Type | Description |
| SupplierRegistrationQuestionnaireResponsesQuestnaireRespHeaderId [KEY] | Long | A unique identifier for the header of the questionnaire response, linking all the sections and questions related to the response. |
| SupplierRegistrationQuestionnaireResponsesSupplierRegistrationKey [KEY] | String | A key that uniquely associates the questionnaire response to the supplier's registration process, ensuring correct mapping. |
| QuestionnaireresponsesectionsQuestnaireRespSectionId [KEY] | Long | An ID that uniquely identifies a section in the questionnaire response, helping organize the responses by section. |
| QuestionnaireresponsesQuestnaireResponseId [KEY] | Long | A unique identifier for a specific response to a question in the questionnaire, linking the answer to the correct question. |
| AttachedDocumentId [KEY] | Long | A unique identifier for the attached document. This ID is generated when a document is attached to the question or response. |
| LastUpdateDate | Datetime | The date and time when the attachment information was last updated. |
| LastUpdatedBy | String | The username or identifier of the person who last updated the attachment record. |
| DatatypeCode | String | An abbreviation identifying the data type for the attached file. This could include codes for file types such as PDF or DOCX. |
| FileName | String | The name of the attached file. This helps identify the file uploaded in response to the question. |
| DmFolderPath | String | The folder path where the attached document is stored in the document management system. |
| DmDocumentId | String | A unique identifier for the document within the document management system (DMS). |
| DmVersionNumber | String | The version number of the attached document, useful for tracking document revisions. |
| Url | String | The URL or web address where the attached document can be accessed. |
| CategoryName | String | The category of the attached document, such as 'Terms & Conditions' or 'Supplier Agreement'. |
| UserName | String | The username of the individual who uploaded or attached the document. |
| Uri | String | A unique URI (Uniform Resource Identifier) that points to the location of the attached document. |
| FileUrl | String | A URL that links directly to the attached file for easy access. |
| UploadedText | String | Text content of the uploaded file, if applicable. This could be the text extracted from documents like PDFs or text files. |
| UploadedFileContentType | String | The content type of the uploaded file, indicating its format. |
| UploadedFileLength | Long | The size of the uploaded file in bytes, helping to determine file size limits or troubleshoot uploads. |
| UploadedFileName | String | The original name of the file as it was uploaded, including the file extension. |
| ContentRepositoryFileShared | Bool | Indicates whether the attached file is shared with others. If true, the file is shared; if false, it is not. The default value is false. |
| Title | String | The title or name of the attachment, which might be used to identify the content of the file. |
| Description | String | A description of the attached document to provide additional context or information about the file. |
| ErrorStatusCode | String | An error code indicating any issue with the attachment, such as 'FILE_TOO_LARGE' or 'UPLOAD_FAILED'. |
| ErrorStatusMessage | String | A text message providing more details about the error encountered during the upload of the attachment. |
| CreatedBy | String | The user who initially created the record for the attachment. |
| CreationDate | Datetime | The date and time when the attachment was first uploaded or created. |
| FileContents | String | The content or data of the uploaded file, typically stored as a binary or Base64-encoded string. |
| ExpirationDate | Datetime | The date and time when the file's availability or validity expires. |
| LastUpdatedByUserName | String | The username of the individual who last updated the attachment record. |
| CreatedByUserName | String | The username of the individual who originally created the attachment record. |
| AsyncTrackerId | String | An identifier used for tracking the asynchronous processing of the file upload or related tasks. |
| FileWebImage | String | A web image representation of the attached file, typically in Base64 encoding, displayed as an image preview (for example, .png). |
| DownloadInfo | String | A JSON string containing the necessary details to programmatically retrieve the attached file. |
| PostProcessingAction | String | The action that can be performed after the attachment is uploaded, such as 'Email Notification' or 'File Compression'. |
| Finder | String | A search keyword or identifier used to locate this attachment in a broader search context. |
| QuestnaireRespHeaderId | Long | The ID of the questionnaire response header that this attachment is related to. |
| SupplierRegistrationKey | String | A unique key linking the attachment to the supplier's registration process. |
Details the actual data inputs (for example, numeric, text) for each question, enabling precise analysis of supplier registration responses.
| Name | Type | Description |
| SupplierRegistrationQuestionnaireResponsesQuestnaireRespHeaderId [KEY] | Long | SupplierRegistrationQuestionnaireResponsesQuestnaireRespHeaderId of SupplierRegistrationQuestionnaireResponsesquestionnaireResponseSectionsquestionnaireResponsesquestionnaireResponseValues |
| SupplierRegistrationQuestionnaireResponsesSupplierRegistrationKey [KEY] | String | SupplierRegistrationQuestionnaireResponsesSupplierRegistrationKey of SupplierRegistrationQuestionnaireResponsesquestionnaireResponseSectionsquestionnaireResponsesquestionnaireResponseValues |
| QuestionnaireresponsesectionsQuestnaireRespSectionId [KEY] | Long | QuestionnaireresponsesectionsQuestnaireRespSectionId of SupplierRegistrationQuestionnaireResponsesquestionnaireResponseSectionsquestionnaireResponsesquestionnaireResponseValues |
| QuestionnaireresponsesQuestnaireResponseId [KEY] | Long | QuestionnaireresponsesQuestnaireResponseId of SupplierRegistrationQuestionnaireResponsesquestionnaireResponseSectionsquestionnaireResponsesquestionnaireResponseValues |
| QuestnaireRespValueId [KEY] | Long | QuestnaireRespValueId of SupplierRegistrationQuestionnaireResponsesquestionnaireResponseSectionsquestionnaireResponsesquestionnaireResponseValues |
| QuestnaireResponseId | Long | QuestnaireResponseId of SupplierRegistrationQuestionnaireResponsesquestionnaireResponseSectionsquestionnaireResponsesquestionnaireResponseValues |
| QuestnaireAccResponseId | Long | QuestnaireAccResponseId of SupplierRegistrationQuestionnaireResponsesquestionnaireResponseSectionsquestionnaireResponsesquestionnaireResponseValues |
| ResponseValueDate | Date | ResponseValueDate of SupplierRegistrationQuestionnaireResponsesquestionnaireResponseSectionsquestionnaireResponsesquestionnaireResponseValues |
| ResponseValueDatetime | Datetime | ResponseValueDatetime of SupplierRegistrationQuestionnaireResponsesquestionnaireResponseSectionsquestionnaireResponsesquestionnaireResponseValues |
| ResponseValueNumber | Decimal | ResponseValueNumber of SupplierRegistrationQuestionnaireResponsesquestionnaireResponseSectionsquestionnaireResponsesquestionnaireResponseValues |
| ResponseValueTxt | String | ResponseValueTxt of SupplierRegistrationQuestionnaireResponsesquestionnaireResponseSectionsquestionnaireResponsesquestionnaireResponseValues |
| AccResponseId | Long | AccResponseId of SupplierRegistrationQuestionnaireResponsesquestionnaireResponseSectionsquestionnaireResponsesquestionnaireResponseValues |
| ResponseText | String | ResponseText of SupplierRegistrationQuestionnaireResponsesquestionnaireResponseSectionsquestionnaireResponsesquestionnaireResponseValues |
| PreferredResponseFlag | Bool | PreferredResponseFlag of SupplierRegistrationQuestionnaireResponsesquestionnaireResponseSectionsquestionnaireResponsesquestionnaireResponseValues |
| AttachmentAllowedCode | String | AttachmentAllowedCode of SupplierRegistrationQuestionnaireResponsesquestionnaireResponseSectionsquestionnaireResponsesquestionnaireResponseValues |
| AttachmentAllowed | String | AttachmentAllowed of SupplierRegistrationQuestionnaireResponsesquestionnaireResponseSectionsquestionnaireResponsesquestionnaireResponseValues |
| IsSelectedFlag | Bool | IsSelectedFlag of SupplierRegistrationQuestionnaireResponsesquestionnaireResponseSectionsquestionnaireResponsesquestionnaireResponseValues |
| DisplayNumber | String | DisplayNumber of SupplierRegistrationQuestionnaireResponsesquestionnaireResponseSectionsquestionnaireResponsesquestionnaireResponseValues |
| HasBranchingFlag | Bool | HasBranchingFlag of SupplierRegistrationQuestionnaireResponsesquestionnaireResponseSectionsquestionnaireResponsesquestionnaireResponseValues |
| FromUI | String | FromUI of SupplierRegistrationQuestionnaireResponsesquestionnaireResponseSectionsquestionnaireResponsesquestionnaireResponseValues |
| ResponseAttachments | String | ResponseAttachments of SupplierRegistrationQuestionnaireResponsesquestionnaireResponseSectionsquestionnaireResponsesquestionnaireResponseValues |
| Finder | String | Finder of SupplierRegistrationQuestionnaireResponsesquestionnaireResponseSectionsquestionnaireResponsesquestionnaireResponseValues |
| QuestnaireRespHeaderId | Long | QuestnaireRespHeaderId of SupplierRegistrationQuestionnaireResponsesquestionnaireResponseSectionsquestionnaireResponsesquestionnaireResponseValues |
| SupplierRegistrationKey | String | SupplierRegistrationKey of SupplierRegistrationQuestionnaireResponsesquestionnaireResponseSectionsquestionnaireResponsesquestionnaireResponseValues |
Controls supplier registration requests, whether prospective or spend-authorized, storing essential onboarding data and statuses.
| Name | Type | Description |
| SupplierRegistrationKey [KEY] | String | A unique key that links the registration request to the specific supplier's registration process. |
| Company | String | The name of the company requesting supplier registration. |
| RequestNumber | Long | A unique number identifying the supplier registration request, typically used for tracking purposes. |
| TaxOrganizationTypeCode | String | An abbreviation that identifies the type of tax organization for the supplier. Accepted values include 'LLC', 'CORP', 'INDIVIDUAL'. |
| TaxOrganizationType | String | A description of the tax organization type (for example, Limited Liability Company, Corporation, Individual). |
| SupplierTypeCode | String | An abbreviation identifying the supplier type. Accepted values might include 'MANUFACTURER', 'DISTRIBUTOR', 'SERVICE_PROVIDER'. |
| SupplierType | String | The classification of the supplier (for example, Manufacturer, Distributor, Service Provider). |
| CorporateWebsite | String | The URL of the supplier’s official corporate website. |
| DUNSNumber | String | The D-U-N-S number, a unique nine-digit identifier for businesses provided by Dun & Bradstreet. |
| TaxpayerCountryCode | String | An abbreviation representing the country where the supplier is registered for tax purposes. Valid values include country codes such as 'US', 'IN', 'UK'. |
| TaxCountry | String | The full name of the country where the supplier is registered for tax purposes. |
| NoteToApprover | String | Any note or additional information provided to the approver of the registration request. |
| BusinessRelationshipCode | String | An abbreviation identifying the type of business relationship with the supplier. Accepted values may include 'B2B', 'B2C', 'GOV'. |
| BusinessRelationship | String | Description of the business relationship with the supplier (for example, Business to Business, Business to Consumer, Government). |
| ProcurementBUId | Long | An identifier for the procurement business unit that handles the supplier registration. |
| RequesterLanguage | String | The language preferred by the requester for communication (for example, 'EN', 'FR', 'ES'). |
| BusinessClassificationNotApplicableFlag | Bool | Indicates whether the business classification is not applicable. True means it is not applicable; False means it is. |
| DataFoxAddressId | Long | A unique identifier for the address of the supplier, used by DataFox to manage supplier address data. |
| DataFoxCompanyId | String | A unique identifier assigned by DataFox to the company. |
| Finder | String | A search keyword or identifier used to locate this registration request in a broader search context. |
Manages address information tied to a supplier registration request, capturing physical location details for the supplier.
| Name | Type | Description |
| SupplierRegistrationRequestsSupplierRegistrationKey [KEY] | String | A unique key that links the supplier registration request to a specific supplier's address. |
| SupplierRegistrationAddressId [KEY] | Long | A unique identifier for the supplier registration request address, used to track the address within the supplier registration process. |
| AddressName | String | The name or label for the supplier address (for example, 'Head Office', 'Warehouse'). |
| CountryCode | String | The abbreviation for the country where the supplier address is located. Valid values include ISO 3166-1 alpha-2 country codes like 'US', 'IN', 'GB'. |
| AddressLine1 | String | The first line of the address, typically containing the street address or building name. |
| AddressLine2 | String | The second line of the address, used for apartment numbers or additional address details. |
| AddressLine3 | String | The third line of the address, if needed, for further details. |
| AddressLine4 | String | The fourth line of the address, if needed, for further details. |
| City | String | The city or locality of the supplier's address. |
| State | String | The state or province where the supplier address is located. |
| PostalCode | String | The postal code of the supplier address. |
| PostalCodeExtension | String | An extension to the postal code, if applicable, typically used for more precise delivery details. |
| Province | String | The province of the supplier address, applicable for some countries. |
| County | String | The county or district where the supplier address is located. |
| Building | String | The building number or name for the supplier address, often used in large complexes. |
| FloorNumber | String | The floor number within the building where the supplier address is located. |
| PhoneticAddress | String | A phonetic representation of the address, typically used for languages like Japanese (kana) or Chinese (kanji). |
| AddressPurposeOrderingFlag | Bool | Indicates if the address can be used for ordering. True means it can be used for ordering, false means it cannot. Default is false. |
| AddressPurposeRemitToFlag | Bool | Indicates if the address can be used for requesting proposals or bidding. True means it can be used, false means it cannot. Default is false. |
| AddressPurposeRFQOrBiddingFlag | Bool | Indicates if the address can be used for sending payments or RFQs. True means it can be used, false means it cannot. Default is false. |
| PhoneCountryCode | String | The country code for the phone number. Valid values include ISO 3166-1 alpha-2 country codes. |
| PhoneAreaCode | String | The area or region code for the phone number. |
| PhoneNumber | String | The main phone number for the supplier address. |
| PhoneExtension | String | The phone extension number, if applicable. |
| FaxCountryCode | String | The country code for the fax number. |
| FaxAreaCode | String | The area or region code for the fax number. |
| FaxNumber | String | The main fax number for the supplier address. |
| String | The email address for the supplier address, used for communication. | |
| AdditionalAddressAttribute1 | String | First additional attribute for the flexible supplier address format (can be used for extra address details). |
| AdditionalAddressAttribute2 | String | Second additional attribute for the flexible supplier address format (can be used for extra address details). |
| AdditionalAddressAttribute3 | String | Third additional attribute for the flexible supplier address format (can be used for extra address details). |
| AdditionalAddressAttribute4 | String | Fourth additional attribute for the flexible supplier address format (can be used for extra address details). |
| AdditionalAddressAttribute5 | String | Fifth additional attribute for the flexible supplier address format (can be used for extra address details). |
| Finder | String | A search keyword or identifier used to locate this address in a broader search context. |
| SupplierRegistrationKey | String | A unique key linking the address to the corresponding supplier registration. |
Tracks contact people (for example, branch manager, local admin) at a specific supplier address, supporting multi-contact setups.
| Name | Type | Description |
| SupplierRegistrationRequestsSupplierRegistrationKey [KEY] | String | A unique key that links the supplier registration request to a specific supplier's address and contacts. |
| AddressesSupplierRegistrationAddressId [KEY] | Long | A unique identifier for the supplier registration request address, used to track the address within the supplier registration process. |
| SupplierRegAddressContactsId [KEY] | Long | A unique identifier for the address contact associated with the supplier registration request address. |
| SupplierRegistrationContactId | Long | A unique identifier for the contact person at the supplier's address. This is used to associate a specific contact with the address. |
| String | The email address of the contact at the supplier's address. This is used for communication related to the registration process. | |
| Finder | String | A search keyword or identifier used to locate this contact in a broader search context. |
| SupplierRegistrationKey | String | A unique key that links the address contact to the corresponding supplier registration request. |
Captures descriptive flexfields for address records in supplier registration requests, supporting unique business data needs.
| Name | Type | Description |
| SupplierRegistrationRequestsSupplierRegistrationKey [KEY] | String | A unique key that links the supplier registration request to a specific address, allowing the system to associate additional details for this address. |
| AddressesSupplierRegistrationAddressId [KEY] | Long | A unique identifier for the supplier registration address, allowing for tracking and management of addresses associated with the supplier registration request. |
| AddressRequestId [KEY] | Long | A unique identifier for the address request within the supplier registration process. This ensures that the address is associated with the correct request. |
| _FLEX_Context | String | Contextual information that indicates which additional flexfields (DFF) are being applied. The context provides details about the specific area of the registration form being worked on, such as 'Party Site Information' for supplier addresses. |
| _FLEX_Context_DisplayValue | String | A human-readable label for the context, such as 'Enter Party Site Information', helping users understand what data is being captured. |
| Finder | String | A search keyword or identifier that helps locate this specific address DFF record during search operations. |
| SupplierRegistrationKey | String | A unique key that links the DFF data to the main supplier registration record, ensuring that flexible data is tied to the correct registration request. |
Holds uploaded files (for example, tax forms, certificates) linked to a supplier registration, improving documentation completeness.
| Name | Type | Description |
| SupplierRegistrationRequestsSupplierRegistrationKey [KEY] | String | A unique identifier that links this attachment to a specific supplier registration request, allowing the system to associate the document with the correct registration. |
| AttachedDocumentId [KEY] | Long | A unique identifier for the attached document, generated when a document is uploaded and associated with the supplier registration request. |
| LastUpdateDate | Datetime | The date and time when the attachment record was last updated in the system, useful for tracking recent changes. |
| LastUpdatedBy | String | The user who last updated the attachment record, providing auditability of changes. |
| DatatypeCode | String | A code that indicates the data type of the attachment. Accepted values might include 'FILE', 'TEXT', or 'WEB_PAGE', helping identify the format of the uploaded content. |
| FileName | String | The name of the attachment file, as it is saved or uploaded, to distinguish between different files. |
| DmFolderPath | String | The path to the folder in the document management system (DMS) where the attachment is stored. |
| DmDocumentId | String | The unique identifier assigned to the document in the document management system, ensuring proper referencing of stored documents. |
| DmVersionNumber | String | The version number of the document, which helps track revisions of the same document over time. |
| Url | String | The URL for a web page type attachment, pointing to a resource available online. |
| CategoryName | String | The category to which this attachment belongs, helping classify and organize attachments in the system. |
| UserName | String | The username of the person who uploaded the attachment, useful for user-specific auditing. |
| Uri | String | The URI for Topology Manager type attachments, pointing to the location of the resource within the system. |
| FileUrl | String | The URL of the file, providing direct access to the attachment. |
| UploadedText | String | The text content associated with a text-type attachment, containing the content itself. |
| UploadedFileContentType | String | The content type of the uploaded attachment, indicating its format. |
| UploadedFileLength | Long | The size of the uploaded file in bytes, providing information about the file's data size. |
| UploadedFileName | String | The name to assign to a new file attachment, which might differ from the original file name. |
| ContentRepositoryFileShared | Bool | Indicates whether the attachment is shared across users or kept private. Default value is false unless explicitly marked. |
| Title | String | A user-defined title for the attachment, which can help describe its contents or purpose. |
| Description | String | A user-defined description of the attachment, giving more context or details about the file or document. |
| ErrorStatusCode | String | The error code, if any, that indicates problems encountered with the attachment, such as 'FILE_TOO_LARGE' or 'INVALID_FORMAT'. |
| ErrorStatusMessage | String | The error message corresponding to the error code, explaining the issue with the attachment. |
| CreatedBy | String | The user who initially created the attachment record, providing a historical view of the record's creation. |
| CreationDate | Datetime | The date and time when the attachment record was created in the system. |
| FileContents | String | The raw contents of the attachment (for text-based attachments), available in a readable format. |
| ExpirationDate | Datetime | The expiration date of the attachment contents, after which the file might be considered obsolete or archived. |
| LastUpdatedByUserName | String | The username of the person who last updated the attachment record, assisting in accountability for changes. |
| CreatedByUserName | String | The username of the person who created the attachment record, providing additional accountability. |
| AsyncTrackerId | String | An identifier used specifically for tracking the asynchronous upload process of the file in the Attachment UI components. |
| FileWebImage | String | A Base64-encoded image preview of the file, if the attachment is an image, rendered for easy viewing in the UI. |
| DownloadInfo | String | A JSON object represented as a string containing necessary metadata to programmatically retrieve the file attachment. |
| PostProcessingAction | String | The name of the action that should be performed after the attachment is uploaded, such as 'compress', 'archive', or 'send for approval'. |
| Finder | String | A search term used to locate the attachment in the system, often matching file names or associated metadata. |
| SupplierRegistrationKey | String | A unique identifier that links this attachment record back to the main supplier registration record, ensuring the attachment is associated with the correct supplier request. |
Stores supplier bank account details during registration, ensuring valid routing information for future payments.
| Name | Type | Description |
| SupplierRegistrationRequestsSupplierRegistrationKey [KEY] | String | A unique identifier for the supplier registration request, linking the bank account details to the specific supplier registration. |
| SupplierRegistrationBankAccountId [KEY] | Long | A unique identifier for the supplier registration bank account, ensuring proper tracking of each bank account associated with a supplier. |
| CountryCode | String | A code identifying the country where the supplier registration bank account is located. This cannot be updated once the bank account has been created. Country codes are typically in ISO 3166-1 format, such as 'US' for the United States. |
| Country | String | The full name of the country where the supplier registration bank account is located. This cannot be updated once the bank account is created. |
| BankId | Long | The unique identifier of the bank where the supplier holds the registration bank account. This ensures proper identification of the banking institution. |
| Bank | String | The name of the bank where the supplier's registration account is held, providing a human-readable identifier for the financial institution. |
| BranchId | Long | The unique identifier for the specific branch of the bank associated with the supplier registration bank account. |
| Branch | String | The name of the bank branch for the supplier registration bank account, helping to identify the specific branch of the banking institution. |
| BranchNumber | String | The branch number for the supplier's bank account, which is used in some countries to uniquely identify a branch. |
| AccountNumber | String | The number of the supplier's registration bank account, which is unique to the supplier's account at the bank. |
| IBAN | String | The International Bank Account Number (IBAN) of the supplier registration bank account. The IBAN is an international standard for bank account identification, and it is used for cross-border payments. |
| CurrencyCode | String | The currency code for the supplier registration bank account, using the standard three-letter ISO 4217 currency code, such as 'USD' for U.S. dollars. |
| AccountName | String | The name on the supplier registration bank account, typically representing the legal entity or individual owning the account. |
| AlternateAccountName | String | An alternate name for the supplier registration bank account, which may be used if the account is associated with a different business name or alias. |
| AccountSuffix | String | A suffix added to the account number, used to further identify sub-accounts or specific variations of a bank account. |
| CheckDigits | String | The check digit for the supplier registration bank account. This is used to validate the account number and ensure accuracy in transactions. |
| AccountType | String | The type of bank account for the supplier registration. Accepted values include 'CHECKING', 'SAVINGS', or other types defined in the lookup type IBY_BANKACCT_TYPES. Refer to the 'IBY_BANKACCT_TYPES' lookup for valid values. |
| Description | String | A detailed description of the supplier registration bank account, providing additional context or notes about the account. |
| BIC | String | The Bank Identifier Code (BIC), also known as the SWIFT code, is used to identify the specific bank during international transactions. |
| SecondaryAccountReference | String | A secondary reference for the supplier registration bank account, which may be used for internal purposes or additional identification. |
| Finder | String | A searchable term that can be used to find specific bank account records in the system. |
| SupplierRegistrationKey | String | A unique identifier for the supplier registration, linking the bank account details to the overall supplier registration process. |
Allows attachments related to a supplier’s bank account (for example, proof of account ownership, voided checks).
| Name | Type | Description |
| SupplierRegistrationRequestsSupplierRegistrationKey [KEY] | String | A unique identifier for the supplier registration request, linking the bank account attachment details to the specific supplier registration. |
| BankaccountsSupplierRegistrationBankAccountId [KEY] | Long | A unique identifier for the bank account associated with the supplier registration request, ensuring proper tracking of the bank account attachments. |
| AttachedDocumentId [KEY] | Long | The unique identifier for the attached document. This ID helps track and manage the specific document attached to the bank account. |
| LastUpdateDate | Datetime | The date and time when the bank account attachment record was last updated. |
| LastUpdatedBy | String | The user who last updated the bank account attachment record. This ensures proper auditing of modifications. |
| DatatypeCode | String | A value that indicates the data type of the attachment. Common values include 'FILE', 'TEXT', or 'URL'. |
| FileName | String | The file name of the attached document, which can be used to identify or reference the file. |
| DmFolderPath | String | The folder path from which the attachment document is created or stored, providing information on the document's storage location. |
| DmDocumentId | String | The document ID assigned to the attachment in the document management system, used for tracking the document's lifecycle. |
| DmVersionNumber | String | The version number of the document. This helps in tracking and managing document revisions. |
| Url | String | The URL of the attachment, typically used for web page type attachments where the document is hosted online. |
| CategoryName | String | The category of the attachment, which can be used to classify the document. Common categories include 'Invoice' or 'Contract'. |
| UserName | String | The username of the person who uploaded or associated the attachment with the supplier registration request. |
| Uri | String | The URI (Uniform Resource Identifier) used to identify the attachment, especially for web-based resources. |
| FileUrl | String | The URL pointing directly to the file for easy access or downloading. |
| UploadedText | String | The textual content of a new text attachment, where applicable. This would be used for text-based documents or notes. |
| UploadedFileContentType | String | The content type of the file, indicating its format. |
| UploadedFileLength | Long | The size of the attachment file, typically expressed in bytes, used for tracking file size and ensuring it meets upload limits. |
| UploadedFileName | String | The name of the file as it will appear on the system once it is uploaded. |
| ContentRepositoryFileShared | Bool | Indicates whether the attachment is shared with others. If true, the file is shared; if false, it is private. The default is false. |
| Title | String | The title of the attachment, which provides a brief description or name of the document. |
| Description | String | A detailed description of the attachment, explaining its content or purpose. |
| ErrorStatusCode | String | The error code, if any, that was generated during the attachment process, providing information on why the upload may have failed. |
| ErrorStatusMessage | String | The error message, if any, providing more detail on the issue that occurred during the attachment process. |
| CreatedBy | String | The user who created the bank account attachment record. |
| CreationDate | Datetime | The date and time when the bank account attachment record was created. |
| FileContents | String | The actual contents of the attachment in text form, applicable to text-based files. |
| ExpirationDate | Datetime | The expiration date of the contents in the attachment, used for tracking the validity period of temporary or time-sensitive documents. |
| LastUpdatedByUserName | String | The username of the person who last updated the attachment details. |
| CreatedByUserName | String | The username of the person who originally created the attachment record. |
| AsyncTrackerId | String | A unique identifier provided for tracking the status of an asynchronous file upload. Used for monitoring file upload progress. |
| FileWebImage | String | Base64 encoded image of the file, typically displayed as a preview of the attachment. |
| DownloadInfo | String | A JSON object containing metadata or links used to programmatically retrieve the attachment. |
| PostProcessingAction | String | Specifies an action that can be performed after the attachment is uploaded, such as 'convert to PDF' or 'send for review'. |
| Finder | String | A searchable keyword used to locate the bank account attachment in the system. |
| SupplierRegistrationKey | String | A unique identifier for the supplier registration, linking the attachment to the overall supplier registration process. |
Maintains classification records (for example, minority-owned, small business) for a supplier registration request, aligning with compliance requirements.
| Name | Type | Description |
| SupplierRegistrationRequestsSupplierRegistrationKey [KEY] | String | A unique identifier for the supplier registration request, linking the business classification details to the specific supplier registration. |
| BusinessClassificationsId [KEY] | Long | A unique identifier for the business classification associated with the supplier registration request. |
| Classification | String | The classification for the supplier business. This identifies the general category under which the supplier is classified. For example, it could refer to whether the supplier is a minority-owned business, a small business, or another classification. |
| ClassificationCode | String | An abbreviation that uniquely identifies the business classification for the supplier. Accepted values are defined in the lookup type POZ_BUSINESS_CLASSIFICATIONS. You can update these values using the Setup and Maintenance work area and the Manage Business Classification Lookup task. |
| Subclassification | String | Describes a subclassification when a minority owns the business. This field is used when the classification indicates that the business belongs to a minority group. |
| SubclassificationCode | String | An abbreviation that identifies the subclassification when a minority owns the business. Accepted values are defined in the lookup type POZ_MINORITY_GROUP. You can update these values in the Setup and Maintenance work area and the Manage Standard Lookups task. |
| CertifyingAgency | String | The agency that certifies the business classification for the supplier. This agency is responsible for confirming the business classification and certifying its validity. |
| CertifyingAgencyId | Long | A unique identifier for the agency that certifies the business classification for the supplier. |
| OtherCertifyingAgency | String | An alternative agency that certifies the business classification for the supplier. Use this attribute when the agency is not specified in the Manage Certifying Agencies page in the Setup and Maintenance work area. |
| CertificateNumber | String | The certificate number issued by the certifying agency for the business classification. This number uniquely identifies the certification issued to the supplier. |
| CertificateStartDate | Date | The date on which the certificate issued by the certifying agency becomes effective, validating the business classification. |
| CertificateExpirationDate | Date | The date on which the certificate expires, indicating when the business classification needs to be renewed or re-validated. |
| Notes | String | Any additional notes that describe the business classification for the supplier. This field allows the supplier or the person managing the classification to provide more context or details. |
| Finder | String | A searchable keyword used to locate the business classification record in the system. |
| SupplierRegistrationKey | String | A unique identifier for the supplier registration, linking the business classification details to the overall supplier registration process. |
Holds files proving or explaining a supplier’s business classification, ensuring accurate and documented registrations.
| Name | Type | Description |
| SupplierRegistrationRequestsSupplierRegistrationKey [KEY] | String | A unique identifier for the supplier registration request, linking the business classification attachment to the specific supplier registration. |
| BusinessclassificationsBusinessClassificationsId [KEY] | Long | A unique identifier for the business classification associated with the supplier registration request to which the attachment is linked. |
| AttachedDocumentId [KEY] | Long | The unique identifier of the attached document. This ID is generated when a document is attached to the business classification record. |
| LastUpdateDate | Datetime | The date and time when the attachment was last updated. This field tracks when any changes were made to the attachment. |
| LastUpdatedBy | String | The user who last updated the attachment information. This field tracks the person responsible for modifying the attachment record. |
| DatatypeCode | String | A value that indicates the type of data contained in the attachment. For example, it can represent whether the attachment is a file, folder, or text. |
| FileName | String | The name of the attachment file. This name is given to the file when it is uploaded to the system. |
| DmFolderPath | String | The folder path where the attachment is stored in the document management system (DMS). It represents the location of the file within the system. |
| DmDocumentId | String | The document ID assigned by the DMS to uniquely identify the document being attached. |
| DmVersionNumber | String | The version number of the document being attached. This is updated whenever a new version of the document is uploaded. |
| Url | String | The URL of a web page-type attachment. This URL links to a web-based document or page that is attached to the business classification. |
| CategoryName | String | The category of the attachment, which helps categorize and organize documents related to business classifications. |
| UserName | String | The user who uploaded the attachment. This field stores the username of the person responsible for adding the attachment. |
| Uri | String | The URI (Uniform Resource Identifier) of the attachment, providing a direct link to access the document or file from the system. |
| FileUrl | String | The URI or path of the file itself. This URL is used to access the actual file attached to the business classification. |
| UploadedText | String | The content of a text-type attachment. If the attachment is a text document, this field contains the actual text. |
| UploadedFileContentType | String | The content type of the attachment, indicating its format. |
| UploadedFileLength | Long | The size of the uploaded file in bytes. This indicates the file size and helps determine the storage space used. |
| UploadedFileName | String | The name to assign to the file when it is uploaded. This name can be specified during the upload process. |
| ContentRepositoryFileShared | Bool | Indicates whether the attachment is shared with others. If true, the file is shared; if false, it is not. |
| Title | String | The title of the attachment. This is a short description or name that summarizes the contents of the attached document. |
| Description | String | The description of the attachment, providing more detailed information about the file's contents and purpose. |
| ErrorStatusCode | String | The error code associated with the attachment, if any. This code helps identify issues encountered during the attachment process. |
| ErrorStatusMessage | String | A message describing the error, if any, related to the attachment. This helps diagnose and resolve issues with uploading or managing attachments. |
| CreatedBy | String | The user who created the attachment record. This field stores the username of the person responsible for adding the attachment entry. |
| CreationDate | Datetime | The date and time when the attachment record was created. This helps track when the attachment was added to the system. |
| FileContents | String | The actual contents of the attachment, if applicable, such as plain text content from a text document. |
| ExpirationDate | Datetime | The expiration date of the contents in the attachment. This specifies when the attachment's validity period ends. |
| LastUpdatedByUserName | String | The username of the person who last updated the attachment. This tracks who made the most recent changes to the attachment. |
| CreatedByUserName | String | The username of the person who initially created the attachment record. This helps track the creator of the attachment. |
| AsyncTrackerId | String | A tracking identifier used by the Attachment UI components to manage the asynchronous upload process. This is used for tracking and managing file uploads. |
| FileWebImage | String | The web image representation of the attachment, typically in Base64 encoding, displayed when the source file is an image. |
| DownloadInfo | String | A JSON object represented as a string, containing information that can be used to programmatically retrieve the file attachment. |
| PostProcessingAction | String | The name of the action that can be performed after the attachment is uploaded, such as 'move', 'archive', or 'process'. |
| Finder | String | A searchable field that can be used to locate the attachment in the system, helping to quickly find and reference attachments. |
| SupplierRegistrationKey | String | A unique identifier for the supplier registration, linking the business classification attachment to the overall supplier registration. |
Stores contact information (for example, phone, email) for supplier representatives, forming the basis for communication.
| Name | Type | Description |
| SupplierRegistrationRequestsSupplierRegistrationKey [KEY] | String | A unique identifier for the supplier registration request, linking the contact information to a specific supplier registration. |
| SupplierRegistrationContactId [KEY] | Long | A unique identifier for the supplier contact associated with the supplier registration request. |
| AdministrativeContactFlag | Bool | Indicates whether the supplier is an administrative contact. Valid values are true or false. If true, the supplier is an administrative contact; if false, the supplier is not. The default value is false. |
| SalutationCode | String | An abbreviation representing the honorific title of the supplier contact. Accepted values are defined in the lookup type CONTACT_TITLE. To view or modify, use the Setup and Maintenance work area and the Manage Standard Lookups task. |
| Salutation | String | The full honorific title (such as Mr., Ms., Dr.) for the supplier contact in the supplier registration. |
| FirstName | String | The first name of the supplier contact. |
| MiddleName | String | The middle name of the supplier contact, if applicable. |
| LastName | String | The last name (family name) of the supplier contact. |
| JobTitle | String | The job title or position of the supplier contact within the organization. |
| String | The email address of the supplier contact. This is used for correspondence related to the supplier registration. | |
| PhoneCountryCode | String | The country code for the landline phone number of the supplier contact. This is a two-digit code identifying the country. |
| PhoneAreaCode | String | The area code for the landline phone number of the supplier contact. This is typically used to identify the specific geographical region. |
| PhoneNumber | String | The landline phone number of the supplier contact. This is the main contact number for the supplier. |
| PhoneExtension | String | The phone extension for the supplier contact's landline number. This is used if the contact is part of a larger organization. |
| MobileCountryCode | String | The country code for the mobile phone number of the supplier contact. This identifies the country where the phone number is registered. |
| MobileAreaCode | String | The area code for the mobile phone number of the supplier contact. This identifies the geographic region of the mobile number. |
| MobileNumber | String | The mobile phone number of the supplier contact. This is the personal or primary mobile number. |
| FaxCountryCode | String | The country code for the fax number of the supplier contact. This identifies the country in which the fax is being sent or received. |
| FaxAreaCode | String | The area code for the fax number of the supplier contact. This identifies the geographical area of the fax line. |
| FaxNumber | String | The fax number of the supplier contact. This can be used for fax correspondence. |
| CreateUserAccountFlag | Bool | Indicates whether a user account should be created for the supplier contact. Valid values are true (create an account) or false (do not create an account). The default value is false. |
| Finder | String | A searchable field to help locate the supplier contact within the system. This can be used for quick referencing. |
| SupplierRegistrationKey | String | A unique identifier for the supplier registration, linking the contact details to the overall supplier registration. |
Enables descriptive flexfields on supplier contact data, allowing extra fields beyond standard attributes.
| Name | Type | Description |
| SupplierRegistrationRequestsSupplierRegistrationKey [KEY] | String | A unique identifier for the supplier registration request, linking the contact flexfield information to a specific supplier registration. |
| ContactsSupplierRegistrationContactId [KEY] | Long | A unique identifier for the contact associated with the supplier registration request. This value links the contact to specific supplier registration details. |
| ContactRequestId [KEY] | Long | A unique identifier for the contact request associated with the supplier registration. This value helps track specific contact-related requests within the supplier registration process. |
| _FLEX_Context | String | Descriptive flexfield context name used to specify the details about the contact request. This helps contextualize the data within a specific configuration or user-defined context. |
| _FLEX_Context_DisplayValue | String | A user-friendly display name for the flexfield context. In this case, it is typically used for defining the information to be entered for the contact person. |
| Finder | String | A searchable field that helps locate the supplier contact flexfield information within the system. This can be used for quick referencing in the search process. |
| SupplierRegistrationKey | String | A unique identifier that links the flexfield contact information to the overall supplier registration request, ensuring proper association with the supplier's profile. |
Tracks user account roles assigned to a supplier contact (for example, primary contact, user administrator), controlling system access.
| Name | Type | Description |
| SupplierRegistrationRequestsSupplierRegistrationKey [KEY] | String | A unique identifier that links the contact role information to a specific supplier registration request. |
| ContactsSupplierRegistrationContactId [KEY] | Long | A unique identifier for the supplier contact associated with the registration. This identifier is used to link the contact to specific roles during the registration process. |
| SupplierRegistrationContactRoleId [KEY] | Long | A unique identifier for the role assigned to a supplier contact. This field links the contact to specific roles within the registration. |
| RoleId | Long | A unique identifier that represents the user role assigned to the supplier contact. This role defines the level of access or responsibility for the contact within the registration. |
| RoleName | String | The name of the role assigned to the supplier contact. The role defines the permissions and responsibilities the contact holds during the supplier registration. |
| Description | String | A description of the role that clarifies the supplier contact’s duties, permissions, or responsibilities in relation to the registration process. |
| Finder | String | A searchable field used for locating specific role information within the supplier registration context. It helps users quickly find relevant roles linked to a contact. |
| SupplierRegistrationKey | String | A unique identifier that links the role information to the overall supplier registration request, ensuring the proper association between contacts and their roles within the supplier registration. |
Houses descriptive flexfields at the registration request header, supporting additional data not covered by standard fields.
| Name | Type | Description |
| SupplierRegistrationRequestsSupplierRegistrationKey [KEY] | String | A unique identifier that links the specific supplier registration request to its descriptive flexfield (DFF) data. This key connects the registration data with its DFF details. |
| SupplierRegId [KEY] | Long | A unique identifier for the supplier registration. This field is used to link specific registration entries to their corresponding DFF attributes. |
| OfficeRecyclingPercentage | Decimal | The percentage of office waste that is recycled by the supplier's office. This value indicates the environmental responsibility and sustainability practices of the supplier's office. |
| DebtRating | String | A rating that indicates the financial health and creditworthiness of the supplier. Accepted values can include standard credit rating scales (for example, AAA, AA, or A), depending on the credit rating agency. |
| _FLEX_Context | String | The name of the DFF context that defines the scope of the DFF. This context determines the area of the registration process that the DFF is associated with (for example, 'Sustainability', 'Financials'). |
| _FLEX_Context_DisplayValue | String | A display value for the flexfield context that provides a user-friendly description of the context's purpose. This field allows the user to easily understand the context under which the DFF data is being collected. |
| Finder | String | A searchable field used to locate specific DFF data within the supplier registration process. This can be used to filter and find DFF records efficiently based on specific criteria. |
| SupplierRegistrationKey | String | A unique identifier that links the DFF data to the overall supplier registration request, ensuring that the descriptive attributes are correctly associated with the right supplier. |
Logs the products and services a supplier offers, matching them to internal categories for procurement decisions.
| Name | Type | Description |
| SupplierRegistrationRequestsSupplierRegistrationKey [KEY] | String | A unique identifier that links the specific supplier registration request to its products and services data. This key associates the registration request with its products and services information. |
| ProductsServicesRequestId [KEY] | Long | A unique identifier for the products and services request associated with the supplier registration. This field helps to distinguish between different types of requests within the registration process. |
| CategoryId | Long | A unique identifier for the category of products or services requested in the supplier registration. This ID links the request to a specific category in the product or service taxonomy. |
| CategoryType | String | Describes the type of category for the products or services being requested. Accepted values may include 'Goods', 'Services', or other classifications defined in the supplier catalog. |
| CategoryDescription | String | A detailed description of the category for the products or services requested. This field provides further context to the category, detailing the scope and characteristics of the products or services. |
| CategoryName | String | The name of the category for the products or services requested. This field helps identify the category in a user-friendly manner (for example, 'Office Supplies', 'Consulting Services'). |
| Finder | String | A searchable field used to locate specific records related to products and services in the supplier registration process. This field supports efficient search and filtering based on category and request details. |
| SupplierRegistrationKey | String | A unique identifier that links the products and services request data to the overall supplier registration request, ensuring all product/service details are correctly associated with the right supplier. |
Lists user roles available for assignment during supplier registration, ensuring appropriate access for new supplier users.
| Name | Type | Description |
| RoleGUID [KEY] | String | A globally unique identifier (GUID) that is assigned to each role in the system. This identifier ensures that each role can be uniquely referenced across systems and data sets. |
| RoleId | Long | A unique numeric identifier for the role in the supplier registration system. This ID is used to differentiate between various roles that are assigned to users or contacts within the registration process. |
| RoleName | String | The name of the role within the supplier registration system. Examples may include 'Admin', 'Supplier', 'Manager', or 'Approver'. This field is used to identify the role in a human-readable format. |
| Description | String | A detailed description of the role, explaining its purpose and responsibilities within the supplier registration process. This description helps clarify the duties and scope of authority associated with the role. |
| Finder | String | A searchable field that allows users to easily locate specific roles within the system. This field is typically used to assist with filtering and identifying roles quickly in the user interface. |
Holds custom descriptive flexfields for supplier address records, enabling extended data capture as needed.
| Name | Type | Description |
| SuppliersSupplierId [KEY] | Long | The unique identifier for the supplier associated with the supplier address in the SuppliersaddressesDFF table. |
| AddressesSupplierAddressId [KEY] | Long | The unique identifier for the supplier address in the SuppliersaddressesDFF table. |
| PartySiteId [KEY] | Long | The unique identifier for the party site associated with the supplier address in the SuppliersaddressesDFF table. |
| _FLEX_Context | String | A system-generated context for the flexible data fields related to the supplier address in the SuppliersaddressesDFF table. |
| _FLEX_Context_DisplayValue | String | The display value of the _FLEX_Context, providing a human-readable representation of the context in the SuppliersaddressesDFF table. |
| BilltoBuId | Long | The unique identifier for the billing business unit associated with the supplier address in the SuppliersaddressesDFF table. |
| BindPurchaseFlag | String | Indicates whether the supplier address is bound to purchasing activities. The value can be 'true' if bound to purchases or 'false' if not. |
| BindReqBuId | Long | The unique identifier for the business unit that is required for supplier address processing in the SuppliersaddressesDFF table. |
| BindSourcingOnlyFlag | String | Indicates whether the supplier address is restricted to sourcing-related activities only. The value is 'true' if limited to sourcing, and 'false' otherwise. |
| BindSysdate | Date | The system date when the binding operation for the supplier address was performed in the SuppliersaddressesDFF table. |
| Finder | String | A reference to a search or lookup function associated with the supplier address in the SuppliersaddressesDFF table. |
| SupplierId | Long | The unique identifier for the supplier associated with the flexible data fields in the SuppliersaddressesDFF table. |
Provides attachment capabilities for supplier records (for example, contracts, certifications), enhancing reference documentation.
| Name | Type | Description |
| SuppliersSupplierId [KEY] | Long | The unique identifier for the supplier associated with the attachment in the Suppliersattachments table. |
| AttachedDocumentId [KEY] | Long | A primary key that uniquely identifies the attachment. This ID is generated by the application when a user attaches a document to a record. |
| LastUpdateDate | Datetime | The timestamp of the most recent update made to the attachment record. |
| LastUpdatedBy | String | The user or system responsible for the last update made to the attachment record. |
| DatatypeCode | String | An abbreviation representing the data type of the attachment, indicating the format or kind of the attached file. |
| FileName | String | The name of the file attached to the supplier record. |
| DmFolderPath | String | The file path where the document is stored in the document management system. |
| DmDocumentId | String | A unique identifier for the document within the document management system. |
| DmVersionNumber | String | A version number assigned to the document, allowing tracking of changes over time. |
| Url | String | A URI (Uniform Resource Identifier) pointing to the location of the attachment. |
| CategoryName | String | The category or classification assigned to the attachment, such as 'Invoice,' 'Contract,' or 'Tax Form.' |
| UserName | String | The username of the individual who uploaded or is associated with the attachment. |
| Uri | String | A URI (Uniform Resource Identifier) that identifies the attachment, typically used for accessing or linking the file. |
| FileUrl | String | A URL (Uniform Resource Locator) pointing to the location where the attachment can be accessed or downloaded. |
| UploadedText | String | The text content of the uploaded attachment, if applicable, such as in a text-based file. |
| UploadedFileContentType | String | The content type of the attachment file, indicating its format. |
| UploadedFileLength | Long | The size of the uploaded file, measured in bytes. |
| UploadedFileName | String | The original file name given to the attachment when it was uploaded. |
| ContentRepositoryFileShared | Bool | Indicates whether the file is shared (true) or not shared (false) in the content repository. The default value is false. |
| Title | String | The title or subject of the attachment, providing a brief description of its content. |
| Description | String | A detailed description of the attachment, explaining its purpose or contents. |
| ErrorStatusCode | String | An error code that identifies the issue, if any, related to the attachment. |
| ErrorStatusMessage | String | A message explaining the error, if any, associated with the attachment. |
| CreatedBy | String | The user or system responsible for creating the attachment record. |
| CreationDate | Datetime | The timestamp when the attachment was originally created or uploaded to the system. |
| FileContents | String | The contents of the attachment, stored as text, if the file type allows it. |
| ExpirationDate | Datetime | The date when the attachment is no longer valid or accessible, marking its expiration. |
| LastUpdatedByUserName | String | The username of the individual who last updated the attachment record. |
| CreatedByUserName | String | The username of the individual who originally created the attachment record. |
| AsyncTrackerId | String | An identifier used for tracking the asynchronous file upload process. |
| FileWebImage | String | An image associated with the file, typically used for web display or previews of the attachment. |
| DownloadInfo | String | A JSON object containing information required to programmatically retrieve the attachment file. |
| PostProcessingAction | String | The action that can be taken after the attachment is uploaded, such as processing, validating, or moving the file. |
| BilltoBuId | Long | The unique identifier for the billing business unit associated with the attachment. |
| BindPurchaseFlag | String | Indicates whether the attachment is bound to purchase-related activities (true) or not (false). |
| BindReqBuId | Long | The unique identifier for the business unit that is required for processing the attachment. |
| BindSourcingOnlyFlag | String | Indicates whether the attachment is bound to sourcing-related activities only (true) or available for other uses (false). |
| BindSysdate | Date | The system date when the attachment binding action was executed. |
| Finder | String | A reference to a lookup or search function used for finding or retrieving the attachment. |
| SupplierId | Long | The unique identifier for the supplier associated with this attachment record. |
Specifies recognized business types or certifications (for example, minority-owned) for a supplier, meeting regulatory or diversity goals.
| Name | Type | Description |
| SuppliersSupplierId [KEY] | Long | The unique identifier for the supplier associated with the business classification. |
| ClassificationId [KEY] | Long | A unique identifier for the business classification assigned to the supplier. |
| ClassificationCode | String | An abbreviation that identifies the supplier's business classification. Valid values are defined in the lookup type POZ_BUSINESS_CLASSIFICATIONS, which can be reviewed and updated through the Setup and Maintenance work area. |
| Classification | String | A description of the business classification for the supplier, such as 'Minority-Owned' or 'Women-Owned.' |
| SubclassificationCode | String | An abbreviation identifying the subclassification when a minority group owns the business classification. Valid values are defined in the lookup type POZ_MINORITY_GROUP, which can be managed through the Setup and Maintenance work area. |
| Subclassification | String | A description of the subclassification for the business classification when it is owned by a minority group. |
| Status | String | The current status of the business classification for the supplier, such as 'Active' or 'Inactive.' |
| CertifyingAgencyId | Long | A unique identifier for the certifying agency that validates the supplier's business classification. |
| CertifyingAgency | String | The name of the agency that certifies the supplier's business classification. |
| OtherCertifyingAgency | String | The name of an alternative certifying agency if the standard agencies listed in the system do not apply. This field is used when a non-standard agency is involved. |
| CertificateNumber | String | The certificate number issued by the certifying agency for the business classification. |
| CertificateStartDate | Date | The date when the certificate issued by the certifying agency for the business classification becomes effective. |
| CertificateExpirationDate | Date | The date when the certificate issued by the certifying agency for the business classification expires. |
| Notes | String | Additional notes or comments describing the business classification for the supplier. These notes can be entered by the supplier or the person managing the classification. |
| ProvidedByUserFirstName | String | The first name of the individual in the supplier organization who provides the business classification details. |
| ProvidedByUserLastName | String | The last name of the individual in the supplier organization who provides the business classification details. |
| ConfirmedOnDate | Date | The date when the business classification was confirmed by the application for the supplier. |
| ProvidedByContactId | Long | A unique identifier for the individual in the supplier organization who provides the business classification details. |
| ProvidedByEmail | String | The email address of the individual in the supplier organization who provides the business classification details. |
| CreationDate | Datetime | The timestamp when the business classification record for the supplier was created. |
| CreatedBy | String | The user or system that created the business classification record for the supplier. |
| LastUpdateDate | Datetime | The timestamp of the most recent update made to the business classification record for the supplier. |
| LastUpdatedBy | String | The user or system that last updated the business classification record for the supplier. |
| BilltoBuId | Long | The unique identifier for the billing business unit associated with the business classification record. |
| BindPurchaseFlag | String | Indicates whether the business classification is bound to purchasing-related activities (true) or not (false). |
| BindReqBuId | Long | The unique identifier for the business unit required for processing the business classification. |
| BindSourcingOnlyFlag | String | Indicates whether the business classification is bound to sourcing-related activities only (true), or has broader applicability (false). |
| BindSysdate | Date | The system date when the binding action for the business classification was executed. |
| Finder | String | A reference to a search or lookup function used to find or retrieve the business classification details. |
| SupplierId | Long | The unique identifier for the supplier associated with this business classification record. |
Associates proof documents (certificates, letters) with the supplier’s business classification, validating their status.
| Name | Type | Description |
| SuppliersSupplierId [KEY] | Long | The unique identifier for the supplier associated with the business classification attachment. |
| BusinessclassificationsClassificationId [KEY] | Long | The unique identifier for the business classification attached to the supplier. |
| AttachedDocumentId [KEY] | Long | A primary key that uniquely identifies the attachment for the business classification. This ID is created by the system when a document is attached. |
| LastUpdateDate | Datetime | The timestamp of the last update made to the attachment record for the business classification. |
| LastUpdatedBy | String | The user or system responsible for the most recent update to the attachment record. |
| DatatypeCode | String | An abbreviation representing the data type of the attached document, indicating the format of the file. |
| FileName | String | The name of the file attached to the business classification record. |
| DmFolderPath | String | The folder path where the attached document is stored in the document management system. |
| DmDocumentId | String | A unique identifier for the document within the document management system, ensuring it can be uniquely referenced. |
| DmVersionNumber | String | A version number assigned to the attached document, used for version control of the document. |
| Url | String | A URI (Uniform Resource Identifier) pointing to the location of the attached document. |
| CategoryName | String | The category or type of the attachment, such as 'Compliance Certificate,' 'Business Certification,' or 'Tax Document.' |
| UserName | String | The username of the individual who uploaded or is associated with the attachment. |
| Uri | String | The URI (Uniform Resource Identifier) that identifies the attachment, typically used for linking or accessing the file. |
| FileUrl | String | The URL (Uniform Resource Locator) pointing to the location where the attached document can be accessed or downloaded. |
| UploadedText | String | The text content of the uploaded attachment, if applicable, such as for text-based files. |
| UploadedFileContentType | String | The content type of the attachment, indicating its format. |
| UploadedFileLength | Long | The size of the uploaded file in bytes. |
| UploadedFileName | String | The original name of the file as uploaded by the user. |
| ContentRepositoryFileShared | Bool | Indicates whether the attached document is shared within the content repository. 'True' means it is shared, and 'False' means it is not. The default value is 'False.' |
| Title | String | The title or subject of the attachment, summarizing its content. |
| Description | String | A detailed description of the attachment, explaining its purpose or contents. |
| ErrorStatusCode | String | An error code that identifies any issues encountered with the attachment, if applicable. |
| ErrorStatusMessage | String | A message that provides further details about any error encountered with the attachment. |
| CreatedBy | String | The user or system that created the attachment record for the business classification. |
| CreationDate | Datetime | The timestamp when the attachment was originally created or uploaded. |
| FileContents | String | The contents of the attachment, stored as text if the file type allows it. |
| ExpirationDate | Datetime | The expiration date of the attachment, marking when it is no longer valid or accessible. |
| LastUpdatedByUserName | String | The username of the individual who last updated the attachment record. |
| CreatedByUserName | String | The username of the individual who originally created the attachment record. |
| AsyncTrackerId | String | An identifier used to track the progress or status of the uploaded file during the asynchronous upload process. |
| FileWebImage | String | An image associated with the file, typically used for web display or preview of the attachment. |
| DownloadInfo | String | A JSON object containing information required to programmatically retrieve the attachment, such as API call details. |
| PostProcessingAction | String | The name of the post-processing action that can be taken after the attachment is uploaded, such as validation or approval. |
| BilltoBuId | Long | The unique identifier for the billing business unit associated with the business classification attachment. |
| BindPurchaseFlag | String | Indicates whether the attachment is linked to purchasing-related activities. The value can be 'true' or 'false.' |
| BindReqBuId | Long | The unique identifier for the business unit that is required for processing the business classification attachment. |
| BindSourcingOnlyFlag | String | Indicates whether the attachment is limited to sourcing-related activities only (true) or if it has broader applicability (false). |
| BindSysdate | Date | The system date when the attachment binding operation was performed. |
| Finder | String | A reference to a lookup or search function used for locating the attachment within the system. |
| SupplierId | Long | The unique identifier for the supplier associated with this attachment record. |
Links specific addresses to a supplier contact (for example, branch office, headquarters), clarifying shipping or invoice routes.
| Name | Type | Description |
| SuppliersSupplierId [KEY] | Long | The unique identifier for the supplier associated with the supplier contact address. |
| ContactsPersonProfileId [KEY] | Long | The unique identifier for the person profile associated with the contact, linking the contact's profile to their contact address. |
| ContactsSupplierContactId [KEY] | Long | The unique identifier for the supplier contact linked to the supplier contact address. |
| SupplierContactAddressId [KEY] | Long | A unique identifier for the supplier contact address, distinguishing it from other addresses in the system. |
| SupplierAddressId | Long | The unique identifier for the supplier address associated with the supplier contact. This helps link the contact to their specific location. |
| AddressName | String | The name assigned to the supplier address associated with the supplier contact, used to identify or distinguish the address. |
| CreationDate | Datetime | The timestamp when the supplier contact address record was created in the system. |
| CreatedBy | String | The user or system that created the supplier contact address record. |
| LastUpdateDate | Datetime | The timestamp of the last update made to the supplier contact address record. |
| LastUpdatedBy | String | The user or system that last updated the supplier contact address record. |
| BilltoBuId | Long | The unique identifier for the billing business unit associated with the supplier contact address. |
| BindPurchaseFlag | String | Indicates whether the supplier contact address is linked to purchasing-related activities. The value can be 'true' (linked) or 'false' (not linked). |
| BindReqBuId | Long | The unique identifier for the business unit required for processing the supplier contact address. |
| BindSourcingOnlyFlag | String | Indicates whether the supplier contact address is restricted to sourcing-related activities only. 'True' means the address is limited to sourcing; 'False' means it can be used for other purposes. |
| BindSysdate | Date | The system date when the binding action for the supplier contact address was executed. |
| Finder | String | A reference to a lookup or search function used for locating or retrieving the supplier contact address record. |
| SupplierId | Long | The unique identifier for the supplier associated with this supplier contact address record. |
Provides descriptive flexfields for supplier contact details, enabling custom fields beyond standard attributes.
| Name | Type | Description |
| SuppliersSupplierId [KEY] | Long | The unique identifier for the supplier associated with the supplier contact's flexible data fields (DFF). |
| ContactsPersonProfileId [KEY] | Long | The unique identifier for the person profile associated with the supplier contact, linking the contact's personal details to their flexible data fields. |
| ContactsSupplierContactId [KEY] | Long | The unique identifier for the supplier contact linked to the flexible data fields for the contact. |
| PersonProfileId [KEY] | Long | A unique identifier for the person profile associated with the flexible data fields in the context of the supplier contact. |
| _FLEX_Context | String | A system-generated context identifier for the flexible data fields related to the supplier contact, allowing for custom data storage and processing. |
| _FLEX_Context_DisplayValue | String | The display value of the _FLEX_Context, providing a human-readable description of the flexible data fields context. |
| BilltoBuId | Long | The unique identifier for the billing business unit associated with the supplier contact's flexible data fields. |
| BindPurchaseFlag | String | Indicates whether the supplier contact's flexible data fields are linked to purchase-related activities. The value can be 'true' or 'false'. |
| BindReqBuId | Long | The unique identifier for the business unit required for processing the supplier contact's flexible data fields. |
| BindSourcingOnlyFlag | String | Indicates whether the flexible data fields for the supplier contact are restricted to sourcing-related activities only. 'True' means the fields are restricted to sourcing; 'False' means they can be used for other activities. |
| BindSysdate | Date | The system date when the binding operation for the supplier contact's flexible data fields was executed. |
| Finder | String | A reference to a lookup or search function used for locating or retrieving the supplier contact's flexible data fields record. |
| SupplierId | Long | The unique identifier for the supplier associated with this supplier contact's flexible data fields record. |
Contains descriptive flexfields for supplier data at the header, storing extra organizational or region-specific information.
| Name | Type | Description |
| SuppliersSupplierId [KEY] | Long | The unique identifier for the supplier associated with the flexible data fields (DFF) for the supplier. |
| VendorId [KEY] | Long | The unique identifier assigned to the supplier by external systems or the organization. |
| OfficeRecyclingPercentage | Decimal | The percentage of office waste that is recycled by the supplier, reflecting their sustainability efforts. |
| DebtRating | String | The debt rating assigned to the supplier, which evaluates their creditworthiness and financial stability. |
| _FLEX_Context | String | The context name for the descriptive flexfield associated with the supplier sites, used to capture custom data for suppliers. |
| _FLEX_Context_DisplayValue | String | The display value for the _FLEX_Context, providing a user-friendly description of the descriptive flexfield context for supplier sites. |
| BilltoBuId | Long | The unique identifier for the billing business unit associated with the supplier's flexible data fields. |
| BindPurchaseFlag | String | Indicates whether the supplier's flexible data fields are linked to purchasing-related activities. 'True' means the fields are used for purchasing, 'False' means they are not. |
| BindReqBuId | Long | The unique identifier for the business unit that is required for processing the supplier's flexible data fields. |
| BindSourcingOnlyFlag | String | Indicates whether the supplier's flexible data fields are restricted to sourcing-related activities only. 'True' means the fields are limited to sourcing; 'False' means they can be used for other purposes. |
| BindSysdate | Date | The system date when the binding operation for the supplier's flexible data fields was executed. |
| Finder | String | A reference to a lookup or search function used for locating or retrieving the supplier's flexible data fields record. |
| SupplierId | Long | The unique identifier for the supplier associated with this flexible data fields record. |
Holds global descriptive flexfields for supplier records, allowing consistent multi-national data capture.
| Name | Type | Description |
| SuppliersSupplierId [KEY] | Long | The unique identifier for the supplier associated with the global flexible data fields (DFF). |
| VendorId [KEY] | Long | The unique identifier for the supplier, typically assigned by external systems or internal records. |
| _FLEX_Context | String | The context name for the descriptive flexfield (DFF) used to capture custom data for the supplier globally. |
| _FLEX_Context_DisplayValue | String | A user-friendly display value for the _FLEX_Context, providing a description of the context used for the supplier's global data fields. |
| BilltoBuId | Long | The unique identifier for the billing business unit associated with the supplier's global flexible data fields. |
| BindPurchaseFlag | String | Indicates whether the supplier's global data fields are linked to purchasing-related activities. The value is 'true' if they are linked, and 'false' if not. |
| BindReqBuId | Long | The unique identifier for the business unit required for processing the supplier's global flexible data fields. |
| BindSourcingOnlyFlag | String | Indicates whether the supplier's global data fields are restricted to sourcing-related activities only. 'True' means the fields are limited to sourcing, while 'False' means they are available for other uses. |
| BindSysdate | Date | The system date when the binding operation for the supplier's global data fields was performed. |
| Finder | String | A reference to a lookup or search function used to locate or retrieve the supplier's global flexible data fields record. |
| SupplierId | Long | The unique identifier for the supplier associated with the global flexible data fields. |
Specifies the goods or services a supplier offers, mapped to relevant categories in the procurement system.
| Name | Type | Description |
| SuppliersSupplierId [KEY] | Long | The unique identifier for the supplier associated with the products and services record. |
| ProductsServicesCategoryId | Long | The unique identifier for the products and services category that the supplier is associated with. |
| SupplierProductsServicesId [KEY] | Long | A unique identifier for the products and services record assigned to the supplier. |
| CategoryName | String | The name of the products and services category assigned to the supplier by the application. |
| CategoryDescription | String | A detailed description of the products and services category, explaining its scope or classification. |
| CategoryType | String | The type of products and services category assigned to the supplier, which can help categorize suppliers based on their offerings. |
| CreationDate | Datetime | The timestamp when the products and services record for the supplier was created in the system. |
| CreatedBy | String | The user or system that created the products and services record for the supplier. |
| LastUpdateDate | Datetime | The timestamp of the most recent update made to the products and services record for the supplier. |
| LastUpdatedBy | String | The user or system that last updated the products and services record for the supplier. |
| BilltoBuId | Long | The unique identifier for the billing business unit associated with the supplier's products and services record. |
| BindPurchaseFlag | String | Indicates whether the supplier's products and services record is linked to purchasing-related activities. The value can be 'true' (linked) or 'false' (not linked). |
| BindReqBuId | Long | The unique identifier for the business unit required for processing the supplier's products and services record. |
| BindSourcingOnlyFlag | String | Indicates whether the supplier's products and services record is restricted to sourcing-related activities only. 'True' means it is limited to sourcing; 'False' means it is available for other purposes. |
| BindSysdate | Date | The system date when the binding operation for the supplier's products and services record was executed. |
| Finder | String | A reference to a lookup or search function used for locating or retrieving the supplier's products and services record. |
| SupplierId | Long | The unique identifier for the supplier associated with this products and services record. |
Records supplier site details (for example, operational addresses, payment methods), facilitating transaction-level usage.
| Name | Type | Description |
| SuppliersSupplierId [KEY] | Long | The unique identifier for the supplier associated with the supplier site. |
| SupplierSiteId [KEY] | Long | A value that uniquely identifies the supplier site. This ID is used to distinguish one supplier site from another. |
| SupplierSite | String | The name of the supplier site, which is the designated location of the supplier. |
| ProcurementBUId | Long | A value that uniquely identifies the procurement business unit where the supplier site resides. This unit is responsible for managing procurement activities for the supplier site. |
| ProcurementBU | String | The procurement business unit that the supplier site belongs to. This unit handles procurement activities such as ordering and sourcing. |
| SupplierAddressId | Long | A value that uniquely identifies the supplier address. This address is associated with the supplier site. |
| SupplierAddressName | String | The name associated with the supplier address, which helps identify or label the address for use in procurement and communications. |
| InactiveDate | Date | The date when the supplier site was marked as inactive, indicating that the site is no longer used for transactions or business activities. |
| Status | String | The current status of the supplier site, such as 'Active,' 'Inactive,' or 'Pending.' This field reflects whether the site is functional. |
| SitePurposeSourcingOnlyFlag | Bool | Indicates whether the supplier site is used solely for sourcing purposes. 'True' means it is restricted to sourcing; 'False' means it has additional uses. Default is 'False.' |
| SitePurposePurchasingFlag | Bool | Indicates whether the supplier site has a purchasing purpose. 'True' means it is used for purchasing; 'False' means it is not. Default value is 'False.' |
| SitePurposeProcurementCardFlag | Bool | Indicates whether the supplier site is enabled for procurement card transactions. 'True' means procurement card usage is allowed; 'False' means it is not. Default is 'False.' |
| SitePurposePayFlag | Bool | Indicates whether the supplier site is used for payment transactions. 'True' means payment transactions are processed through this site; 'False' means they are not. Default value is 'False.' |
| SitePurposePrimaryPayFlag | Bool | Indicates whether the supplier site serves as the primary site for payments. 'True' means it is the main payment site; 'False' means it is not. Default is 'False.' |
| IncomeTaxReportingSiteFlag | Bool | Indicates whether the supplier site is used for income tax reporting. 'True' means it is a tax reporting site; 'False' means it is not. Default value is 'False.' |
| AlternateSiteName | String | An alternate name for the supplier site, often used for different regions or specialized purposes. |
| CustomerNumber | String | A unique identifier assigned to the supplier site by the buying organization. This number helps in tracking and managing supplier relationships. |
| B2BCommunicationMethodCode | String | An abbreviation that identifies the communication method used for B2B transactions with the supplier site. Accepted values are defined in the lookup type ORA_POZ_B2B_COMM_METHOD, which can be reviewed and updated in the Setup and Maintenance work area, under 'Manage Standard Lookups.' |
| B2BCommunicationMethod | String | Indicates whether B2B messaging is enabled for the supplier site. This method allows documents to be exchanged using a common messaging framework in B2B transactions. |
| B2BSupplierSiteCode | String | A unique abbreviation identifying the supplier site used in punchout catalogs for Self-Service Procurement, which facilitates ordering processes from supplier websites. |
| CommunicationMethodCode | String | An abbreviation that identifies the preferred method of communication for the supplier site. Accepted values are defined in the lookup type DOCUMENT_COMMUNICATION_METHOD. These values include options such as 'FAX,' 'EMAIL,' and 'PRINT,' and cannot be modified. |
| CommunicationMethod | String | Indicates the preferred communication method for the supplier site, with values like 'NONE,' 'FAX,' 'EMAIL,' or 'PRINT,' managed through the DOCUMENT_COMMUNICATION_METHOD lookup type. |
| String | The email address used for communication with the supplier site, which may be required for electronic correspondence or document sharing. | |
| FaxCountryCode | String | The country code for the fax number used by the supplier site for fax communication. |
| FaxAreaCode | String | The area code for the fax number used by the supplier site, necessary for dialing the correct region. |
| FaxNumber | String | The actual fax number used for communication at the supplier site. |
| HoldAllNewPurchasingDocumentsFlag | Bool | Indicates whether all new purchasing documents for the supplier site should be placed on hold. 'True' means all new documents are held; 'False' means they are not. Default value is 'False.' |
| PurchasingHoldReason | String | The reason provided for placing a hold on purchasing documents for the supplier site. This field can explain why purchasing is restricted for the site. |
| AllNewPurchasingDocumentsHoldDate | Datetime | The date when the hold was placed on all new purchasing documents for the supplier site. This helps in tracking when restrictions were enforced. |
| AllNewPurchasingDocumentsHoldBy | String | The user or system responsible for placing the hold on new purchasing documents for the supplier site. |
| RequiredAcknowledgmentCode | String | An abbreviation identifying whether acknowledgment is required for purchasing documents created for the supplier site. Valid values include 'D' (Document), 'Y' (Yes), and 'N' (No). These values are used to control acknowledgment workflows. |
| RequiredAcknowledgment | String | The type of acknowledgment required when purchasing documents are created for the supplier site. Possible values include 'Document,' 'Document and Schedule,' and 'None.' This can be configured in the Setup and Maintenance work area. |
| AcknowledgmentWithinDays | Int | The number of days the supplier site has to acknowledge the purchasing document, which can help enforce timelines for document processing. |
| CarrierId | Decimal | A unique identifier for the carrier used by the supplier site for shipping, necessary for tracking shipments and coordinating delivery. |
| Carrier | String | The name of the carrier selected by the supplier site to handle shipping logistics. |
| ModeOfTransportCode | String | An abbreviation identifying the mode of transport used by the supplier site for shipping. Accepted values are defined in the lookup type WSH_MODE_OF_TRANSPORT, and can be reviewed and updated in the Setup and Maintenance work area. |
| ModeOfTransport | String | The mode of transport used by the supplier site for shipping, such as 'Air,' 'Sea,' or 'Road.' These transport options are defined in the WSH_MODE_OF_TRANSPORT lookup type. |
| ServiceLevelCode | String | An abbreviation that identifies the service levels the supplier site uses for shipping. Accepted values are defined in the lookup type WSH_SERVICE_LEVELS and can be reviewed in the Setup and Maintenance work area. |
| ServiceLevel | String | The shipping service level selected by the supplier site, such as 'Standard' or 'Express.' These options are defined in the WSH_SERVICE_LEVELS lookup type. |
| FreightTermsCode | String | An abbreviation identifying the freight terms for shipping from the supplier site. Accepted values are defined in the lookup type FREIGHT_TERMS. Review and update these values in the Setup and Maintenance work area. |
| FreightTerms | String | The freight terms governing shipping from the supplier site, such as 'FOB' or 'CIF.' These terms dictate the responsibility for shipping costs and delivery. |
| PayOnReceiptFlag | Bool | Indicates whether the supplier site allows payment on receipt. 'True' means payments can be made once goods are received; 'False' means payments are made later in the process. Default is 'False.' |
| FOBCode | String | An abbreviation identifying the Free On Board (FOB) value used by the supplier site. Accepted values are defined in the lookup type FOB, which can be updated in the Setup and Maintenance work area. |
| FOB | String | The Free On Board (FOB) shipping terms that determine when ownership of goods transfers to the buyer, which affects payment and delivery responsibility. |
| CountryOfOriginCode | String | An abbreviation identifying the country of origin used by the supplier site for calculating freight costs. |
| CountryOfOrigin | String | The country of origin used by the supplier site to calculate freight, which may affect shipping costs and import/export regulations. |
| BuyerManagedTransportationCode | String | An abbreviation indicating whether the buyer manages transportation for the supplier site. Accepted values are defined in the lookup type YES_NO. These values can be reviewed and updated in the Setup and Maintenance work area. |
| BuyerManagedTransportation | String | Indicates whether the buyer manages transportation for the supplier site. 'Y' means Yes, and 'N' means No. |
| PayOnUseFlag | Bool | Indicates whether the supplier site allows payment on use. 'True' means payment can be made when the goods are used; 'False' means it is not allowed. Default value is 'False.' |
| AgingOnsetPointCode | String | An abbreviation identifying the point where the supplier and the buying organization agree to begin aging consigned material. Accepted values are defined in the lookup type AGING_ONSET_POINT. |
| AgingOnsetPoint | String | The point where the supplier and buying organization agree to start aging consigned materials, which determines the accounting and inventory treatment of consigned stock. |
| AgingPeriodDays | Int | The maximum number of days material can remain on consignment before it is considered aged, which affects inventory valuation. |
| ConsumptionAdviceFrequencyCode | String | An abbreviation identifying how frequently the Create Consumption Advice application runs for consumption transactions. This application tracks the consigned inventory purchased under a single agreement. Accepted values are defined in the lookup type CONSUMPTION_ADVICE_FREQUENCY. |
| ConsumptionAdviceFrequency | String | Indicates the frequency with which the Create Consumption Advice application runs for consumption transactions, such as daily, weekly, or monthly. Values are defined in the CONSUMPTION_ADVICE_FREQUENCY lookup type. |
| ConsumptionAdviceSummaryCode | String | An abbreviation identifying the level of detail to use when creating the consumption advice. Accepted values are defined in the lookup type CONSUMPTION_ADVICE_SUMMARY, which can be updated in the Setup and Maintenance work area. |
| ConsumptionAdviceSummary | String | The level of detail used for consumption advice, such as 'Summary' or 'Detailed.' These values can be configured in the CONSUMPTION_ADVICE_SUMMARY lookup type. |
| AlternatePaySiteId | Long | A unique identifier for the alternate pay site that is associated with the supplier site. This field is used to designate a different location for processing payments. |
| AlternatePaySite | String | The name of the alternate pay site, which may be used for different payment locations other than the primary pay site. |
| InvoiceSummaryLevelCode | String | An abbreviation identifying how invoices should be grouped and summarized for the supplier site. Accepted values are defined in the lookup type POZ_ERS_INVOICE_SUMMARY. |
| InvoiceSummaryLevel | String | The level of invoice detail used for grouping and summarizing invoices for the supplier site. Values may include 'Basic' or 'Detailed' and are defined in the POZ_ERS_INVOICE_SUMMARY lookup type. |
| GaplessInvoiceNumberingFlag | Bool | Indicates whether the supplier site uses gapless invoice numbering. 'True' means invoices are consecutively numbered with no gaps, while 'False' means gaps can occur. Default value is 'False.' |
| SellingCompanyIdentifier | String | A unique identifier for the selling company that is required when the supplier site uses gapless invoice numbering to ensure sequential numbering of invoices. |
| CreateDebitMemoFromReturnFlag | Bool | Indicates whether the supplier site creates a debit memo when a return transaction occurs. 'True' means a debit memo is generated; 'False' means it is not. Default value is 'False.' |
| ShipToExceptionCode | String | An abbreviation identifying the action to take when the receiving location differs from the ship-to location. Accepted values are defined in the lookup type RCV_RECEIVING_OPTION, which can be reviewed and updated in the Setup and Maintenance work area. |
| ShipToException | String | The action to take when the receiving location differs from the ship-to location, such as 'Redirect,' 'Hold,' or 'Notify.' These actions are defined in the RCV_RECEIVING_OPTION lookup type. |
| ReceiptRoutingId | Decimal | A unique identifier for how to route each receipt for the supplier site. Routing methods can vary and are defined based on business requirements. |
| ReceiptRouting | String | Indicates the method for routing receipts at the supplier site, such as 'Manual' or 'Automated.' These values can be configured in the system to determine how receipts are processed. |
| OverReceiptTolerance | Decimal | The tolerance allowed when the receiving location receives more than the requested quantity. This tolerance level ensures proper handling of discrepancies in delivery. |
| OverReceiptActionCode | String | An abbreviation identifying the action to take when the receiving location exceeds the allowable quantity tolerance. Accepted values are defined in the lookup type RCV_RECEIVING_OPTION, such as 'Accept' or 'Reject.' |
| OverReceiptAction | String | The action to take when the receiving location receives more than the tolerated quantity, such as 'Accept,' 'Reject,' or 'Notify.' These actions are defined in the RCV_RECEIVING_OPTION lookup type. |
| EarlyReceiptToleranceInDays | Decimal | The number of days in advance the receiving location can receive goods before the expected receipt date. This value helps prevent premature deliveries from causing issues in the inventory system. |
| LateReceiptToleranceInDays | Decimal | The number of days after the expected receipt date that the receiving location can still accept goods. This ensures flexibility in delivery schedules. |
| AllowSubstituteReceiptsCode | String | An abbreviation identifying whether substitute receipts are allowed for the supplier site. Accepted values are defined in the lookup type YES_NO, such as 'Y' (Yes) or 'N' (No). |
| AllowSubstituteReceipts | String | Indicates whether the supplier site allows substitute receipts, which are alternative deliveries in place of the originally ordered items. Values include 'Y' (Yes) and 'N' (No). These options are defined in the YES_NO lookup type. |
| AllowUnorderedReceiptsFlag | Bool | Indicates whether the supplier site can accept receipts without an associated purchase order. 'True' means unordered receipts are allowed; 'False' means they are not. Default value is 'False.' |
| ReceiptDateExceptionCode | String | An abbreviation identifying the action to take when the supplier site receives an item outside the allowed receipt date range. Accepted values are defined in the lookup type RCV_RECEIVING_OPTION. |
| ReceiptDateException | String | The action to take when the supplier site receives an item before the Early Receipt Tolerance or after the Late Receipt Tolerance period, such as 'Hold,' 'Notify,' or 'Reject.' These actions are defined in the RCV_RECEIVING_OPTION lookup type. |
| InvoiceCurrencyCode | String | An abbreviation identifying the currency used for invoicing at the supplier site. Accepted values are defined in the lookup type CURRENCY_CODE. |
| InvoiceCurrency | String | The currency used for invoicing at the supplier site, such as 'USD' for US Dollars or 'EUR' for Euros. |
| InvoiceAmountLimit | Decimal | Indicates the maximum amount that an invoice can reach before being placed on hold. This amount ensures that large invoices are reviewed before processing. |
| InvoiceMatchOptionCode | String | An abbreviation identifying whether to create a relationship between the invoice and a purchase order, receipt, or consumption advice. Accepted values are defined in the lookup type INVOICE_MATCH_OPTION. |
| InvoiceMatchOption | String | Indicates whether to create a relationship between the invoice and a purchase order, receipt, or consumption advice, such as 'PO' for Purchase Order or 'Receipt' for Goods Receipt. |
| MatchApprovalLevelCode | String | An abbreviation identifying the approval level required when creating a relationship between the invoice and a purchase order, receipt, or consumption advice. Accepted values are defined in the lookup type INVOICE_MATCH. |
| MatchApprovalLevel | String | The level of approval required when matching an invoice to a purchase order, receipt, or consumption advice, such as 'Manager,' 'Director,' or 'VP.' |
| QuantityTolerancesId | Long | A unique identifier for the tolerance applied to quantity when creating an invoice for the supplier site. These tolerances help ensure that small discrepancies in quantities are handled appropriately. |
| QuantityTolerances | String | The quantity tolerance applied when creating an invoice for the supplier site, such as '5%' or '10%.' These values help manage acceptable discrepancies in order quantities. |
| AmountTolerancesId | Long | A unique identifier for the tolerance applied to the amount when creating an invoice for the supplier site. |
| AmountTolerances | String | The amount tolerance applied when creating an invoice for the supplier site, such as '5%' or '10%.' This tolerance ensures small errors in billing are accepted within the set limits. |
| InvoiceChannelCode | String | An abbreviation identifying the channel used to submit invoices from the supplier site. Accepted values are defined in the lookup type ORA_POZ_INVOICE_CHANNEL. |
| InvoiceChannel | String | The channel through which invoices are submitted from the supplier site, such as 'EDI,' 'Fax,' or 'Email.' These options are managed through the ORA_POZ_INVOICE_CHANNEL lookup type. |
| PaymentCurrencyCode | String | An abbreviation identifying the currency used for payments to the supplier site. |
| PaymentCurrency | String | The currency used to make payments to the supplier site, such as 'USD' for US Dollars or 'EUR' for Euros. |
| PaymentPriority | Decimal | The priority assigned to an invoice during payment processing. Higher values indicate higher payment priority. |
| PayGroupCode | String | An abbreviation identifying the withholding tax group for the supplier site. Accepted values are defined in the lookup type PAY_GROUP. |
| PayGroup | String | The withholding tax group associated with the supplier site, which determines how taxes are handled during payment processing. |
| HoldAllInvoicesFlag | Bool | Indicates whether all invoices for the supplier site are placed on hold. 'True' means invoices are held; 'False' means they are processed normally. Default value is 'False.' |
| HoldUnmatchedInvoicesCode | String | An abbreviation identifying whether to place a hold on invoices that do not have a matching purchase order, receipt, or consumption advice. Accepted values are defined in the lookup type POZ_PAYABLES_OPTIONS. |
| HoldUnmatchedInvoices | String | Indicates whether to place a hold on invoices that do not match a purchase order, receipt, or consumption advice. Values include 'Y' for Yes and 'N' for No. |
| HoldUnvalidatedInvoicesFlag | Bool | Indicates whether the supplier site places invoices that cannot be validated on hold. 'True' means they are placed on hold; 'False' means they are not. Default value is 'False.' |
| PaymentHoldDate | Date | The date when the application places payments for the supplier site on hold. |
| PaymentHoldReason | String | The reason why payments to the supplier site are placed on hold, which could be due to various issues such as invoice discrepancies. |
| PaymentTermsId | Long | A unique identifier for the payment terms associated with the supplier site. |
| PaymentTerms | String | The terms of payment for the supplier site, such as 'Net 30' or 'Due on Receipt.' These terms specify the payment deadlines. |
| PaymentTermsDateBasisCode | String | An abbreviation identifying the date the application uses to calculate payment terms for the invoice. Accepted values are defined in the lookup type TERMS_DATE_BASIS. |
| PaymentTermsDateBasis | String | The date basis for calculating payment terms, such as 'Invoice Date' or 'Receipt Date.' This determines when payment terms start. |
| PayDateBasisCode | String | An abbreviation identifying the date the application uses to schedule payment for the invoice. Accepted values are defined in the lookup type POZ_PAY_DATE_BASIS. |
| PayDateBasis | String | The basis for scheduling the payment date for the invoice, such as 'Invoice Date' or 'Due Date.' |
| BankChargeDeductionTypeCode | String | An abbreviation identifying how bank charges are deducted when paying the invoice. Accepted values are defined in the lookup type BANK_CHARGE_DEDUCTION_TYPE. |
| BankChargeDeductionType | String | The method used to deduct bank charges when paying the invoice. Possible values include 'S' for Standard Deduction, 'D' for Default Deduction, and 'N' for Negotiated Deduction. |
| AlwaysTakeDiscountCode | String | An abbreviation that determines whether to apply a discount on the payment. Accepted values are defined in the lookup type POZ_PAYABLES_OPTIONS. |
| AlwaysTakeDiscount | String | Indicates whether to always apply a discount on the payment. Possible values include 'Y' for Yes, 'N' for No, and 'D' for Default. |
| ExcludeFreightFromDiscountCode | String | An abbreviation that determines whether to exclude freight from the discount calculation. Accepted values are defined in the lookup type POZ_PAYABLES_OPTIONS. |
| ExcludeFreightFromDiscount | String | Indicates whether to exclude freight charges from the discount calculation. Possible values include 'Y' (Exclude Freight), 'N' (Include Freight), and 'D' (Default). |
| ExcludeTaxFromDiscountCode | String | An abbreviation that determines whether to exclude tax from the discount calculation. Accepted values are defined in the lookup type POZ_PAYABLES_OPTIONS. |
| ExcludeTaxFromDiscount | String | Indicates whether to exclude tax from the discount calculation. Possible values include 'Y' (Exclude Tax), 'N' (Include Tax), and 'D' (Default). |
| CreateInterestInvoicesCode | String | An abbreviation identifying whether to create an interest invoice for late payments. Accepted values are defined in the lookup type POZ_PAYABLES_OPTIONS. |
| CreateInterestInvoices | String | Indicates whether to create an interest invoice for late payments. Possible values include 'Y' (Create Interest Invoice), 'N' (Do not create), and 'D' (Default). |
| CreationDate | Datetime | The date and time when the supplier site record was created in the system. |
| CreatedBy | String | The user or system responsible for creating the supplier site record. |
| LastUpdateDate | Datetime | The date and time of the most recent update made to the supplier site record. |
| LastUpdatedBy | String | The user or system responsible for the last update made to the supplier site record. |
| OverrideB2BCommunicationforSpecialHandlingOrdersFlag | Bool | Indicates whether the B2B communication configuration is overridden for special handling orders. 'True' means it is overridden; 'False' means it is not. Default is 'True.' |
| BilltoBuId | Long | The unique identifier for the billing business unit associated with the supplier site. |
| BindPurchaseFlag | String | Indicates whether the supplier site is bound to purchasing activities. A value of 'True' means the supplier site is associated with purchasing processes. |
| BindReqBuId | Long | The unique identifier for the business unit required for processing the supplier site. |
| BindSourcingOnlyFlag | String | Indicates whether the supplier site is restricted to sourcing-related activities. 'True' means it is sourcing-only; 'False' means other activities are permitted. |
| BindSysdate | Date | The system date when the binding operation for the supplier site was executed. |
| Finder | String | A reference or search function used for locating or retrieving the supplier site record in the system. |
| SupplierId | Long | The unique identifier for the supplier associated with the supplier site record. |
Determines how supplier sites are assigned to internal business units or ledger sets, managing usage boundaries.
| Name | Type | Description |
| SuppliersSupplierId [KEY] | Long | The unique identifier for the supplier associated with the supplier site assignment. |
| SitesSupplierSiteId [KEY] | Long | A unique identifier for the supplier site that is assigned to the client business unit in the procurement system. |
| AssignmentId [KEY] | Long | A value that uniquely identifies the supplier site assignment, used to track which supplier site is assigned to a particular business unit. |
| ClientBUId | Long | The unique identifier for the business unit that is the client of the procurement business unit where the supplier site resides. This ID is used to link supplier sites to specific client business units. |
| ClientBU | String | The name of the business unit that is a client of the procurement business unit. This business unit utilizes the supplier site for procurement purposes. |
| BillToBUId | Long | The unique identifier for the business unit that the system uses for billing, instead of the client business unit selected by the user. |
| BillToBU | String | The name of the business unit that is used for billing purposes instead of the client business unit selected by the user. |
| ShipToLocationId | Long | The unique identifier for the default shipping location used on purchasing documents for the client business unit. |
| ShipToLocation | String | The name of the default shipping location for the supplier site assignment, used in purchasing transactions. |
| ShipToLocationCode | String | An abbreviation identifying the shipping location. Review and update this value in the Setup and Maintenance work area, under the 'Manage Locations' task. |
| BillToLocationId | Long | The unique identifier for the default billing location used on purchasing documents for the selected bill-to business unit. |
| BillToLocation | String | The name of the default billing location for the supplier site assignment. |
| BillToLocationCode | String | An abbreviation identifying the billing location. Review and update this value in the Setup and Maintenance work area, under the 'Manage Locations' task. |
| UseWithholdingTaxFlag | Bool | Indicates whether withholding tax applies to the supplier site assignment. 'True' means withholding tax is applicable; 'False' means it is not. Default value is 'False.' |
| WithholdingTaxGroupId | Long | A unique identifier for the tax group assigned to the supplier site assignment for withholding tax purposes. |
| WithholdingTaxGroup | String | The description of the withholding tax group assigned to the supplier site assignment. |
| ChartOfAccountsId | Long | The unique identifier for the chart of accounts used by the supplier site assignment. This helps manage financial transactions for the site. |
| LiabilityDistributionId | Long | A unique identifier for the liability distribution used to allocate the liability for new invoices for the supplier site. |
| LiabilityDistribution | String | The description of the liability distribution for new invoices associated with the supplier site. |
| PrepaymentDistributionId | Long | A unique identifier for the prepayment distribution used to allocate prepayments made for the supplier site. |
| PrepaymentDistribution | String | The description of the prepayment distribution associated with the supplier site. |
| BillPayableDistributionId | Long | A unique identifier for the bill payable distribution used to allocate the payable bills for the supplier site. |
| BillPayableDistribution | String | The description of the bill payable distribution for the supplier site, used to track and manage payable bills. |
| DistributionSetId | Long | A unique identifier for the distribution set that determines the distribution of charges on invoices for the supplier site. |
| DistributionSet | String | The distribution set used to determine how charges are allocated on invoices for the supplier site. |
| InactiveDate | Date | The date when the supplier site assignment was marked as inactive and is no longer used for business transactions. |
| Status | String | The current status of the supplier site assignment, which can include 'Active,' 'Inactive,' or 'Pending.' |
| CreationDate | Datetime | The timestamp when the supplier site assignment was created in the system. |
| CreatedBy | String | The user or system responsible for creating the supplier site assignment. |
| LastUpdateDate | Datetime | The timestamp of the most recent update made to the supplier site assignment. |
| LastUpdatedBy | String | The user or system responsible for the last update made to the supplier site assignment. |
| BindPurchaseFlag | String | Indicates whether the supplier site assignment is bound to purchasing activities. A value of 'True' means it is bound to purchasing; 'False' means it is not. |
| BindReqBuId | Long | The unique identifier for the business unit required for processing the supplier site assignment. |
| BindSourcingOnlyFlag | String | Indicates whether the supplier site assignment is restricted to sourcing activities only. A value of 'True' means it is sourcing-only; 'False' means other activities are allowed. |
| BindSysdate | Date | The system date when the binding operation for the supplier site assignment was executed. |
| Finder | String | A reference or search function used to locate or retrieve the supplier site assignment in the system. |
| SupplierId | Long | The unique identifier for the supplier associated with the supplier site assignment. |
Tracks documents tied to a supplier site, such as compliance documents or service-level agreements.
| Name | Type | Description |
| SuppliersSupplierId [KEY] | Long | The unique identifier for the supplier associated with the attachment on the supplier site. |
| SitesSupplierSiteId [KEY] | Long | A unique identifier for the supplier site associated with the attachment. |
| AttachedDocumentId [KEY] | Long | A value that uniquely identifies the attachment for a specific supplier site. This is the primary key created when the user attaches a document to the supplier site. |
| LastUpdateDate | Datetime | The timestamp of the last update made to the attachment for the supplier site. |
| LastUpdatedBy | String | The user or system that made the last update to the attachment. |
| DatatypeCode | String | An abbreviation identifying the type of data associated with the attachment. Accepted values may be defined in the data type lookup. |
| FileName | String | The name of the file attached to the supplier site record. |
| DmFolderPath | String | The folder path where the attachment is stored in the document management system. |
| DmDocumentId | String | A unique identifier for the attached document in the document management system. |
| DmVersionNumber | String | The version number assigned to the attached document. |
| Url | String | The URI (Uniform Resource Identifier) that uniquely identifies the attachment. |
| CategoryName | String | The category of the attachment, which helps classify the document for easier management. |
| UserName | String | The username of the person who uploaded the attachment to the supplier site. |
| Uri | String | The URI (Uniform Resource Identifier) pointing to the location of the attachment in the system. |
| FileUrl | String | The URL (Uniform Resource Locator) of the attachment, used for direct access to the file. |
| UploadedText | String | The text content of the uploaded attachment, if applicable. |
| UploadedFileContentType | String | The content type of the uploaded file, indicating its format. |
| UploadedFileLength | Long | The length of the uploaded file in bytes. |
| UploadedFileName | String | The original name of the uploaded attachment file. |
| ContentRepositoryFileShared | Bool | Indicates whether the attachment is shared. 'True' means it is shared, while 'False' means it is not. Default is 'False.' |
| Title | String | The title of the attachment, which is typically used to describe the content of the document. |
| Description | String | A more detailed description of the attachment, explaining its purpose or contents. |
| ErrorStatusCode | String | An abbreviation identifying the error code associated with the attachment, if any. This helps diagnose issues related to the file. |
| ErrorStatusMessage | String | A message providing details about any errors that occurred during the upload or processing of the attachment. |
| CreatedBy | String | The user or system that created the attachment record for the supplier site. |
| CreationDate | Datetime | The date and time when the attachment record was created in the system. |
| FileContents | String | The contents of the attachment, typically used for smaller files stored as text. |
| ExpirationDate | Datetime | The date when the content in the attachment expires or is no longer valid. |
| LastUpdatedByUserName | String | The username of the user who last updated the attachment. |
| CreatedByUserName | String | The username of the user who created the attachment. |
| AsyncTrackerId | String | An identifier used to track the asynchronous processing of the uploaded file. |
| FileWebImage | String | An image or preview representation of the file, used for visual identification of the attachment. |
| DownloadInfo | String | A JSON object as a string, containing the necessary information to programmatically retrieve the file attachment. |
| PostProcessingAction | String | The name of the action that can be performed after the attachment is uploaded, such as 'Validate' or 'Archive.' |
| BilltoBuId | Long | The unique identifier for the business unit responsible for billing for the supplier site assignment. |
| BindPurchaseFlag | String | Indicates whether the supplier site attachment is bound to purchasing processes. A value of 'True' means the attachment is used for purchasing; 'False' means it is not. |
| BindReqBuId | Long | The unique identifier for the required business unit associated with the supplier site attachment. |
| BindSourcingOnlyFlag | String | Indicates whether the attachment is restricted to sourcing activities. A value of 'True' means the attachment is used solely for sourcing; 'False' means it can be used for other purposes. |
| BindSysdate | Date | The system date when the attachment was bound to the supplier site assignment. |
| Finder | String | A reference or search function used to locate or retrieve the supplier site attachment record in the system. |
| SupplierId | Long | The unique identifier for the supplier associated with the attachment on the supplier site. |
Enables custom descriptive flexfields at the supplier site level, supporting additional operational or region-specific data.
| Name | Type | Description |
| SuppliersSupplierId [KEY] | Long | The unique identifier for the supplier associated with the supplier site in the descriptive flexfield (DFF) context. |
| SitesSupplierSiteId [KEY] | Long | A unique identifier for the supplier site within the DFF context, used to track supplier site details in additional flexfields. |
| VendorSiteId [KEY] | Long | A value that uniquely identifies the supplier site, typically used to link the supplier site to a vendor in the procurement or finance systems. |
| _FLEX_Context | String | The context name for the DFF used for supplier sites, which defines the context in which additional attributes for the supplier site are stored. |
| _FLEX_Context_DisplayValue | String | The display value of the DFF context, providing a user-friendly name or label for the context associated with the supplier site. |
| BilltoBuId | Long | The unique identifier for the business unit responsible for billing for the supplier site. This field indicates which business unit is used for billing purposes in financial transactions. |
| BindPurchaseFlag | String | Indicates whether the supplier site is bound to purchasing activities. A value of 'True' means the site is used for purchasing; 'False' means it is not. Default value is 'False.' |
| BindReqBuId | Long | The unique identifier for the required business unit associated with the supplier site, which specifies the business unit that is required for processing. |
| BindSourcingOnlyFlag | String | Indicates whether the supplier site is restricted to sourcing activities. A value of 'True' means the site is sourcing-only; 'False' means other activities, such as purchasing or billing, are allowed. |
| BindSysdate | Date | The system date when the supplier site was bound to the specified activities or business unit. This date helps track the association of the site to various processes. |
| Finder | String | A reference or search function used to locate or retrieve the supplier site record in the system, typically used in querying or reporting. |
| SupplierId | Long | The unique identifier for the supplier associated with the supplier site, which links the site to a specific supplier in the system. |
Stores global descriptive flexfields for supplier sites, accommodating enterprise-wide requirements for site metadata.
| Name | Type | Description |
| SuppliersSupplierId [KEY] | Long | The unique identifier for the supplier associated with the supplier site in the global descriptive flexfield (DFF) context. |
| SitesSupplierSiteId [KEY] | Long | A unique identifier for the supplier site within the global DFF context. This ID is used to distinguish different supplier sites globally. |
| VendorSiteId [KEY] | Long | A unique value that identifies the supplier site in the global system. This ID is essential for linking the site to vendor-specific information across regions. |
| _FLEX_Context | String | The context name for the global DFF used for supplier sites. This defines the scope or context under which additional attributes for the supplier site are stored. |
| _FLEX_Context_DisplayValue | String | The display name or value of the global DFF context. This provides a user-friendly label for the context associated with the supplier site. |
| BilltoBuId | Long | The unique identifier for the business unit responsible for billing for the supplier site in a global context. It helps identify which business unit manages billing for the supplier site. |
| BindPurchaseFlag | String | Indicates whether the supplier site is bound to purchasing activities. 'True' means the supplier site is used for purchasing; 'False' means it is not. Default is 'False.' |
| BindReqBuId | Long | The unique identifier for the required business unit associated with the supplier site. This field specifies the business unit that is needed to process the supplier site. |
| BindSourcingOnlyFlag | String | Indicates whether the supplier site is restricted to sourcing activities only. 'True' means the site is sourcing-only; 'False' means other activities, such as purchasing or billing, are also supported. |
| BindSysdate | Date | The system date when the supplier site was bound to purchasing, sourcing, or other relevant business activities. |
| Finder | String | A reference or search function used to locate or retrieve the supplier site record in the system. This is useful for querying or reporting on supplier sites globally. |
| SupplierId | Long | The unique identifier for the supplier associated with the supplier site in the global system. This links the supplier site to a specific supplier. |
Manages third-party payment setups (for example, factoring relationships) for supplier sites, ensuring correct pay-to instructions.
| Name | Type | Description |
| SuppliersSupplierId [KEY] | Long | The unique identifier for the supplier associated with the third-party payment relationship for the supplier site. |
| SitesSupplierSiteId [KEY] | Long | A unique identifier for the supplier site associated with the third-party payment relationship. This helps link the payment relationship to the specific site. |
| TppRelationshipId [KEY] | Long | A value that uniquely identifies the third-party payment relationship for the supplier site. This ID is used to track the relationship between the supplier site and the third-party payer. |
| DefaultRelationshipFlag | Bool | Indicates whether the third-party payment relationship is the default for the supplier site. 'True' means it is the default, and 'False' means it is not. The default value is 'False.' |
| RemitToSupplier | String | The name of the party designated to receive payment on behalf of the supplier. This is the third-party payer, not the supplier themselves. |
| RemitToSupplierPartyId | Long | A unique identifier for the party designated to receive payment on behalf of the supplier. This party is identified through the SupplierPartyId attribute, not SupplierId. |
| RemitToAddress | String | The address of the party designated to receive payment on behalf of the supplier. This is the third-party payer's address. |
| RemitToAddressId | Long | A unique identifier for the address of the party designated to receive payment on behalf of the supplier. This helps link the address to the third-party payment relationship. |
| FromDate | Date | The date when the third-party payment relationship becomes effective, marking the start of the payment arrangement. |
| ToDate | Date | The date when the third-party payment relationship expires or is no longer effective. |
| Description | String | Detailed information about the third-party payment relationship, typically included in the payment file to specify terms or other relevant details. |
| CreationDate | Datetime | The date and time when the third-party payment relationship record was created in the system. |
| CreatedBy | String | The user or system that created the third-party payment relationship record. |
| LastUpdateDate | Datetime | The timestamp of the most recent update to the third-party payment relationship record. |
| LastUpdatedBy | String | The user or system that made the last update to the third-party payment relationship record. |
| BilltoBuId | Long | The unique identifier for the business unit responsible for billing in the third-party payment relationship. |
| BindPurchaseFlag | String | Indicates whether the third-party payment relationship is bound to purchasing activities. 'True' means it is bound to purchasing; 'False' means it is not. |
| BindReqBuId | Long | The unique identifier for the business unit that is required to process the third-party payment relationship. |
| BindSourcingOnlyFlag | String | Indicates whether the third-party payment relationship is restricted to sourcing activities only. 'True' means sourcing-only; 'False' means other activities are permitted. |
| BindSysdate | Date | The system date when the third-party payment relationship was bound to purchasing, sourcing, or other activities. |
| Finder | String | A reference or search function used to locate or retrieve the third-party payment relationship record in the system. |
| SupplierId | Long | The unique identifier for the supplier associated with the third-party payment relationship. This links the payment relationship to the supplier. |
Stores definitions for standardized lookups or data validation sets, ensuring consistent entries across the procurement module.
| Name | Type | Description |
| ValueSetId [KEY] | Long | The unique identifier of the value set. This ID is used to uniquely reference the value set within the system. |
| ModuleId | String | The module ID associated with the value set. It helps identify which module the value set belongs to (for example, 'Financials', 'Purchasing'). |
| ValueSetCode | String | The code used to identify the value set. This code is used for referencing the value set within the system, ensuring uniqueness and easy identification. |
| Description | String | A description of the value set, explaining its purpose and what values it holds, providing context for its usage. |
| ValidationType | String | The type of validation applied to the values within the value set. Examples could include 'Format' or 'Range,' and it ensures that only valid data can be entered. |
| ValueDataType | String | The data type of the values in the value set. It specifies what type of data is allowed, such as 'String,' 'Integer,' or 'Decimal'. |
| ValueSubtype | String | The subtype of the value set, which provides further categorization. It could be something like 'Account Types' or 'Product Codes,' helping to define its role more specifically. |
| ProtectedFlag | String | Indicates whether the value set is protected against updates. A 'Yes' value means that no changes can be made to the value set once it is created. |
| MaximumLength | Int | The maximum length of a value that can be stored in the value set. This ensures that values do not exceed predefined limits, like a maximum of 255 characters. |
| Precision | Int | The maximum number of digits that can be used for a value in the value set, ensuring consistency in numeric values. |
| Scale | Int | The maximum number of digits that can appear to the right of the decimal point for values in the value set. This ensures proper formatting for decimal values. |
| UppercaseOnlyFlag | String | Indicates whether the values in the set must be entered in uppercase only. A 'Yes' value restricts the value entry to uppercase letters. |
| ZeroFillFlag | String | Indicates whether values must be left-padded with zeros. For example, if set to 'Yes,' a value like '5' would be represented as '0005'. |
| SecurityEnabledFlag | String | Indicates if data security is enabled for the value set. A 'Yes' value means that access to the value set is restricted based on security policies. |
| DataSecurityObjectName | String | The name of the data security object used to secure the value set, if applicable. This can be linked to specific security protocols or roles. |
| MinimumValue | String | The minimum permitted value that can be entered for the value set. It defines the lower bound for valid values. |
| MinimumValueNumber | Decimal | The minimum numeric value allowed for this value set. This is used for value sets that store numerical data, ensuring they stay within limits. |
| MinimumValueDate | Date | The minimum allowed date for the value set. This ensures that only dates equal to or greater than this value can be entered. |
| MinimumValueTimestamp | Datetime | The minimum allowed timestamp for the value set, specifying the earliest valid date and time for entries. |
| MaximumValue | String | The maximum permitted value that can be entered for the value set. It defines the upper bound for valid values. |
| MaximumValueNumber | Decimal | The maximum numeric value allowed for the value set, defining the upper bound for numbers stored in this value set. |
| MaximumValueDate | Date | The maximum allowed date for the value set. This ensures that only dates equal to or less than this value can be entered. |
| MaximumValueTimestamp | Datetime | The maximum allowed timestamp for the value set, specifying the latest valid date and time for entries. |
| IndependentValueSetId | Long | The ID of the independent value set, if applicable. This is used when the value set is dependent on another value set for validation or categorization. |
| IndependentValueSetCode | String | The code of the independent value set, if applicable. This code helps identify and link dependent value sets to their parent value sets. |
| CreationDate | Datetime | The date when the value set record was created. This helps track the history and lifecycle of the value set. |
| CreatedBy | String | The user who created the value set record. This provides traceability and accountability for the creation of the value set. |
| LastUpdateDate | Datetime | The date when the value set record was last updated. This helps track changes and updates to the value set over time. |
| LastUpdatedBy | String | The user who last updated the value set record. This provides accountability and traceability for changes made to the record. |
| Finder | String | A text field used for searching or filtering the value set records. This can be used for quick lookups and references when managing value sets. |
Indicates the base table used for validation, defining the permissible values for procurement data fields.
| Name | Type | Description |
| ValueSetsValueSetId [KEY] | Long | The unique identifier of the value set. This ID links the validation table to a specific value set, ensuring that the validation rules apply to the correct set of values. |
| ValueSetId [KEY] | Long | The unique identifier of the validation table. This ID links the validation table to a specific data table used for validating the values in the value set. |
| FromClause | String | The FROM clause used in the validation query. This clause specifies the source table(s) from which the validation data will be retrieved, enabling proper validation of value set entries. |
| WhereClause | String | The WHERE clause used in the validation query. It defines the conditions that must be met for a value to be considered valid within the value set, filtering the data accordingly. |
| OrderByClause | String | The ORDER BY clause used in the validation query, if any. It specifies the sorting order for the results of the validation query, ensuring consistent and predictable results. |
| ValueColumnName | String | The name of the value column in the validation table. This column stores the actual values that will be validated and used within the value set. |
| ValueColumnLength | Int | The length of the value column, specifying the maximum number of characters or digits that the values in this column can hold. |
| ValueColumnType | String | The data type of the value column, indicating whether the column stores strings, numbers, dates, or other types of data. |
| IdColumnName | String | The name of the ID column, if any, in the validation table. This column holds a unique identifier for each row, often used for referencing specific entries in the table. |
| IdColumnLength | Int | The length of the ID column, specifying the maximum number of characters or digits that the ID values can hold. |
| IdColumnType | String | The data type of the ID column, indicating whether the column stores integer, string, or other types of identifiers. |
| DescriptionColumnName | String | The name of the description column, if any, in the validation table. This column contains a textual description of the value stored in the value column, providing additional context. |
| DescriptionColumnLength | Int | The length of the description column, specifying the maximum number of characters or digits that the descriptions in this column can hold. |
| DescriptionColumnType | String | The data type of the description column, indicating whether the column stores strings, numbers, or other types of data used to describe the value. |
| EnabledFlagColumnName | String | The name of the enabled check box column, if any, in the validation table. This column determines whether a particular value is enabled for use in the value set. |
| StartDateColumnName | String | The start date column name, if any, in the validation table. This column indicates when a particular value or record becomes valid and eligible for use in the value set. |
| EndDateColumnName | String | The name of the end date column, if any, in the validation table. This column specifies when a particular value or record expires or is no longer valid. |
| ValueAttributesTableAlias | String | The alias of the table containing the value attribute columns, if any. This alias helps simplify referencing the value-related columns within the validation query. |
| CreationDate | Datetime | The date when the validation record was created. This timestamp is used to track the creation of the record for auditing and historical purposes. |
| CreatedBy | String | The user who created the validation record. This field helps trace the origin of the record and provides accountability for its creation. |
| LastUpdateDate | Datetime | The date when the validation record was last updated. This timestamp is important for tracking changes and ensuring the data is up-to-date. |
| LastUpdatedBy | String | The user who last updated the validation record. This provides traceability for any modifications made to the record over time. |
| Finder | String | A text field used for searching or filtering the validation records. This can help quickly locate relevant records within large datasets or when managing multiple validation rules. |
| ValueSetCode | String | The code that identifies the value set associated with this validation table. This code is used to reference the specific value set and its validation rules. |
Enumerates allowed values in a value set (codes, translations), ensuring data consistency in user inputs.
| Name | Type | Description |
| ValueSetsValueSetId [KEY] | Long | The unique identifier of the value set. This ID links the value entry to the specific value set it belongs to, ensuring proper categorization and validation within the system. |
| ValueId [KEY] | Long | The unique identifier of the value. This ID is used to uniquely reference each value in the value set, distinguishing one value from another. |
| IndependentValue | String | The independent value, representing a standalone value that is not dependent on any other data. This field holds textual data for simple entries. |
| IndependentValueNumber | Decimal | The independent number value, used when the independent value is numeric. This allows numeric validation and comparisons. |
| IndependentValueDate | Date | The independent date value, used when the independent value represents a specific date. This ensures proper date validation for entries. |
| IndependentValueTimestamp | Datetime | The independent time stamp value, which stores both the date and time as a timestamp, useful for time-based validation and record tracking. |
| Value | String | The actual value to be used in the value set. This is the primary field that contains the data entries for the value set, typically referenced during data validation. |
| ValueNumber | Decimal | The numeric value representing the value, used when the value is stored as a number. This allows for numeric operations such as addition or comparison. |
| ValueDate | Date | The date value representing the value, allowing for date-based validation and comparison. |
| ValueTimestamp | Datetime | The time stamp value representing both date and time, ensuring precise records for time-based data. |
| TranslatedValue | String | The translated value, representing the value in a different language or format. This field allows the system to store multilingual entries for the same value. |
| Description | String | A description of the value, providing context and additional details about the meaning or purpose of the value stored in the value set. |
| EnabledFlag | String | Indicates if the value is enabled. A value of 'Yes' means the value is active and can be used; 'No' means it is disabled and cannot be used in the system. |
| StartDateActive | Date | The first date on which the value is active. This defines the start of the validity period for the value, ensuring the value is only used when appropriate. |
| EndDateActive | Date | The last date on which the value is active. This defines the end of the validity period for the value, ensuring the value cannot be used after the specified date. |
| SortOrder | Long | The order in which the values should appear in the list of values. This helps control the display order of values, allowing a specific arrangement of items in user interfaces. |
| SummaryFlag | String | A summary of the value, providing a brief description or categorization of the value. This field can be used to highlight key characteristics of the value. |
| DetailPostingAllowed | String | Indicates if posting is permitted for the value. A value of 'Yes' means that financial transactions can be posted using this value, while 'No' means posting is not allowed. |
| DetailBudgetingAllowed | String | Indicates if budget entry is permitted for the value. A 'Yes' value means that the value can be used in budgeting, while 'No' indicates it is excluded from budget entries. |
| AccountType | String | The account type of the value. This helps categorize the value based on the type of financial account it is associated with (for example, asset, liability, expense). |
| ControlAccount | String | The control account of the value. This indicates the account used to manage and reconcile the balance of the value within the accounting system. |
| ReconciliationFlag | String | The reconciliation indicator of the value. A 'Yes' value means the value must be reconciled during the financial period, while 'No' means it is not subject to reconciliation. |
| FinancialCategory | String | The financial category of the value. This categorizes the value based on its role in financial reporting or accounting, such as 'Revenue,' 'Expense,' or 'Asset.' |
| ExternalDataSource | String | The location of the external data source, if the value is maintained externally. This is useful for linking external systems that update or manage the value. |
| CreationDate | Datetime | The date when the value record was created. This timestamp helps track when the value was first introduced into the system. |
| CreatedBy | String | The user who created the value record. This field helps maintain accountability and traceability for who added or modified the value. |
| LastUpdateDate | Datetime | The date when the value record was last updated. This helps track changes made to the value over time, ensuring up-to-date data. |
| LastUpdatedBy | String | The user who last updated the value record. This field helps maintain accountability and traceability for who made changes to the value. |
| Finder | String | A text field used for searching or filtering the value records. This field can help locate specific records based on keywords or attributes associated with the value. |
| ValueSetCode | String | The code that identifies the value set associated with this value. This code is used to reference the value set and its values in the system, ensuring proper validation and usage. |
| ValueSetId | Long | The unique identifier of the value set. This ID links the value entry to its specific value set, helping to organize and manage related values. |
Handles confirmations of completed work for complex service or construction purchase orders, aiding accurate billing and progress tracking.
| Name | Type | Description |
| WorkConfirmationId [KEY] | Long | The unique identifier of the work confirmation. This ID is used to track individual work confirmation records within the system. |
| WorkConfirmationNumber | String | The work confirmation number assigned to the work confirmation record. This is typically a reference number for the confirmation in the procurement or work process. |
| POHeaderId | Long | The unique identifier for the purchase order header associated with the work confirmation. This ID helps link the work confirmation to a specific purchase order. |
| OrderNumber | String | The order number related to the work confirmation. This number corresponds to the purchase order and helps track the order through the system. |
| SoldToLegalEntityId | Long | The unique identifier of the legal entity that is the buyer or recipient in the transaction. This ID ensures proper identification of the party responsible for receiving the work. |
| SoldToLegalEntity | String | The name of the legal entity that the work confirmation pertains to. This entity is typically the buyer in the transaction. |
| PeriodStartDate | Date | The start date of the period covered by the work confirmation. This defines the beginning of the reporting period for the work being confirmed. |
| PeriodEndDate | Date | The end date of the period covered by the work confirmation. This defines the conclusion of the reporting period for the work being confirmed. |
| WorkConfirmationRequestDate | Datetime | The date and time when the work confirmation was requested. This timestamp helps track when the work confirmation was initiated. |
| Comments | String | Any comments or additional notes related to the work confirmation. This field is used for providing context or specific details about the work being confirmed. |
| StatusCode | String | The status code of the work confirmation. This code reflects the current state of the work confirmation within the system, such as 'Pending' or 'Approved'. |
| Status | String | The descriptive status of the work confirmation. This provides a human-readable explanation of the status code, helping users understand the work confirmation's current state. |
| WorkConfirmationSequenceNumber | Long | The sequence number assigned to the work confirmation. This number helps differentiate multiple confirmations related to the same work or purchase order. |
| CreationDate | Datetime | The date and time when the work confirmation record was created. This timestamp tracks when the work confirmation was first entered into the system. |
| CreatedBy | String | The user who created the work confirmation record. This field helps trace the origin of the work confirmation for accountability and auditing purposes. |
| LastUpdateDate | Datetime | The date and time when the work confirmation record was last updated. This helps track changes and ensure the data is current. |
| LastUpdatedBy | String | The user who last updated the work confirmation record. This field provides accountability for any modifications made to the record. |
| PODescription | String | The description of the purchase order associated with the work confirmation. This description provides more context about the goods or services being confirmed. |
| SupplierId | Long | The unique identifier of the supplier related to the work confirmation. This ID links the work confirmation to a specific supplier. |
| Supplier | String | The name of the supplier associated with the work confirmation. This helps identify the supplier responsible for the goods or services being confirmed. |
| SupplierSiteId | Long | The unique identifier of the supplier site associated with the work confirmation. This ID identifies the specific location or entity of the supplier providing the goods or services. |
| SupplierSite | String | The name of the supplier site. This helps distinguish between different locations or sites of the same supplier. |
| CurrencyCode | String | The currency code associated with the work confirmation. This code indicates the currency used for amounts in the work confirmation (for example, USD, EUR). |
| Currency | String | The name of the currency used in the work confirmation (for example, 'US Dollar', 'Euro'). This provides more context than the currency code. |
| ImportSource | String | The source from which the work confirmation was imported, if applicable. This helps trace the origin of the data and whether it was manually entered or imported from an external system. |
| PreviouslyApprovedAmount | Decimal | The previously approved amount in the work confirmation. This field tracks the amount that was approved before the current work confirmation. |
| ContractAmountToDate | Decimal | The total contract amount to date. This represents the cumulative total of all approved amounts up to the current date. |
| TotalCompletedThisPeriod | Decimal | The total amount of work completed during the current period covered by the work confirmation. |
| TotalCompletedToDate | Decimal | The total amount of work completed up to the current date. This is a cumulative total of work completed across all periods. |
| ProjectedRetainageThisPeriod | Decimal | The projected retainage (withheld amount) for the current period. This is the portion of the payment that is withheld until the work is fully completed or confirmed. |
| CurrentPaymentDue | Decimal | The amount of payment due in the current period, based on the work completed and the terms of the work confirmation. |
| BalanceToFinish | Decimal | The remaining balance to be paid once the work is completed. This field tracks how much is still owed for the completion of the work. |
| BuyerId | Long | The unique identifier of the buyer associated with the work confirmation. This ID links the work confirmation to the specific buyer handling the purchase. |
| Buyer | String | The name of the buyer associated with the work confirmation. This is typically the person or department responsible for purchasing the goods or services. |
| Finder | String | A text field used for searching or filtering work confirmation records. This helps quickly locate relevant records based on specific criteria or keywords. |
| Intent | String | The intent of the work confirmation. This field may capture whether the confirmation is for a specific purpose, such as partial or final completion. |
| SysEffectiveDate | String | The system effective date, used as a query parameter to fetch records effective as of the specified date. This helps retrieve data based on its effectiveness at a particular time. |
| EffectiveDate | Date | This query parameter is used to fetch resources that are effective as of the specified start date. It helps ensure that data retrieved matches the timeframe of interest. |
Associates files (for example, progress photos, sign-off sheets) with a work confirmation, substantiating the claimed progress or deliverables.
| Name | Type | Description |
| WorkConfirmationsWorkConfirmationId [KEY] | Long | The unique identifier for the work confirmation associated with this attachment. It links the attachment to a specific work confirmation record. |
| AttachedDocumentId [KEY] | Long | The unique identifier of the document attached to the work confirmation. This ID helps associate the attachment with its corresponding document in the system. |
| LastUpdateDate | Datetime | The date and time when the record was last updated. This timestamp is important for tracking when the attachment record was last modified. |
| LastUpdatedBy | String | The user who last updated the attachment record. This provides accountability and helps trace any changes made to the attachment. |
| DatatypeCode | String | A value that indicates the data type of the attachment. This code specifies the type of data stored within the attachment, such as 'image', 'PDF', or 'text'. |
| FileName | String | The name of the attachment file. This is used to identify the file in the system and helps with file management and retrieval. |
| DmFolderPath | String | The folder path from which the attachment was created. This specifies the location of the document management folder that contains the attachment. |
| DmDocumentId | String | The document ID associated with the attachment. This helps identify the specific document in the document management system from which the attachment was created. |
| DmVersionNumber | String | The version number of the document associated with the attachment. This ensures that the correct version of the document is linked to the attachment. |
| Url | String | The URL for the attachment, especially for web-based attachments. This URL points to the online location where the attachment can be accessed or viewed. |
| CategoryName | String | The category of the attachment. This helps organize and classify attachments into different types, such as 'Invoice', 'Contract', or 'Report'. |
| UserName | String | The login credentials of the user who created the attachment. This attribute helps identify the user responsible for uploading the file. |
| Uri | String | The URI (Uniform Resource Identifier) of the attachment, especially for Topology Manager-type attachments. This provides a reference to the location of the attachment. |
| FileUrl | String | The URL or path that directly points to the attachment file. This is used for file retrieval and access. |
| UploadedText | String | The text content for a new text attachment. This is used when the attachment is a text-based document and allows users to upload textual data directly. |
| UploadedFileContentType | String | The content type of the uploaded file, indicating its format. |
| UploadedFileLength | Long | The size of the attachment file, measured in bytes. This helps determine the storage space required for the attachment. |
| UploadedFileName | String | The name given to the uploaded attachment file. This helps in file management and ensuring the file is named appropriately for its content. |
| ContentRepositoryFileShared | Bool | Indicates whether the attachment is shared across multiple users or systems. If true, the file is shared; otherwise, it is private. |
| Title | String | The title of the attachment. This provides a brief, descriptive name for the attachment that helps users understand its content. |
| Description | String | A more detailed description of the attachment. This field helps provide context and additional information about the attachment's purpose or contents. |
| ErrorStatusCode | String | The error code, if any, associated with the attachment. This code helps identify any issues that occurred during the upload or processing of the attachment. |
| ErrorStatusMessage | String | The error message, if any, related to the attachment. This provides a human-readable explanation of the error encountered during processing. |
| CreatedBy | String | The user who created the attachment record. This field helps track the origin of the record and provides accountability. |
| CreationDate | Datetime | The date and time when the attachment record was created. This helps track when the file was initially uploaded into the system. |
| FileContents | String | The contents of the attachment, typically used for text or encoded file data. This field stores the actual content of the attachment. |
| ExpirationDate | Datetime | The expiration date of the attachment's contents. This indicates when the attachment's data will no longer be valid or accessible. |
| LastUpdatedByUserName | String | The user name of the person who last updated the record. This attribute helps with accountability and audit tracking. |
| CreatedByUserName | String | The user name of the person who created the attachment record. This helps with tracking who initiated the attachment process. |
| AsyncTrackerId | String | An identifier used by the Attachment UI components for tracking the asynchronous upload process. This helps monitor file uploads. |
| FileWebImage | String | The Base64 encoded image of the attachment, displayed as a .png format if the source file is convertible to an image. |
| DownloadInfo | String | A JSON-formatted string containing necessary information to programmatically retrieve large file attachments. This helps manage file downloads. |
| PostProcessingAction | String | The name of the action to be performed after the attachment is uploaded, such as 'validate', 'archive', or 'approve'. |
| Finder | String | A general-purpose search or filter attribute for locating specific work confirmation attachments in the system. |
| Intent | String | The intent or purpose of the attachment, which helps categorize or clarify its use in the work confirmation process. |
| SysEffectiveDate | String | The system effective date, used to fetch records that are effective as of a specified date. This helps retrieve attachments based on their validity date. |
| WorkConfirmationId | Long | The unique identifier of the work confirmation. This ID links the attachment to a specific work confirmation record. |
| EffectiveDate | Date | The date used for querying attachments that are effective as of the specified start date. This ensures data is retrieved according to its valid time range. |
Reflects the actions (approve, reject, revise) taken on a work confirmation document, ensuring an audit trail of changes.
| Name | Type | Description |
| WorkConfirmationsWorkConfirmationId [KEY] | Long | The unique identifier of the work confirmation. This ID is used to link document actions to a specific work confirmation record in the system. |
| ObjectId [KEY] | Long | The unique identifier for the object associated with the document action. This helps relate the action to the specific object being acted upon. |
| ActionCode [KEY] | String | A code that identifies the type of action performed on the work confirmation document. This is typically a predefined code, such as 'APPROVE' or 'REJECT'. |
| Action | String | A description of the action performed. This provides a human-readable explanation of what was done to the work confirmation document. |
| PerformerId | Long | The unique identifier of the performer who carried out the document action. This links the action to the user or system that performed it. |
| PerformedByUserName | String | The username of the individual who performed the action. This provides accountability and helps trace which user took the action. |
| ActionDate | Datetime | The date and time when the action was performed. This timestamp is crucial for tracking the timeline of document actions. |
| Note | String | Additional notes or comments related to the action performed. This field provides extra context or explanations about why the action was taken. |
| SequenceNumber [KEY] | Long | A unique number assigned to each action in a sequence. This helps order the actions chronologically and ensures each action is distinct. |
| LastUpdateDate | Datetime | The date and time when the record was last updated. This helps track the most recent changes to the document action record. |
| LastUpdatedBy | String | The username of the person who last updated the document action record. This helps with tracking modifications and maintaining accountability. |
| CreationDate | Datetime | The date and time when the document action record was created. This timestamp is used to track when the action was first logged in the system. |
| CreatedBy | String | The username of the individual who created the document action record. This helps identify the originator of the action. |
| Finder | String | A general-purpose search or filter field used to locate specific document actions in the system. It can be used to narrow down results based on keywords or parameters. |
| Intent | String | The intent behind performing the document action. This field clarifies the purpose or reason for taking the action, such as 'approval' or 'review'. |
| SysEffectiveDate | String | The system effective date used to filter resources that are effective as of the specified start date. This ensures actions are considered within their effective time range. |
| WorkConfirmationId | Long | The unique identifier of the work confirmation. This field links the document action to the specific work confirmation it is associated with. |
| EffectiveDate | Date | The date used to fetch resources that are effective as of the specified start date. It ensures that actions performed on documents are within the correct date range for the query. |
Details line-level entries for a work confirmation, tracking the portions of work completed or amounts to be billed.
| Name | Type | Description |
| WorkConfirmationsWorkConfirmationId [KEY] | Long | The unique identifier of the work confirmation. This ID links each line item to its respective work confirmation document. |
| WorkConfirmationLineId [KEY] | Long | The unique identifier of the specific work confirmation line. This ID allows for tracking and managing individual line items within the work confirmation. |
| WorkConfirmationId | Long | The unique identifier of the work confirmation document to which this line belongs. This establishes the relationship between the work confirmation and its associated lines. |
| POLineLocationId | Long | The unique identifier for the purchase order schedule related to this work confirmation line. It links the line to a specific location within the purchase order. |
| Amount | Decimal | The amount of work completed for this line on a progress payment schedule. It reflects the value of work done for the period or performance milestone. |
| Quantity | Decimal | The quantity of work completed for the line within the progress payment schedule. This helps to track the physical units of work completed. |
| TotalProgressPercent | Decimal | The percentage of work completed for the line as part of the overall progress payment schedule. This percentage is used for tracking completion levels. |
| POLineId | Long | The unique identifier of the purchase order line to which this work confirmation line corresponds. It links the confirmation line back to the purchase order. |
| POScheduleNumber | Decimal | The number assigned to the purchase order schedule for this line. It helps to identify the specific schedule in which the work confirmation applies. |
| WorkConfirmationNumber | String | The number of the work confirmation associated with this line. It is used to identify and reference the specific work confirmation document. |
| POLineNumber | Decimal | The number of the purchase order line that corresponds to this work confirmation line. This number is used to differentiate between multiple lines within the same purchase order. |
| CreationDate | Datetime | The date and time when the work confirmation line was created. This timestamp helps track when the line item was first logged in the system. |
| CreatedBy | String | The user who created the work confirmation line record. This helps identify the individual responsible for entering the line item into the system. |
| LastUpdateDate | Datetime | The date and time when the work confirmation line was last updated. It is important for tracking modifications and ensuring data is current. |
| LastUpdatedBy | String | The user who last updated the work confirmation line record. This helps in identifying the individual who made the most recent changes. |
| POScheduleDescription | String | A description of the purchase order schedule that this work confirmation line is tied to. This provides context about the schedule and its details. |
| UOMCode | String | The unit of measure code used for this work confirmation line. It is a shorthand notation for the unit in which the work or quantity is measured. |
| UOM | String | The full description of the unit of measure for the work confirmation line. It provides more detailed information about how the work is quantified (for example, 'Hours', 'Units'). |
| ScheduleTypeCode | String | The code that identifies the type of schedule for this work confirmation line. This helps classify the schedule (for example, 'Fixed', 'Variable'). |
| ScheduleType | String | The description of the schedule type for the work confirmation line. This provides further context about how the schedule is structured. |
| PreviouslyApprovedAmount | Decimal | The amount of work that was previously approved on this line. This helps to track the total approved amount for progress payments. |
| ProjectedRetainageThisPeriod | Decimal | The amount of retainage projected for this period. Retainage is the portion of the payment withheld until the work is completed or accepted. |
| ScheduledValue | Decimal | The scheduled value for this work confirmation line, which reflects the agreed-upon value for the work to be completed during the period. |
| TotalProjectedRetainageToDate | Decimal | The cumulative retainage amount projected to date. It includes all retainage amounts withheld across all periods up to the current date. |
| TotalCompleted | Decimal | The total amount of work completed for this line to date. This reflects the overall completion progress for the work item. |
| BalanceToFinish | Decimal | The balance of work yet to be completed for the line. This helps to track the remaining work for the project. |
| Price | Decimal | The price of the work item as it appears in the work confirmation line. This value is used for financial tracking and calculations of total cost. |
| MaximumRetainageAmount | Decimal | The maximum allowable retainage amount for this work confirmation line. It helps ensure that the retainage does not exceed contractual limits. |
| RetainageRate | Decimal | The percentage of retainage to be withheld for this work confirmation line. It is used to calculate the total amount of retainage for the work performed. |
| ScheduledQuantity | Decimal | The quantity of work that is scheduled to be completed for this line. This is used for tracking planned work versus actual work completed. |
| Finder | String | A general-purpose field for searching and filtering records in the system. It helps identify specific work confirmation lines based on user-defined criteria. |
| Intent | String | The purpose or intent behind creating or updating the work confirmation line. It provides context for the action being taken. |
| SysEffectiveDate | String | The effective date parameter used in system queries to filter resources based on their effective date range. This ensures the system retrieves the correct data for the specified period. |
| EffectiveDate | Date | The date used to fetch resources that are effective as of the specified start date. It ensures that actions are considered within their effective time range. |
This section shows the available API objects and provides more information on executing SQL to Oracle Fusion Cloud Financials APIs.
Stored Procedures are function-like interfaces to Oracle Fusion Cloud Financials. They can be used to modify information in Oracle Fusion Cloud Financials.
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| AwardBudgetPeriodsLOV | The Award Budget Period resource is used to view attributes such as budget period name, start date, and end date. |
| AwardBudgets | The Award Budgets resource is used to view an award budget. |
| AwardBudgetsAttachments | The Attachment resource is used to view attachments for award budgets. |
| AwardBudgetsPlanningOptions | The Planning Options resource is used to view the planning options configured for the award budget version. Planning options are user-definable options, including plan settings, rate settings, currency settings, and generation options that are used to control planning scenarios. Award budget versions inherit planning options that are defined for financial plan types. |
| AwardBudgetsPlanningOptionsPlanningOptionsDFF | A listing of all the descriptive flexfields available for planning options in award budget versions. |
| AwardBudgetsPlanningResources | The Planning resources is used to view an award budget line. |
| AwardBudgetsPlanningResourcesPlanningAmounts | The Planning Amounts resource is used to viewn award budget line amounts. |
| AwardBudgetsPlanningResourcesPlanningAmountsPlanLinesDFF | The Plan Lines Descriptive Flexfields resource is used to capture, view, and update additional information for planning amounts in award budgets. |
| AwardBudgetsPlanningResourcesPlanningAmountsPlanningAmountDetails | The Planning Amount Details resource is used to view an award budget line periodic amounts. |
| AwardBudgetSummary | The Award Budget Summary resource is used to view an award budget. |
| AwardBudgetSummaryResources | The Resources resource is used to view the resources in the planning resource breakdown structure that are included in the award budget. |
| AwardBudgetSummaryResourcesBudgetLines | The Budget Lines resource is used to view the budget lines for a resource. |
| AwardBudgetSummaryResourcesBudgetLinesPlanningAmountDetails | The Planning Amount Details resource is used to view periodic amounts for a budget line. |
| AwardBudgetSummaryTasks | The Tasks resource is used to view an award budget version task. |
| AwardBudgetSummaryTasksBudgetLines | The Budget Lines resource is used to view the budget lines for a task. |
| AwardBudgetSummaryTasksBudgetLinesPlanningAmountDetails | The Planning Amount Details resource is used to view periodic amounts for a budget line. |
| AwardBudgetSummaryVersionErrors | The Version Errors resource is used to view award budget version errors. |
| AwardBudgetsVersionErrors | The Version Errors resource is used to view award budget version and award budget line errors. |
| AwardFundingSourcesLOV | The Award Funding Source resource is used to create or update a funding source for the award. |
| AwardProjectFundingSourcesLOV | The Award Project Funding Sources LOV resource is used to view an award project funding source. The service data object contains a list of funding sources with details such as funding source name and number. |
| AwardProjects | The Award Projects resource is used to view award project attributes such as project name and project number. |
| Awards | The Awards resource is used to view awards. |
| AwardsAttachment | The Award Attachments resource is used to view attachments associated with the award. |
| AwardsAwardBudgetPeriod | The Award Budget Periods resource is used to view award budget period attributes such as budget period name, start date and end date. |
| AwardsAwardCertification | The Award Certifications resource is used to view the certification attributes of the award. |
| AwardsAwardCFDA | The Award CFDAs resource is used to view the attributes specific to award federal domestic assistance program. |
| AwardsAwardDepartmentCredit | The Award Department Credits resource is used to view the organization credit attributes for the award. |
| AwardsAwardError | The Award Errors resource is used to view validation errors associated with the award. |
| AwardsAwardFunding | The Award Fundings resource is used to view award funding attributes such as funding issue type and funding issue name. |
| AwardsAwardFundingAwardProjectFunding | The Award Project Fundings resource is used to view funding allocation attributes for the award project. |
| AwardsAwardFundingSource | The Award Funding Sources resource is used to view the attributes used to create or update a funding source for the award. |
| AwardsAwardHeaderDFF | A list of all the descriptive flexfields available for awards. |
| AwardsAwardKeyword | The Award Keywords resource is used to view the keyword attributes for the award. |
| AwardsAwardPersonnel | The Award Personnel resource is used to view the award personnel attributes such as person name, role. |
| AwardsAwardPersonnelAwardPersonnelDFF | A list of all the descriptive flexfields available for award personnel. |
| AwardsAwardProject | The Award Projects resource is used to view the attributes of an award project, such as project name and project number. |
| AwardsAwardProjectAwardProjectAttachment | The Award Project Attachments resource is used to view attachments associated with the award project. |
| AwardsAwardProjectAwardProjectCertification | The Award Project Certifications resource is used to view certification attributes of the award project. |
| AwardsAwardProjectAwardProjectDepartmentCredit | The Award Project Organization Credits resource is used to view organization credit attributes for the award project. |
| AwardsAwardProjectAwardProjectDFF | A list of all the descriptive flexfields available for award projects. |
| AwardsAwardProjectAwardProjectFundingSource | The Award Project Funding Sources resource is used to view funding sources of the award project. |
| AwardsAwardProjectAwardProjectKeyword | The Award Project Keywords resource is used to view keyword attributes for the award project. |
| AwardsAwardProjectAwardProjectOverrideBurdenSchedules | The Award Project Override Burden Schedules resource is used to view the override burden schedule assigned to the award project. |
| AwardsAwardProjectAwardProjectOverrideBurdenSchedulesVersions | The Versions resource is used to view versions for the override burden schedule assigned to the award project. |
| AwardsAwardProjectAwardProjectPersonnel | The Award Project Personnel resource is used to view personnel references associated with the award project |
| AwardsAwardProjectAwardProjectPersonnelAwardProjectPersonnelDFF | A list of all the descriptive flexfields available for award project personnel. |
| AwardsAwardProjectAwardProjectReference | The Award Project Reference Types resource is used to view attributes associated with the award project reference type. |
| AwardsAwardProjectAwardProjectTaskBurdenSchedule | The Award Project Task Burden Schedules resource is used to view the task burden schedule of the award project. |
| AwardsAwardReference | The Award References resource is used to view the attributes specific to award reference type. |
| AwardsAwardTerms | The Award Terms and Conditions resource is used to view the attributes of the terms and conditions associated to the award. |
| AwardsByProjectsLOV | The Awards By Projects LOV resource is used to view the awards for a particular project. This service data object contains a list of awards with details such as award id, award name, and award number. |
| AwardTemplatesLOV | The Award Templates LOV resource is used to view all or a filtered set of award templates. This object includes attributes which are used to display one or more attributes of one or many award templates. |
| BurdenSchedulesLOV | The LOV for Burden Schedules resource is used to view a list of values of burden schedules. This object includes attributes which are used to store values of a burden schedule. |
| ChangeOrders | The Change Order resource is used to create, view, update, or delete a change order. A change order is an event, action, or condition that affects the scope, value, or duration of a project or task. |
| ChangeOrdersChangeImpacts | The Change Impacts resource is used to create, view, update, or delete the impacts due to the respective change order. |
| ChangeOrdersChangeImpactsChangeImpactDetails | The Change Impact Details resource is used to view the impact details for a change order. |
| ChangeOrdersChangeParticipants | The Change Participants resource is used to view the participants for a change order. |
| ContractProjectandTaskBillRateOverrides | The Contract Project and Task Bill Rate Overrides resource is used to view project task rate overrides defined at the contract bill plan or revenue plan level. |
| DeliverableTypesLOV | The LOV for Deliverable and Work Item Types resource is used to list deliverable and work item type values. The deliverable type provides a way to classify the output that must be produced to complete a requirement, project, or task. Examples include functional design documents, test plans, or physical objects. Work items originate in Oracle Innovation Management, Oracle Product Development, and Oracle Sourcing. |
| EnterpriseProjectAndTaskCodes | The Enterprise Project and Task Codes resource is used to view the definitions of the enterprise project and task codes. Project codes are used to capture organization-specific extended attributes for projects. Similarly, task codes are used to capture organization-specific extended attributes for tasks. |
| EnterpriseProjectAndTaskCodesAcceptedValues | List of accepted values for an enterprise project code or task code. |
| EventTypesLOV | The Project Billing Event Types LOV resource is used to view a project billing event type. This object includes attributes which are used to store values of a project billing event type. |
| ExpenditureTypes | The project expenditure type resource is used to list expenditure types. An expenditure type is classifications of cost that is associated an expenditure item. Expenditure types are grouped into cost groups and revenue groups. |
| ExpenditureTypesLOV | The Expenditure Types LOV resource is used to view an expenditure type. This object includes attributes which are used to store values of an expenditure type. |
| ExpenditureTypesLOVExpenditureTypeClassesLOV | The Expenditure Type Classes LOV resource is used to view an expenditure type class. This object includes attributes which are used to store values of an expenditure type class. |
| FinancialProjectPlans | The Financial Project Plan resource is used to view the financial project plan version. |
| FinancialProjectPlansPlanningOptions | The Planning Options resource is used to view the planning options configured for the financial project plan version. Planning options are user-definable options, that include plan settings, rate settings, currency settings, and generation options, and are used to control planning scenarios. Financial project plan versions inherit planning options that are defined for the project plan type that's associated to the project. |
| FinancialProjectPlansPlanningOptionsPlanningCurrencies | The Planning Currency resource is used to view project and planning currencies. |
| FinancialProjectPlansPlanningOptionsPlanningOptionsDFF | A listing of all the descriptive flexfields available for planning options in the financial project plan version. |
| FinancialProjectPlansResourceAssignments | The Resource Assignments resource is used to view a financial project plan resource assignment. |
| FinancialProjectPlansResourceAssignmentsPlanningAmounts | The Planning Amounts resource is used to view a financial project plan resource assignment amounts. |
| FinancialProjectPlansResourceAssignmentsPlanningAmountsPlanLinesDFF | The Plan Lines descriptive flexfields resource is used to view additional information for planning amounts in financial project plans. |
| FinancialProjectPlansVersionErrors | The Version Errors resource is used to view the errors in a financial project plan resource assignment. |
| Finders | Lists the findername along with the attributes for a particular view. |
| FlexFndDffDescriptiveFlexfieldContexts | Descriptive Flexfield Contexts List of Values |
| FundingSourcesLOV | The Award Project Funding Sources LOV resource is used to view an award project funding source. The service data object contains a list of funding sources with details such as funding source name and number. |
| GrantsKeywords | The Grants Keywords resource is used to view the grants keywords, which are used to uniquely describe and track the key subject area of an award or grants personnel. |
| GrantsPersonnel | The Grants Personnel resource is used to view Grants personnel. |
| GrantsPersonnelGrantsPersonnelDFF | A listing of all the descriptive flexfields available for Grants personnel. |
| GrantsPersonnelGrantsPersonnelKeyword | The Grants Personnel Keywords resource is used to view keywords that are associated to Grants personnel. |
| GrantsSponsors | The Grants Sponsors resource is used to get all or a filtered set of funding sources. |
| GrantsSponsorsGrantsSponsorAccountDetails | The Grants Sponsor Account Details resource is used to get the details of the sponsor account. |
| GrantsSponsorsgrantsSponsorReferenceTypes | The Grants Sponsor Reference Types resource is used to get sponsor reference types. |
| PrjBusinessUnitsLOV | The LOV for Project Business Units resource is used to view a list of project business units. A business unit is a unit of an enterprise that performs one or many business functions that can be rolled up in a management hierarchy. A project business unit is one within which the project is created, and in which the project customer revenue and receivable invoices are processed. |
| ProjectandTaskCostRateOverrides | The Project and Task Cost Rate Overrides resource is used to view, create, update, or delete the cost rate overrides defined for a project. |
| ProjectAssets | The project asset resource is used to view project asset and asset assignments, including those from Project Portfolio Management and those imported from third-party applications. Asset Assignment is a child of the Asset. |
| ProjectAssetsProjectAssetAssignments | The project asset assignment resource is used to view project asset assignments, including those from Project Portfolio Management and those imported from third-party applications. |
| ProjectAssetsProjectAssetDff | The operations from the Project Assets/Project Asset Descriptive Flexfields category. |
| ProjectAwardDistributions | The Project Award Distributions resource is used to distribute a cost using the active funding patterns for date ranges that include the expenditure item date provided. |
| ProjectAwardDistributionsProjectAwardDistributionLines | This is a child resource of Project Award Distributions that provides the cost distribution records created by the Award Distribution process. |
| ProjectBudgets | The Project Budgets resource is used to view a project budget. |
| ProjectBudgetsAttachments | The Attachment resource is used to view delete attachments for project budgets. |
| ProjectBudgetsPlanningOptions | The Planning Options resource is used to view the planning options configured for the project budget version. Planning options are user-definable options, including plan settings, rate settings, currency settings, and generation options that are used to control planning scenarios. Budget versions inherit planning options that are defined for financial plan types. |
| ProjectBudgetsPlanningOptionsAmountTypes | The Amount Type resource is used to select the cost and revenue items to include in a financial plan type. |
| ProjectBudgetsPlanningOptionsBudgetaryControlSettings | The Budgetary Control Setting resource is used to view and update project and top resource control levels. |
| ProjectBudgetsPlanningOptionsExportOptions | The Export Option resource is used to select the planning options attributes to export. |
| ProjectBudgetsPlanningOptionsPlanningCurrencies | The Planning Currency resource is used to view delete project and planning currencies. |
| ProjectBudgetsPlanningOptionsPlanningOptionsDFF | A listing of all the descriptive flexfields available for planning options in project budget versions. |
| ProjectBudgetsPlanningResources | The Planning Resources resource is used to view a project budget line. |
| ProjectBudgetsPlanningResourcesPlanningAmounts | The Planning Amounts resource is used to view periodic amounts for a budget line. |
| ProjectBudgetsPlanningResourcesPlanningAmountsPlanLinesDFF | The Plan Lines Descriptive Flexfields resource is used to view additional information for planning amounts in project budgets. |
| ProjectBudgetsPlanningResourcesPlanningAmountsPlanningAmountDetails | The Planning Amount Details resource is used to view periodic amounts for a budget line. |
| ProjectBudgetSummary | The Project Budget Summary resource is used to view a project budget. |
| ProjectBudgetSummaryResources | The Resources resource is used to view a project budget version resource. |
| ProjectBudgetSummaryResourcesBudgetLines | The Budget Lines resource is used to view a resource's project budget line. |
| ProjectBudgetSummaryResourcesBudgetLinesPlanningAmountDetails | The Planning Amount Details resource is used to view a project budget line periodic amounts. |
| ProjectBudgetSummaryTasks | The Tasks resource is used to view a project budget version task. |
| ProjectBudgetSummaryTasksBudgetLines | The Budget Lines resource is used to view a task's project budget line. |
| ProjectBudgetSummaryTasksBudgetLinesPlanningAmountDetails | The Planning Amount Details resource is used to view a project budget line periodic amounts. |
| ProjectBudgetSummaryVersionErrors | The Version Errors resource is used to view project budget version errors. |
| ProjectBudgetsVersionErrors | The Version Errors resource is used to view project budget version errors. |
| ProjectClassCodesLOV | The LOV for Project Class Codes resource is used to view a list of values of project class codes. This object includes attributes which are used to store values of a project class code. |
| ProjectCommitments | The project commitments resource is used to view project commitments. This includes viewing, creating, and deleting project commitments that are imported from third-party applications and viewing commitments that are created in other Oracle Fusion applications such as supplier invoices, requisitions, purchase orders, and so on. |
| ProjectCosts | The Project Costs resource is used to view project costs. Project costs are the smallest logical units of expenditure that you can charge to a project or task. For example, a time card item or an expense report item. |
| ProjectCostsAdjustments | The Adjustments resource is used to view the adjustments performed on project costs. |
| ProjectCostsProjectCostsDFF | The Project Costs Descriptive Flexfields resource is used to view and update additional information for project costs. |
| ProjectCostsProjectStandardCostCollectionFlexFields | The Project Standard Cost Collection Flexfields resource is used to capture, view, and update standard cost collection information for project costs. |
| ProjectEnterpriseExpenseResources | The Project Enterprise Expense resource is used to view project enterprise expense resources. |
| ProjectEnterpriseLaborResources | The Project Enterprise Labor resource is used to view project enterprise labor resources. |
| ProjectEnterpriseLaborResourcesAttachments | The attachments resource is used to view attachments. |
| ProjectEnterpriseLaborResourcesPersonAssignmentDetails | The Project Enterprise Resource HCM Assignment Details resource is used to view primary HCM assignment details such as business unit, organization, job, or manager related to the enterprise labor resource. |
| ProjectEnterpriseLaborResourcesProjectEnterpriseResourceImage | The Project Enterprise Resource Image is used to view project enterprise resource image. |
| ProjectEnterpriseLaborResourcesResourceCalendars | The Project Enterprise Resource Calendars resource is used to view calendars of a Project Enterprise Resource which are single workday pattern and single shift. A calendar is used when scheduling or staffing a Project Enterprise Resource. |
| ProjectEnterpriseLaborResourcesResourceCalendarsCalendarExceptions | The Project Enterprise Resource Calendar Exceptions resource is used to view exceptions on a calendar. A calendar exception is used to define holidays or exceptional working days on a weekend. A calendar could have many exceptions. |
| ProjectEnterpriseLaborResourcesResourcePoolMembership | The Project Enterprise Resource Pool Membership resource is used to view resource pools where the Project Enterprise Resource has present, past, or future memberships. |
| ProjectEnterpriseResources | The project enterprise resource is used to store values while creating or updating project enterprise resources. A project enterprise resource can be a labor resource or an expense resource and can be assigned to a project to complete the project work. |
| ProjectExpenditureItems | The smallest logical unit of an expenditure that you can charge to a project or task. For example, a time card item or an expense report item. |
| ProjectExpenditureItemsProjectExpenditureItemsDFF | The Project Expenditure Items Descriptive Flexfields resource is used to view and update additional information for project costs. |
| ProjectFinancialTasks | The Financial Task resource is used to list financial tasks. Tasks are units of project work assigned or performed as part of the duties of a resource. Tasks can be a portion of project work to be performed within a defined period by a specific resource or multiple resources. |
| ProjectForecasts | The Project Forecasts resource is used to view project forecasts. |
| ProjectForecastsAttachments | The attachments resource is used to view attachments for project forecasts. |
| ProjectForecastsPlanningOptions | The Planning Options resource is used to view the planning options configured for the project forecast version. |
| ProjectForecastsPlanningOptionsAmountTypes | The Amount Type resource is used to select the cost and revenue items to include in a financial plan type. |
| ProjectForecastsPlanningOptionsExportOptions | The Export Option resource is used to select the planning options attributes to export. |
| ProjectForecastsPlanningOptionsPlanningCurrencies | The Planning Currency resource is used to view project and planning currencies. |
| ProjectForecastsPlanningOptionsPlanningOptionsDFF | The Planning Options Descriptive Flexfields resource is used to view additional information for planning options in project forecast versions. |
| ProjectForecastsPlanningResources | The Planning Resources resource is used to view project forecast resource assignments. |
| ProjectForecastsPlanningResourcesPlanningAmounts | The Planning Amounts resource is used to view project forecast resource assignment summary amounts. |
| ProjectForecastsPlanningResourcesPlanningAmountsPlanLinesDFF | The Plan Lines Descriptive Flexfields resource is used to view additional information for planning amounts in project forecasts. |
| ProjectForecastsPlanningResourcesPlanningAmountsPlanningAmountDetails | The Planning Amount Details resource is used to view project forecast resource assignment periodic amounts. |
| ProjectForecastsVersionErrors | The Errors resource is used to view the errors in project forecasts. |
| ProjectIssues | The Project Issues resource is used to view issues associated to the project. |
| ProjectIssuesAttachments | The attachments resource is used to view attachments. |
| ProjectIssuesIssueAction | The Project Issues Action Items resource is used to view action items. Action items are tasks that are defined for issues that facilitates issue resolution. |
| ProjectNumberingConfigurations | The Project Numbering Configurations resource is used to specify the source by which project numbering is configured. |
| ProjectNumberingConfigurationsProjectNumberingConfigurationDetails | The Project Numbering Configuration Details resource is used to specify the details of the project numbering setup. The project numbering setup includes a mandatory default configuration and optional override configuration. |
| ProjectOrganizationsLOV | The Project Organizations LOV resource is used to view a project organization. This object includes attributes which are used to store values of a project organization. |
| ProjectPlanningRbs | The Planning Resource Breakdown Structures for Projects resource is used to view planning resource breakdown structure assignments to projects. You can view the header details, project information, and whether the planning resource breakdown structure is marked as primary. |
| ProjectPlanningRbsElements | The Elements resource is used to view and create resources in a planning resource breakdown structure. |
| ProjectPlanningRbsElementsLOV | The Project Planning Resources LOV is used to view a list of active resources from a planning resource breakdown structure associated with a project. |
| ProjectPlanningRbsFormats | The Formats resource is used to view all resource formats supported by a planning resource breakdown structure. |
| ProjectProcessConfigurators | The Project Process Configurators resource is used to view project process configurators. |
| ProjectProcessConfiguratorsSourceAsgnmts | The Source Assignments resource is used to view a Source for a configurator. |
| ProjectProgramCommunicationAssociations | Associations resource is used to manage the association of templates or reports to a business object like a program. A template is associated with a program to generate the corresponding report. |
| ProjectProgramCommunicationCatalogs | Project Program Communication Catalogs resource is used to manage the catalog objects to create templates and reports. |
| ProjectPrograms | The Project Programs resource is used to manage project programs and the program hierarchical structure. A program is a collection of projects that are managed as a group to coordinate, monitor and implement a corporate strategy. |
| ProjectProgramsProgramAvatars | The Program Avatars resource is used to manage the avatar image for a program. A program can have only one avatar at a time. |
| ProjectProgramsProgramDFF | The operations from the Project Programs/Program Descriptive Flexfields category. |
| ProjectProgramsProgramNotes | The Program Notes resource is used to manage notes for programs. |
| ProjectProgramsProgramProjects | The Project Assignments resource is used to manage the assignments of projects to a program. |
| ProjectProgramsProgramProjectsProgramProjectNotes | The Project Assignment Notes resource is used to manage notes for the project assignments to a program. |
| ProjectProgramsProgramStakeholders | The Stakeholders resource is used to manage the assignment of stakeholders and program administrators for a program. |
| ProjectProgramUsers | The Project Program Users resource is used to manage display preferences for users who define, coordinate, and monitor programs. Display preferences includes performance measures, watchlist, and currency. The resource is also used to retrieve the performance measures enabled for programs by your application administrator. |
| ProjectProgramUsersProgramPreferences | The Program Preferences resource is used to manage your program management display preferences. Display preferences includes performance measures, watchlist, and currency. Replace the person ID in the REST API path with the value -1 to get performance measures enabled for programs by your application administrator. |
| ProjectProgress | The Project Progress resource is used to capture draft progress, view draft and published progress, update draft progress, and publish progress for a project enabled for financial management. |
| ProjectProgressAttachments | The Attachment resource is used to view attachments for project progress. |
| ProjectProgressNotes | The Note resource is used to view, create, update, and delete notes for project progress. |
| ProjectProgressProjectProgressDFF | The Project Progress Descriptive Flexfields resource is used to view, create, and update additional information for project progress. |
| ProjectProgressTaskProgress | The Task Progress resource is used to view draft progress for the tasks of a project enabled for financial management. |
| ProjectProgressTaskProgressAttachments | The Attachment resource is used to view attachments for task progress. |
| ProjectProgressTaskProgressNotes | The Note resource is used to view delete notes for task progress. |
| ProjectProgressTaskProgressResourceProgress | The Project Progress resource is used to capture draft progress, view draft and published progress, update draft progress, and publish progress for a project enabled for financial management. |
| ProjectProgressTaskProgressResourceProgressAttachments | The Attachment resource is used to view attachments for resource progress. |
| ProjectProgressTaskProgressResourceProgressNotes | The Note resource is used to view notes for resource progress. |
| ProjectProgressTaskProgressResourceProgressResourceProgressDFF | The Resource Progress Descriptive Flexfields resource is used to view, create, and update additional information for resource progress. |
| ProjectProgressTaskProgressTaskProgressDFF | The Task Progress Descriptive Flexfields resource is used to view, create, and update additional information for task progress. |
| ProjectResourceActualHours | The Project Resource Actual Hours resource is used to view and create actual hours for a resource. |
| ProjectResourceAssignmentDailyHours | The Project Resource Assignment Daily Hours resource is used to view and manage daily assignment hours for a resource. |
| ProjectResourceAssignments | The Project Resource Assignments resource is used to view project resource assignments. |
| ProjectResourcePools | The Project Resource Pools resource is used to view project resource pools. |
| ProjectResourcePoolsProjectResourcePoolManagers | The Project Resource Pool Managers resource is used to view project resource pool managers associated to a resource pool. |
| ProjectResourcePoolsProjectResourcePoolMembers | The Project Resource Pool Members resource is used to view project resource pool members assigned to a resource pool. |
| ProjectResourceRequests | The Project Resource Requests resource is used to view, create, and manage project resource requests. |
| ProjectResourceRequestsProjectResourceRequestDFF | The Project Resource Request Descriptive Flexfields resource is used to view, create, and update descriptive flexfields associated to a project resource request. |
| ProjectResourceRequestsProjectResourceRequestLines | The Project Resource Request Lines resource is used to view the status and details of all proposed or nominated resources associated to the request. |
| ProjectResourceRequestsProjectResourceRequestQualifications | The Project Resource Request Qualifications resource is used to view project resource qualifications under a specific request. |
| ProjectResourceRequestsResourceRequestSchedules | The Project Resource Request Schedules resource is used to view schedule details of project resource requests with variable weekly hours |
| ProjectRolesLOV | The Project Roles LOV resource is used to view a Project Role. This object includes attributes which are used to store values of a project role. |
| Projects | The Project resource is used to view a project. A project is the effort and resources required to achieve a significant business objective within a specific, usually finite, time frame. |
| ProjectsAttachments | The Attachments resource is used to view attachments to a project. |
| ProjectsLOV | The Projects LOV resource is used to view a list of values of projects. This object includes attributes which are used to store values of a project. |
| ProjectsProjectClassifications | The Project Classification resource is used to view a project classification. A project classification includes a class category and a class code, wherein the category is a broad subject within which you can classify projects, and the code is a specific value of the category. |
| ProjectsProjectCustomers | The Project Customers resource is used to view customers associated with those projects that are enabled for financial management. This applies only to those customers that are defined as parties as part of the project definition. This doesn't retrieve the customer information from a contract linked to the project. |
| ProjectsProjectDFF | A listing of all the descriptive flexfields available for projects. |
| ProjectsProjectOpportunities | An object that includes attributes that are used to store values while creating or updating the opportunity details for a project. An opportunity is defined as a potential revenue-generating event. |
| ProjectsProjectStatusHistory | The endpoint that provides all project status changes and associated comments throughout the project's lifecycle. |
| ProjectsProjectTeamMembers | An object that includes attributes that are used to store values while creating or updating team members on a project. A project team member is a person who is assigned a role on a project. |
| ProjectsProjectTransactionControls | The Project Transaction Control resource is used to view, create, update, and delete a project transaction control. Project transaction controls are a set of criteria that control whether a transaction can be charged to a project. |
| ProjectsProviderBusinessUnits | This Project resource is used to view provider business units, regardless of whether they're from Project Portfolio Management or imported from third-party applications. The Provider Business Unit resource is a child of the Project resource. |
| ProjectsTaskDependencies | The Task Dependencies resource is used to store values while creating or updating the schedule dependencies between tasks. For example, a task that has a finish-to-start dependency on another task can start only after the other task is completed. |
| ProjectsTasks | The Task resource includes the attributes that are used to store values while creating or updating project tasks. Tasks are units of project work assigned or performed as part of the duties of a resource. Tasks can be a portion of project work to be performed within a defined period by a specific resource or multiple resources. |
| ProjectsTasksExpenseResourceAssignments | An object that includes the attributes that are used to store values while creating or updating expense resource assignments for a project task. For example, hotel expenses can be planned on a project task. |
| ProjectsTasksLaborResourceAssignments | An object that includes the attributes that are used to store values while creating or updating labor resource assignments for a project task. For example, a DBA can be assigned as labor resource for a project task. |
| ProjectsTasksTasksDFF | The Tasks Descriptive Flexfields resource is used to view, create, and update additional information for project tasks. |
| ProjectsTasksTaskTransactionControls | The Task Transaction Control resource is used to view a task transaction control. Task transaction controls are a set of criteria that control whether a transaction can be charged to a task. |
| ProjectsUsers | The project user resource is used to retrieve attributes for a team member. A team member can have project tasks and to do tasks assigned for tracking and completion. |
| ProjectsUsersChargeableFinancialTasks | The tasks for which the projects user can report expenditures such as time. |
| ProjectsUsersChargeableProjects | The projects for which the projects user can report expenditures such as time. |
| ProjectsUsersFollowedProjectTasks | The followed project task resource is used to retrieve attributes for a project task that a project user follows. |
| ProjectsUsersFollowedToDoTasks | The followed to do task resource is used to retrieve attributes for a to do task that a project user follows. To do Tasks may be followed by many project users. |
| ProjectsUsersProjectTasks | The project task resource is used to store values while creating or updating project tasks. A task is a unit of project work assigned or performed as part of a resource's duties. Tasks may be a portion of project work to be performed within a defined period by a specific resource or multiple resources. |
| ProjectsUsersProjectTasksLaborResourceAssignments | The labor resource assignment includes attributes used to store values while creating or updating labor resource assignments for a project task. For example, a DBA may be assigned as a labor resource for a project task. |
| ProjectsUsersProjectTasksTaskFollowers | The task follower resource is used to store values while adding or removing followers on project tasks. A project user can be assigned as a follower on a project task for viewing task details and tracking its completion. |
| ProjectsUsersToDoTasks | The to do task resource is used to store values while creating or updating to do tasks. A to do task is a unit of work assigned or performed as part of a resource's duties outside of any project. To do tasks may be performed within a defined period by a specific resource. |
| ProjectsUsersToDoTasksToDoTaskFollowers | The to do task follower resource is used to store values while adding or removing followers on to do tasks. |
| ProjectTasksLOV | The LOV for Project Tasks resource is used to view project tasks for a specific project. |
| ProjectTemplates | The Project Template resource is used to view and create a project template that is used for project creation. |
| ProjectTemplatesLOV | The LOV for Project Templates resource is used to view a list of project templates. Project templates are set up to have features common in the projects that an organization wants to create. A project template is used to enable a project for financial management and the financial attributes are copied from the template to the project. |
| ProjectTemplatesProjectClassifications | The Project Classification resource is used to view project classification. A project classification includes a class category and a class code, wherein the category is a broad subject within which you can classify projects, and the code is a specific value of the category. |
| ProjectTemplatesProjectCustomers | The Project Customer resource is used to view and create a project customer. This represents the name of the customer organization with whom the agreement has been made on the project. |
| ProjectTemplatesProjectTeamMembers | The Project Team Member resource is used to view and create a project team member. A project team member is a person who is assigned a role on a project. |
| ProjectTemplatesProjectTransactionControls | The Project Transaction Control resource is used to view and create a project transaction control. Project transaction controls are a set of criteria that control whether a transaction can be charged to a project. |
| ProjectTemplatesProviderBusinessUnits | The project template resource is used to view provider business units. This includes viewing, creating, updating, and deleting provider business units that are from Project Portfolio Management and those imported from third-party applications. Provider Business Unit is a child of the Project Template. |
| ProjectTemplatesQuickEntries | The Quick Entry resource is used to view a quick entry for a project template. |
| ProjectTemplatesSetupOptions | The Setup Option resource is used to view a setup option for a project template. |
| ProjectTemplatesTasks | The Task resource is used to view and create a project task. Tasks are units of project work assigned or performed as part of the duties of a resource. Tasks can be a portion of project work to be performed within a defined period by a specific resource or multiple resources. |
| ProjectTemplatesTasksTaskTransactionControls | The Task Transaction Control resource is used to view and create a task transaction control. Task transaction controls are a set of criteria that control whether a transaction can be charged to a task. |
| ProjectTypesLOV | The Project Types LOV resource is used to view a project type. This object includes attributes which are used to store values of a project type. |
| RateSchedules | The Rate Schedules resource is used to view project rate schedules and schedule lines, for schedule types of Job, Person, Nonlabor and Resource Class. Use project rate schedules to calculate costs, bill, plan, budget, and forecast amounts. |
| RateSchedulesLOV | The LOV for Rate Schedules resource is used to view a list of values of rate schedules. Rate schedules contain rates or markup percentage for person, job, nonlabor, and resource class. |
| RateSchedulesRates | The operations from the Rate Schedules/Rates category. |
| RateSchedulesRateScheduleDFF | The operations from the Rate Schedules/Rate Schedule Descriptive Flexfields category. |
| ResourceEvents | The Resource Events resource is used to view calendar events for a resource. |
| Sprints | The Sprints resource is used to view sprints in Agile development. A sprint is a time-boxed activity in which a usable product increment is created. |
| ValueSets | ValueSets |
| ValueSetsvalidationTable | ValueSetsvalidationTable |
| ValueSetsvalues | ValueSetsvalues |
| WorkTypesLOV | The Work Types LOV resource is used to view a work type. This object includes attributes which are used to store values of a work type. |
The Award Budget Period resource is used to view attributes such as budget period name, start date, and end date.
| Name | Type | Description |
| BudgetPeriod | String | Time interval assigned to the award for which the budget, actual, commitment, and available amounts are displayed. |
| StartDate | Date | Start date of the budget period for the award. |
| EndDate | Date | End date of the budget period for the award. |
| AwardBudgetPeriodId [KEY] | Long | Identifier of the award budget period. |
| AwardId | Long | Internal identifier of the award. |
| Finder | String | finder |
The Award Budgets resource is used to view an award budget.
| Name | Type | Description |
| FinancialPlanType | String | Name of the financial plan type used to create the award budget version. |
| PlanningAmounts | String | The planning amount, either cost or revenue, that you must specify when using a financial plan type that allows creation of cost and revenue versions separately. |
| PlanVersionId [KEY] | Long | Identifier of the award budget version. |
| PlanVersionNumber | Long | Plan version number for the award budget. |
| PlanVersionName | String | Plan version name for the award budget. |
| PlanVersionDescription | String | Plan version description for the award budget. |
| PlanVersionStatus | String | Plan version status for the award budget. |
| AwardId | Long | Identifier of the award on which the budget is created. |
| AwardNumber | String | Number of the award on which the budget is created. |
| AwardName | String | Name of the award on which the budget is created. |
| ProjectId | Long | Identifier of the project on which the award budget is created. |
| ProjectNumber | String | Number of the project on which the award budget is created. |
| ProjectName | String | Name of the project on which the award budget is created. |
| BudgetCreationMethod | String | Value of the budget creation method. Valid values are: MANUAL, GENERATE, and COPY. |
| SourcePlanVersionId | Long | Identifier of the source plan version. The SourcePlanVersionId attributes takes precedence over all the other attributes such as generation source, plan type, and so on. |
| BudgetGenerationSource | String | Value of the financial plan type to create a budget from an existing budget. Valid values are: Financial Plan Type and Project Plan Type. |
| SourcePlanType | String | Name of the financial plan type to create a budget from an existing budget. |
| SourcePlanVersionStatus | String | Status of the source plan version when creating a budget using a financial project plan. Valid values are: Current Working and Baseline. |
| SourcePlanVersionNumber | Long | Number of the source plan version. |
| LockedFlag | Bool | Indicates if the project forecast version is locked. |
| LockedBy | String | Name of the user who has locked the project forecast version. |
| CopyAdjustmentPercentage | Decimal | Percentage value, either positive or negative, used to adjust the existing values when creating new version values. |
| PCRawCostAmounts | Decimal | Budget raw cost amounts in project currency for the award budget version. |
| PCBurdenedCostAmounts | Decimal | Budget burdened cost amounts in project currency for the award budget version. |
| PCRevenueAmounts | Decimal | Budget revenue amounts in project currency for the award budget version. |
| PFCRawCostAmounts | Decimal | Budget raw cost amounts in project ledger currency for the award budget version. |
| PFCBurdenedCostAmounts | Decimal | Budget burdened cost amounts in project ledger currency for the award budget version. |
| PFCRevenueAmounts | Decimal | Budget revenue amounts in project ledger currency for the award budget version. |
| DeferFinancialPlanCreation | String | Indicates that the budget version will be created in a deferred mode. Valid values are Y and N. The default value is Y. A value of Y means that the budget version will be created in a deferred mode by the Process Financial Plan Versions process. A value of N means that the budget version will be created in real time and included in the response of the POST operation. |
| AdministrativeCode | String | Identifies the action that an administrator can perform on the budget version based on specific requirements. Not to be used in typical implementations. |
| PlanningOptionId | Long | Identifier of the planning option setup for the financial or project plan version. |
| RbsVersionId | Long | Identifier of the resource breakdown structure that is attached to the project for which you can view summarized data. |
| Finder | String | finder |
The Attachment resource is used to view attachments for award budgets.
| Name | Type | Description |
| AwardBudgetsPlanVersionId [KEY] | Long | Identifier of the award budget version. |
| AttachedDocumentId [KEY] | Long | The unique identifier of the attached document. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| DatatypeCode | String | A value that indicates the data type. |
| FileName | String | The file name of the attachment. |
| DmFolderPath | String | The folder path from which the attachment is created. |
| DmDocumentId | String | The document ID from which the attachment is created. |
| DmVersionNumber | String | The document version number from which the attachment is created. |
| Url | String | The URL of a web page type attachment. |
| CategoryName | String | The category of the attachment. |
| UserName | String | The login credentials of the user who created the attachment. |
| Uri | String | The URI of a Topology Manager type attachment. |
| FileUrl | String | The URI of the file. |
| UploadedText | String | The text content for a new text attachment. |
| UploadedFileContentType | String | The content type of the attachment. |
| UploadedFileLength | Long | The size of the attachment file. |
| UploadedFileName | String | The name to assign to a new attachment file. |
| ContentRepositoryFileShared | Bool | Indicates whether the attachment is shared |
| Title | String | The title of the attachment. |
| Description | String | The description of the attachment. |
| ErrorStatusCode | String | The error code, if any, for the attachment. |
| ErrorStatusMessage | String | The error message, if any, for the attachment. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| FileContents | String | The contents of the attachment. |
| ExpirationDate | Datetime | The expiration date of the contents in the attachment. |
| LastUpdatedByUserName | String | The user name who last updated the record. |
| CreatedByUserName | String | The user name who created the record. |
| AsyncTrackerId | String | Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. |
| FileWebImage | String | The base64 encoded image of the file displayed in .png format if the source is a convertible image. |
| DownloadInfo | String | JSON object represented as a string containing information used to programmatically retrieve a file attachment. |
| PostProcessingAction | String | The name of the action that can be performed after an attachment is uploaded. |
| AwardId | Long | awardid |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | Long | projectid |
The Planning Options resource is used to view the planning options configured for the award budget version. Planning options are user-definable options, including plan settings, rate settings, currency settings, and generation options that are used to control planning scenarios. Award budget versions inherit planning options that are defined for financial plan types.
| Name | Type | Description |
| AwardBudgetsPlanVersionId [KEY] | Long | Identifier of the award budget version. |
| PlanningOptionId [KEY] | Long | Identifier of the planning option setup for the financial or project plan version. |
| AwardId | Long | awardid |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | Long | projectid |
A listing of all the descriptive flexfields available for planning options in award budget versions.
| Name | Type | Description |
| AwardBudgetsPlanVersionId [KEY] | Long | Identifier of the award budget version. |
| PlanningoptionsPlanningOptionId [KEY] | Long | Unique identifier of the summary-level planning option in the award budget version. |
| PlanningOptionId [KEY] | Long | PlanningOptionId |
| _FLEX_Context | String | Code that identifies the context for the segments of the planning options flexfields. |
| _FLEX_Context_DisplayValue | String | Name of the context for the segments of the planning options flexfields. |
| AwardId | Long | awardid |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | Long | projectid |
The Planning resources is used to view an award budget line.
| Name | Type | Description |
| AwardBudgetsPlanVersionId [KEY] | Long | Identifier of the award budget version. |
| PlanningElementId [KEY] | Long | Identifier of a planning element. |
| TaskId | Long | Identifier of the task which is used to create a award budget line |
| TaskNumber | String | Number of the task which is used to create a award budget line. |
| TaskName | String | Name of the task which is used to create a award budget line. |
| RbsElementId | Long | Identifier of the resource used to create the award budget line. |
| ResourceName | String | The name of the resource used to create the award budget line. |
| UnitOfMeasure | String | The units, such as hours and days, used for measuring the work or effort that is planned for a resource on a budget line. |
| PlanningStartDate | Datetime | Award budget line start date. |
| PlanningEndDate | Datetime | Award budget line end date. |
| FundingSourceId | Long | Identifier of the funding source used to create the award budget line. |
| FundingSourceNumber | String | Funding Source Number used to create the award budget line. |
| FundingSourceName | String | Funding Source Name used to create the award budget line. |
| AwardId | Long | awardid |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | Long | projectid |
The Planning Amounts resource is used to viewn award budget line amounts.
| Name | Type | Description |
| AwardBudgetsPlanVersionId [KEY] | Long | Identifier of the award budget version. |
| PlanningresourcesPlanningElementId [KEY] | Long | Identifier of the award budget line. |
| PlanLineId [KEY] | Long | Identifier of a planning amount line. |
| Quantity | Decimal | Measure of the effort planned for the award budget line. |
| Currency | String | Currency code for the award budget lines. |
| RawCostAmounts | Decimal | Award budget line raw cost amounts in transaction currency. |
| BurdenedCostAmounts | Decimal | Award budget line burdened cost amounts in transaction currency. |
| RevenueAmounts | Decimal | Award budget line revenue amounts in transaction currency. |
| EffectiveRawCostRate | Decimal | Effective raw cost rate for award budget line. |
| StandardRawCostRate | Decimal | Standard raw cost rate for award budget line. |
| EffectiveBurdenedCostRate | Decimal | Effective burdened cost rate for award budget line. |
| StandardBurdenedCostRate | Decimal | Standard burdened cost rate for award budget line. |
| EffectiveRevenueRate | Decimal | Effective revenue rate for award budget line. |
| StandardRevenueRate | Decimal | Standard revenue rate for award budget line. |
| PCRawCostAmounts | Decimal | Award budget line raw cost amounts in project currency. |
| PCBurdenedCostAmounts | Decimal | Award budget line burdened cost amounts in project currency. |
| PCRevenueAmounts | Decimal | Award budget line revenue amounts in project currency. |
| PFCRawCostAmounts | Decimal | Award budget line raw cost amounts in project ledger currency. |
| PFCBurdenedCostAmounts | Decimal | Award budget line burdened cost amounts in project ledger currency. |
| PFCRevenueAmounts | Decimal | Award budget line revenue amounts in project ledger currency. |
| AwardId | Long | awardid |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | Long | projectid |
The Plan Lines Descriptive Flexfields resource is used to capture, view, and update additional information for planning amounts in award budgets.
| Name | Type | Description |
| AwardBudgetsPlanVersionId [KEY] | Long | Identifier of the award budget version. |
| PlanningresourcesPlanningElementId [KEY] | Long | Identifier of the award budget line. |
| PlanningamountsPlanLineId [KEY] | Long | Identifier of the summary level planning amounts for a planning resource in the award budget. |
| PlanLineId [KEY] | Long | Identifier of the summary level planning amounts for a plan line in the award budget. |
| _FLEX_Context | String | Code that identifies the context for the segments of the plan lines flexfields. |
| _FLEX_Context_DisplayValue | String | Name of the context for the segments of the plan lines flexfields. |
| AwardId | Long | awardid |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | Long | projectid |
The Planning Amount Details resource is used to view an award budget line periodic amounts.
| Name | Type | Description |
| AwardBudgetsPlanVersionId [KEY] | Long | Identifier of the award budget version. |
| PlanningresourcesPlanningElementId [KEY] | Long | Identifier of the award budget line. |
| PlanningamountsPlanLineId [KEY] | Long | Identifier of the summary level planning amounts for a planning resource in the award budget. |
| PlanLineDetailId [KEY] | Long | Identifier of a plan line detail |
| PeriodName | String | Period for which the award budgets are created. |
| Quantity | Decimal | Measure of the effort planned for the award budget line by period. |
| RawCostAmounts | Decimal | Periodic award budget line raw cost amounts in transaction currency. |
| BurdenedCostAmounts | Decimal | Periodic award budget line burdened cost amounts in transaction currency. |
| RevenueAmounts | Decimal | Periodic award budget line revenue amounts in transaction currency. |
| EffectiveRawCostRate | Decimal | Effective raw cost rate for periodic line. |
| StandardRawCostRate | Decimal | Standard raw cost rate for periodic line. |
| EffectiveBurdenedCostRate | Decimal | Effective burdened cost rate for periodic line. |
| StandardBurdenedCostRate | Decimal | Standard burdened cost rate for periodic line. |
| EffectiveRevenueRate | Decimal | Effective revenue rate for periodic line. |
| StandardRevenueRate | Decimal | Standard revenue rate for periodic line. |
| PCRawCostAmounts | Decimal | Periodic award budget line raw cost amounts in project currency. |
| PCBurdenedCostAmounts | Decimal | Periodic award budget line burdened cost amounts in project currency. |
| PCRevenueAmounts | Decimal | Periodic award budget line revenue amounts in project currency. |
| PFCRawCostAmounts | Decimal | Periodic award budget line raw cost amounts in project ledger currency. |
| PFCBurdenedCostAmounts | Decimal | Periodic award budget line burdened cost amounts in project ledger currency. |
| PFCRevenueAmounts | Decimal | Periodic award budget line revenue amounts in project ledger currency. |
| AwardId | Long | awardid |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | Long | projectid |
The Award Budget Summary resource is used to view an award budget.
| Name | Type | Description |
| FinancialPlanType | String | Name of the financial plan type used to create the award budget version. |
| PlanVersionId [KEY] | Long | Identifier of the award budget version. |
| PlanVersionNumber | Long | Plan version number for the award budget. |
| PlanVersionName | String | Plan version name for the award budget. |
| PlanVersionDescription | String | Plan version description for the award budget. |
| PlanVersionStatus | String | Plan version status for the award budget. |
| AwardId | Long | Identifier of the award on which the budget is created. |
| AwardNumber | String | Number of the award on which the budget is created. |
| AwardName | String | Name of the award on which the budget is created. |
| ProjectId | Long | Identifier of the project on which the award budget is created. |
| ProjectNumber | String | Number of the project on which the award budget is created. |
| ProjectName | String | Name of the project on which the award budget is created. |
| PlanningAmounts | String | The planning amount, either cost or revenue, that you must specify when using a financial plan type that allows creation of cost and revenue versions seperately. |
| PCRawCostAmounts | Decimal | Budget raw cost amounts in project currency for the award budget version. |
| PCBurdenedCostAmounts | Decimal | Budget burdened cost amounts in project currency for the award budget version. |
| PCRevenueAmounts | Decimal | Budget revenue amounts in project currency for the award budget version. |
| PFCRawCostAmounts | Decimal | Budget raw cost amounts in project ledger currency for the award budget version. |
| PFCBurdenedCostAmounts | Decimal | Budget burdened cost amounts in project ledger currency for the award budget version. |
| PFCRevenueAmounts | Decimal | Budget revenue amounts in project ledger currency for the award budget version. |
| Finder | String | finder |
The Resources resource is used to view the resources in the planning resource breakdown structure that are included in the award budget.
| Name | Type | Description |
| AwardBudgetSummaryPlanVersionId [KEY] | Long | Identifier of the award budget version. |
| RbsElementId [KEY] | Long | Identifier of the resource used to create the award budget line. |
| ResourceName | String | The name of the resource used to create the award budget line. |
| ResourceFormat | String | Resource format to add resource element to the planning resource breakdown structure. |
| ResourceClass | String | A resource type that is available for use within resource format hierarchies on planning resource breakdown structure. |
| ParentElementId | Long | Identifier of the parent resource breakdown structure element. |
| Quantity | Decimal | Measure of the effort planned for the award budget line. |
| Currency | String | Currency code for the award budget lines. |
| RawCostAmounts | Decimal | Award budget line raw cost amounts in transaction currency. |
| BurdenedCostAmounts | Decimal | Award budget line burdened cost amounts in transaction currency. |
| RevenueAmounts | Decimal | Award budget line revenue amounts in transaction currency. |
| PCRawCostAmounts | Decimal | Award budget line raw cost amounts in project currency. |
| PCBurdenedCostAmounts | Decimal | Award budget line burdened cost amounts in project currency. |
| PCRevenueAmounts | Decimal | Award budget line revenue amounts in project currency. |
| PFCRawCostAmounts | Decimal | Award budget line raw cost amounts in project ledger currency. |
| PFCBurdenedCostAmounts | Decimal | Award budget line burdened cost amounts in project ledger currency. |
| PFCRevenueAmounts | Decimal | Award budget line revenue amounts in project ledger currency. |
| AwardId | Long | awardid |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | Long | projectid |
The Budget Lines resource is used to view the budget lines for a resource.
| Name | Type | Description |
| AwardBudgetSummaryPlanVersionId [KEY] | Long | Identifier of the award budget version. |
| ResourcesRbsElementId [KEY] | Long | Identifier of the resource used to create the award budget line. |
| TaskId | Long | Identifier of the task which is used to create an award budget line |
| TaskNumber | String | Number of the task which is used to create an award budget line. |
| TaskName | String | Name of the task which is used to create an award budget line. |
| ResourceFormat | String | Resource format to add resource element to the planning resource breakdown structure. |
| ResourceClass | String | A resource type that is available for use within resource format hierarchies on planning resource breakdown structure. |
| SpreadCurve | String | Spread curves distributes quantity, cost, and revenue amounts automatically across accounting or project accounting periods. |
| RbsElementId | Long | Identifier of the resource used to create the award budget line. |
| ResourceName | String | The name of the resource used to create the award budget line. |
| PlanningStartDate | Date | Award budget line start date. |
| PlanningEndDate | Date | Award budget line end date. |
| FundingSourceId | Long | Identifier of the funding source used to create the award budget line. |
| FundingSourceNumber | String | Funding Source Number used to create the award budget line. |
| FundingSourceName | String | Funding Source Name used to create the award budget line. |
| Quantity | Decimal | Measure of the effort planned for the award budget line. |
| Currency | String | Currency code for the award budget lines. |
| RawCostAmounts | Decimal | Award budget line raw cost amounts in transaction currency. |
| BurdenedCostAmounts | Decimal | Award budget line burdened cost amounts in transaction currency. |
| RevenueAmounts | Decimal | Award budget line revenue amounts in transaction currency. |
| EffectiveRawCostRate | Decimal | Effective raw cost rate for award budget line. |
| StandardRawCostRate | Decimal | Standard raw cost rate for award budget line. |
| EffectiveBurdenedCostRate | Decimal | Effective burdened cost rate for award budget line. |
| StandardBurdenedCostRate | Decimal | Standard burdened cost rate for award budget line. |
| EffectiveRevenueRate | Decimal | Effective revenue rate for award budget line. |
| StandardRevenueRate | Decimal | Standard revenue rate for award budget line. |
| PCRawCostAmounts | Decimal | Award budget line raw cost amounts in project currency. |
| PCBurdenedCostAmounts | Decimal | Award budget line burdened cost amounts in project currency. |
| PCRevenueAmounts | Decimal | Award budget line revenue amounts in project currency. |
| PFCRawCostAmounts | Decimal | Award budget line raw cost amounts in project ledger currency. |
| PFCBurdenedCostAmounts | Decimal | Award budget line burdened cost amounts in project ledger currency. |
| PFCRevenueAmounts | Decimal | Award budget line revenue amounts in project ledger currency. |
| TaskSequence | Long | Position of the task in the hierarchical arrangement. |
| AwardId | Long | awardid |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | Long | projectid |
The Planning Amount Details resource is used to view periodic amounts for a budget line.
| Name | Type | Description |
| AwardBudgetSummaryPlanVersionId [KEY] | Long | Identifier of the award budget version. |
| ResourcesRbsElementId [KEY] | Long | Identifier of the resource used to create the award budget line. |
| PeriodName | String | Period for which the periodic budget amount is entered. |
| Quantity | Decimal | Measure of the effort planned for the award budget line by period. |
| RawCostAmounts | Decimal | Periodic award budget line raw cost amounts in transaction currency. |
| BurdenedCostAmounts | Decimal | Periodic award budget line burdened cost amounts in transaction currency. |
| RevenueAmounts | Decimal | Periodic award budget line revenue amounts in transaction currency. |
| EffectiveRawCostRate | Decimal | Effective raw cost rate for periodic line. |
| StandardRawCostRate | Decimal | Standard raw cost rate for periodic line. |
| EffectiveBurdenedCostRate | Decimal | Effective burdened cost rate for periodic line. |
| StandardBurdenedCostRate | Decimal | Standard burdened cost rate for periodic line. |
| EffectiveRevenueRate | Decimal | Effective revenue rate for periodic line. |
| StandardRevenueRate | Decimal | Standard revenue rate for periodic line. |
| PCRawCostAmounts | Decimal | Periodic award budget line raw cost amounts in project currency. |
| PCBurdenedCostAmounts | Decimal | Periodic award budget line burdened cost amounts in project currency. |
| PCRevenueAmounts | Decimal | Periodic award budget line revenue amounts in project currency. |
| PFCRawCostAmounts | Decimal | Periodic award budget line raw cost amounts in project ledger currency. |
| PFCBurdenedCostAmounts | Decimal | Periodic award budget line burdened cost amounts in project ledger currency. |
| PFCRevenueAmounts | Decimal | Periodic award budget line revenue amounts in project ledger currency. |
| AwardId | Long | awardid |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | Long | projectid |
The Tasks resource is used to view an award budget version task.
| Name | Type | Description |
| AwardBudgetSummaryPlanVersionId [KEY] | Long | Identifier of the award budget version. |
| TaskId [KEY] | Long | Identifier of the task which is used to create an award budget line |
| TaskNumber | String | Number of the task which is used to create an award budget line. |
| TaskName | String | Name of the task which is used to create an award budget line. |
| ParentTaskId | Long | Identifier of the parent task. |
| PlanningStartDate | Date | Scheduled start date of the project task. |
| PlanningEndDate | Date | Scheduled end date of the project task. |
| Quantity | Decimal | Measure of the effort planned for the award budget line. |
| Currency | String | Currency code for the award budget lines. |
| RawCostAmounts | Decimal | Award budget line raw cost amounts in transaction currency. |
| BurdenedCostAmounts | Decimal | Award budget line burdened cost amounts in transaction currency. |
| RevenueAmounts | Decimal | Award budget line revenue amounts in transaction currency. |
| PCRawCostAmounts | Decimal | Award budget line raw cost amounts in project currency. |
| PCBurdenedCostAmounts | Decimal | Award budget line burdened cost amounts in project currency. |
| PCRevenueAmounts | Decimal | Award budget line revenue amounts in project currency. |
| PFCRawCostAmounts | Decimal | Award budget line raw cost amounts in project ledger currency. |
| PFCBurdenedCostAmounts | Decimal | Award budget line burdened cost amounts in project ledger currency. |
| PFCRevenueAmounts | Decimal | Award budget line revenue amounts in project ledger currency. |
| TaskSequence | Long | Position of the task in the hierarchical arrangement. |
| AwardId | Long | awardid |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | Long | projectid |
The Budget Lines resource is used to view the budget lines for a task.
| Name | Type | Description |
| AwardBudgetSummaryPlanVersionId [KEY] | Long | Identifier of the award budget version. |
| TasksTaskId [KEY] | Long | Identifier of the task which is used to create a award budget line. |
| RbsElementId | Long | Identifier of the resource used to create the award budget line. |
| ResourceName | String | The name of the resource used to create the award budget line. |
| TaskId | Long | Identifier of the task which is used to create an award budget line |
| TaskNumber | String | Number of the task which is used to create an award budget line. |
| TaskName | String | Name of the task which is used to create an award budget line. |
| ResourceFormat | String | Resource format to add resource element to the planning resource breakdown structure. |
| ResourceClass | String | A resource type that is available for use within resource format hierarchies on planning resource breakdown structure. |
| SpreadCurve | String | Spread curves distributes quantity, cost, and revenue amounts automatically across accounting or project accounting periods. |
| PlanningStartDate | Date | Award budget line start date. |
| PlanningEndDate | Date | Award budget line end date. |
| FundingSourceId | Long | Identifier of the funding source used to create the award budget line. |
| FundingSourceNumber | String | Funding Source Number used to create the award budget line. |
| FundingSourceName | String | Funding Source Name used to create the award budget line. |
| Quantity | Decimal | Measure of the effort planned for the award budget line. |
| Currency | String | Currency code for the award budget lines. |
| RawCostAmounts | Decimal | Award budget line raw cost amounts in transaction currency. |
| BurdenedCostAmounts | Decimal | Award budget line burdened cost amounts in transaction currency. |
| RevenueAmounts | Decimal | Award budget line revenue amounts in transaction currency. |
| EffectiveRawCostRate | Decimal | Effective raw cost rate for award budget line. |
| StandardRawCostRate | Decimal | Standard raw cost rate for award budget line. |
| EffectiveBurdenedCostRate | Decimal | Effective burdened cost rate for award budget line. |
| StandardBurdenedCostRate | Decimal | Standard burdened cost rate for award budget line. |
| EffectiveRevenueRate | Decimal | Effective revenue rate for award budget line. |
| StandardRevenueRate | Decimal | Standard revenue rate for award budget line. |
| PCRawCostAmounts | Decimal | Award budget line raw cost amounts in project currency. |
| PCBurdenedCostAmounts | Decimal | Award budget line burdened cost amounts in project currency. |
| PCRevenueAmounts | Decimal | Award budget line revenue amounts in project currency. |
| PFCRawCostAmounts | Decimal | Award budget line raw cost amounts in project ledger currency. |
| PFCBurdenedCostAmounts | Decimal | Award budget line burdened cost amounts in project ledger currency. |
| PFCRevenueAmounts | Decimal | Award budget line revenue amounts in project ledger currency. |
| TaskSequence | Long | Position of the task in the hierarchical arrangement. |
| AwardId | Long | awardid |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | Long | projectid |
The Planning Amount Details resource is used to view periodic amounts for a budget line.
| Name | Type | Description |
| AwardBudgetSummaryPlanVersionId [KEY] | Long | Identifier of the award budget version. |
| TasksTaskId [KEY] | Long | Identifier of the task which is used to create a award budget line. |
| PeriodName | String | Period for which the periodic budget amount is entered. |
| Quantity | Decimal | Measure of the effort planned for the award budget line by period. |
| RawCostAmounts | Decimal | Periodic award budget line raw cost amounts in transaction currency. |
| BurdenedCostAmounts | Decimal | Periodic award budget line burdened cost amounts in transaction currency. |
| RevenueAmounts | Decimal | Periodic award budget line revenue amounts in transaction currency. |
| EffectiveRawCostRate | Decimal | Effective raw cost rate for periodic line. |
| StandardRawCostRate | Decimal | Standard raw cost rate for periodic line. |
| EffectiveBurdenedCostRate | Decimal | Effective burdened cost rate for periodic line. |
| StandardBurdenedCostRate | Decimal | Standard burdened cost rate for periodic line. |
| EffectiveRevenueRate | Decimal | Effective revenue rate for periodic line. |
| StandardRevenueRate | Decimal | Standard revenue rate for periodic line. |
| PCRawCostAmounts | Decimal | Periodic award budget line raw cost amounts in project currency. |
| PCBurdenedCostAmounts | Decimal | Periodic award budget line burdened cost amounts in project currency. |
| PCRevenueAmounts | Decimal | Periodic award budget line revenue amounts in project currency. |
| PFCRawCostAmounts | Decimal | Periodic award budget line raw cost amounts in project ledger currency. |
| PFCBurdenedCostAmounts | Decimal | Periodic award budget line burdened cost amounts in project ledger currency. |
| PFCRevenueAmounts | Decimal | Periodic award budget line revenue amounts in project ledger currency. |
| AwardId | Long | awardid |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | Long | projectid |
The Version Errors resource is used to view award budget version errors.
| Name | Type | Description |
| AwardBudgetSummaryPlanVersionId [KEY] | Long | Identifier of the award budget version. |
| ErrorType | String | Specifies whether a warning or error. |
| TaskNumber | String | Number of the task which is used to create a budgetline. |
| TaskName | String | Name of the task which is used to create a budgetline. |
| ResourceName | String | The name of the resource used to create the budget line. |
| PeriodName | String | Period for which the periodic budget amount is entered. |
| MessageText | String | Error or warning that occurrs or information that informs users, to know what action to take or to understand what is happening. |
| TransactionCurrencyCode | String | Currency code for budget line with errors. |
| MessageUserDetails | String | More detailed explanation of message text that states why the message occurred. |
| MessageCause | String | Explanation for the reason of an error or warning message. |
| MessageUserAction | String | States the response that end users must perform to continue and complete their tasks in response to an error or warning message. |
| MessageName | String | Currency code for the budget lines. |
| PlanVersionId | Long | Identifier of the award budget version. |
| TaskSequence | Long | Position of the task in the hierarchical arrangement. |
| AwardId | Long | awardid |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| ProjectId | Long | projectid |
The Version Errors resource is used to view award budget version and award budget line errors.
| Name | Type | Description |
| AwardBudgetsPlanVersionId [KEY] | Long | Identifier of the award budget version. |
| PlanVersionId | Decimal | Identifier of the project budget version. |
| TaskNumber | String | Number of the task which is used to create a budget line. |
| TaskName | String | Name of the task which is used to create a budget line. |
| ResourceName | String | The name of the resource which is used to create a budget line. |
| TransactionCurrencyCode | String | Currency code for budget line with errors. |
| PeriodName | String | Period for which the periodic budget amount is entered. |
| ErrorType | String | Specifies whether a warning or error. |
| MessageName | String | Message code for the issue encountered. |
| MessageText | String | Error or warning that occurs or information that informs users to know what action to take or to understand what is happening. |
| MessageCause | String | Explanation for the resaon of an error or warning message. |
| MessageUserDetails | String | More detailed explanation of the message text that explains why the message occurred. |
| MessageUserAction | String | States the response that the end users must perform to continue and complete their tasks in response to an error or warning message. |
| AwardId | Long | awardid |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| ProjectId | Long | projectid |
The Award Funding Source resource is used to create or update a funding source for the award.
| Name | Type | Description |
| FundingSourceName | String | Name of the funding source associated with the award. |
| FundingSourceNumber | String | Number of the funding source that's provided by the user. |
| AwardId | Long | Internal identifier of the award. |
| AwardFundingSourceId [KEY] | Long | Identifier of the award funding source. |
| FundingSourceId | Long | Identifier of the funding source. |
| Finder | String | finder |
The Award Project Funding Sources LOV resource is used to view an award project funding source. The service data object contains a list of funding sources with details such as funding source name and number.
| Name | Type | Description |
| FundingSourceId | Long | The unique internal identifier of the funding source. |
| AwardId | Long | The unique internal identifier of the award. |
| FundingSourceName | String | Name of the funding source. |
| FundingSourceNumber | String | Number of the funding source. |
| ProjectId | Long | The unique internal identifier of the project. |
The Award Projects resource is used to view award project attributes such as project name and project number.
| Name | Type | Description |
| AwardProjectId [KEY] | Long | Unique identifier of the award project. |
| AwardId | Long | Unique identifier of the award. |
| AwardName | String | Name of the award. |
| AwardNumber | String | Number of the award. |
| ProjectId | Long | Unique identifier of the award project. |
| ProjectName | String | Name of the project associated to the award. |
| ProjectNumber | String | Number of the project associated to the award. |
| BurdenScheduleId | Long | The unique identifier of the burden schedule. |
| BurdenScheduleName | String | Name of the burden schedule assigned at the award project level. |
| BurdenScheduleFixedDate | Date | Specific date used to determine the right set of burden multipliers for the award project. |
| CurrencyCode | String | Currency code representing the award project currency. The currency code is a three-letter ISO code. |
| CreatedBy | String | The user that created the award project. |
| LastUpdateDate | Datetime | The date when the award project was last updated. |
| CreationDate | Datetime | The date when the award project was created. |
| LastUpdatedBy | String | The user that last updated the award project. |
| Finder | String | finder |
The Awards resource is used to view awards.
| Name | Type | Description |
| AwardId [KEY] | Long | Unique identifier of the award. |
| AwardName | String | Name of the award. |
| AwardNumber | String | Number of the award. |
| BusinessUnitId | Long | Unique identifier of the business unit. |
| BusinessUnitName | String | Unit of an enterprise that performs one or many business functions that can be rolled up in a management hierarchy. An award business unit is one within which the award is created. |
| CurrencyCode | String | Currency code representing the award currency. The currency code is a three-letter ISO code associated with a currency. |
| LegalEntityId | Long | Unique identifier of the legal entity of the award. |
| LegalEntityName | String | Recognized party with given rights and responsibilities by legislation. Owns the award being displayed. |
| SponsorId | Long | Unique identifier of the primary sponsor. |
| SponsorName | String | Name of the sponsor, who's also the customer, funding the award. |
| SponsorNumber | String | Number of the sponsor related to the customer from TCA. |
| StartDate | Date | Start date of the award. |
| EndDate | Date | End date of the award. |
| PrincipalInvestigatorId | Long | The unique identifier of the person, in human resources, identified as the principal investigator. |
| PrincipalInvestigatorName | String | Name of the person selected from Human Resources to administer and manage awards. |
| PrincipalInvestigatorNumber | String | Number of the person selected from Human Resources to administer and manage awards. |
| PrincipalInvestigatorEmail | String | E-mail of the person selected from Human Resources to administer and manage awards. |
| ExpandedAuthorityFlag | Bool | Indicates that the award funding is authorized to be spent across budget periods. |
| BurdenScheduleId | Long | Unique identifier of the burden schedule. |
| BurdenScheduleName | String | Name of the burden schedule assigned at the award level. |
| BurdenScheduleFixedDate | Date | Specific date used to determine the right set of burden multipliers for the award. |
| ContractTypeName | String | Name of the contract type of the award. |
| CloseDate | Date | Date past the end date of the award. Transactions for the award can be entered up to this date. |
| AwardType | String | Classification of an award, for example, Federal grants or Private grants. |
| DaysToClose | Long | Days to close of the award. |
| SponsorAwardNumber | String | Award number tracked by the sponsor. |
| AwardOwningOrganizationId | Long | The unique identifier of the award organization. |
| AwardOwningOrganizationName | String | An organization that owns awards within an enterprise. An organizing unit in the internal or external structure of your enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting for the award. |
| AwardPurposeCode | String | Code of the award purpose. |
| AwardPurpose | String | Name of the award purpose. |
| Description | String | Brief description of the award. |
| SourceAwardName | String | Name of the source award. |
| InstitutionId | Long | The unique identifier of the institution. |
| InstitutionName | String | Organizational entity that's receiving the funding. |
| ContractLineName | String | Name of the contract line created for the award contract. When the award is submitted for approval, it's set to the default value, unless specified otherwise. The default value for ContractLineName is Line 1. |
| DocumentNumber | String | The unique identifier of the letter of credit document issued to the award. |
| LetterOfCreditFlag | Bool | Indicates whether the award is issued under a letter of credit. If the award sponsor is a Federal and Letter of Credit sponsor, then the default value is true. Otherwise, the default value is false. |
| RevenuePlanName | String | Name of the revenue plan associated with the contract line for the award. When the award is submitted for approval, it's set to the default value, unless specified otherwise. The default value for RevenuePlanName is Award Revenue Plan. |
| BillPlanName | String | Name of the bill plan associated with the contract line for the award. When the award is submitted for approval, it's set to the default value, unless specified otherwise. The default value for BillPlanName is Award Bill Plan. |
| LaborFormatId | Long | The unique identifier of the labor format that's the source of the columns, text, and layout used to group labor items on an invoice line. |
| LaborFormat | String | Name of the format that's the source of the columns, text, and layout used to group labor items on an invoice line. The default value for the labor format is set to the value specified in the Manage Grants Business Unit Implementation Options page in the Setup and Maintenance work area. |
| EventFormatId | Long | The unique identifier of the format that's the source of the columns, text, and layout used to group events on an invoice line. |
| EventFormat | String | Name of the format that's the source of the columns, text, and layout used to group events on an invoice line. The default value for the event format is set to the value specified in the Manage Grants Business Unit Implementation Options page in the Setup and Maintenance work area. |
| NonLaborFormatId | Long | The unique identifier of the format that's the source of the columns, text, and layout used to group nonlabor items on an invoice line. |
| NonLaborFormat | String | Name of the format that's the source of the columns, text, and layout used to group nonlabor items on an invoice line. The default value for the nonlabor format is set to the value specified in the Manage Grants Business Unit Implementation Options page in the Setup and Maintenance work area. |
| RevenueMethodId | Long | The unique identifier of the method used to calculate revenue amounts for the revenue plan associated with the contract line for this award project. |
| RevenueMethod | String | Name of the method used to calculate revenue amounts for the revenue plan associated with the contract line for the award project. The default value for RevenueMethod is set to the value specified in the Manage Grants Business Unit Implementation Options page in the Setup and Maintenance work area. |
| PaymentTermsId | Long | The unique identifier of the terms used to schedule payments and calculate due dates, discount dates, and discount amounts for each invoice. |
| PaymentTerms | String | Terms used to schedule payments and calculate due dates, discount dates, and discount amounts for each invoice. The default value for PaymentTerms is set to the value specified in the Manage Grants Business Unit Implementation Options page in the Setup and Maintenance work area. |
| BillingCycleId | Long | Billing cycle represents the frequency at which invoices are created for this bill plan. |
| BillingCycle | String | Frequency at which invoices are created for the bill plan. The default value for BillingCycle is set to the value specified in the Manage Grants Business Unit Implementation Options page in the Setup and Maintenance work area. |
| InvoiceMethodId | Long | The unique identifier of the method to calculate invoice amounts for the bill plan associated with the contract line for this award project. |
| InvoiceMethod | String | Name of the method to calculate invoice amounts for the bill plan associated with the contract line for the award project. The default value for InvoiceMethod is set to the value specified in the Manage Grants Business Unit Implementation Options page in the Setup and Maintenance work area. |
| NetInvoiceFlag | Bool | Indicates whether net invoicing is set on the contract. |
| InvoiceGroupingCode | String | The code of the invoice grouping method. |
| InvoiceGrouping | String | The name of the invoice grouping method. |
| BillSetNumber | Decimal | The billing set number used to group invoices. |
| GeneratedInvoiceStatusCode | String | Lookup code for the Generated Invoice Status. Valid values are D,S,or R. |
| GeneratedInvoiceStatus | String | Status set during the Generate Invoice process. Valid values are Draft, Submitted, or Released. |
| TransactionTypeId | String | Unique identifier of the Receivables Transaction Type for invoices and credit memos. |
| TransactionTypeName | String | Receivables transaction type for invoices and credit memos. |
| BillToSiteUseId | String | Unique identifier of the bill-to customer site that's responsible for receiving and paying the invoice amount. |
| BillToSite | String | The customer site where the invoices are sent. |
| BillToContactId | String | Unique identifier of the bill-to customer contact person on a bill plan. |
| BillToContactEmail | String | The email of the contact person from the bill-to customer site. |
| BillToContactName | String | The contact person of the bill-to customer. |
| ShipToSiteUseId | String | The unique identifier of the ship-to site. |
| ShipToSite | String | The ship-to site. |
| FederalInvoiceFormat | String | This field stores and indicates the federal invoice format that's used for bill presentment. |
| FederalInvoiceFormatCode | String | The unique identifier of the federal invoice format that's used for bill presentment. |
| ContractTypeId | Long | Unique identifier of the contract type. |
| ContractStatus | String | Status of the award contract. Valid values include Draft, Active, or Pending Approval. Set it to Pending Approval when submitting an award for approval using the PATCH method. If set to Active, the award is moved to the Active status. |
| CreatedBy | String | The user that created the award. |
| CreationDate | Datetime | The date when the award was created. |
| LastUpdatedBy | String | The user that last updated the award. |
| LastUpdateDate | Datetime | The date when the award was last updated. |
| InstitutionComplianceApprovalDate | Date | Approval date for the conflict of interest indicator. |
| InstitutionComplianceFlag | Bool | The conflict of interest indicator that specifies whether the award project complies with Institution policy. |
| InstitutionComplianceReviewCompletedFlag | Bool | The conflict of interest indicator that specifies whether compliance review is completed. |
| FlowThroughFromDate | Date | Start date of the primary award, which is associated with the subaward. |
| FlowThroughToDate | Date | End date of the primary award, which is associated with the subaward. |
| FlowThroughFederalFlag | Bool | Indicates if the primary award is funded by a federal agency. Valid values are true and false. |
| FlowThroughPrimarySponsorId | Long | Primary sponsor of the flow through funds. |
| FlowThroughPrimarySponsorName | String | Name of the primary sponsor of the flow through funds. |
| FlowThroughPrimarySponsorNumber | String | Number of the primary sponsor of the flow through funds. |
| FlowThroughReferenceAwardName | String | Name of the primary award received from the primary sponsor, which is associated with the subaward. |
| FlowThroughAmount | Decimal | Amount funded to the primary award that's associated with the subaward. |
| PreviousAwardBUId | Long | The unique internal identifier of a previous award business unit. |
| PreviousAwardBUName | String | Name of the business unit of the previous award. |
| PreviousAwardId | Long | The unique internal identifier of a previous award. |
| PreviousAwardName | String | Name of the previous award. |
| PreviousAwardNumber | String | Number of the previous award. |
| PreviousAwardInProgressRenewFlag | Bool | Indicates if a previous award is being renewed. Valid values are true and false. |
| PreviousAwardAccomplishmentRenewFlag | Bool | Indicates if the renewal of a previous award is based on any accomplishment. Valid values are true and false. |
| IntellectualPropertyDescription | String | Description of the intellectual property. |
| IntellectualPropertyReportedFlag | Bool | Indicates if intellectual property such as patents and trademarks, is reported for the award. Valid values are true and false. |
| PreAwardSpendingAllowedFlag | Bool | Indicates whether preaward spending is allowed. |
| PreAwardGuaranteedFundingSource | String | The guaranteed source of funding for the award. |
| PreAwardDate | Date | Date before the start date of an award. |
| ValidateStatus | String | Indicator that specifies the validation status of an award. The values are C - Complete, E - Error, W - Warning, P - Processing and N - Not Validated. |
| AwardValidationNeededFlag | Bool | Indicator that specifies whether the award should be validated. |
| LastValidated | Datetime | The date when the award is last validated. |
| SourceTemplateId | Long | Unique identifier of the source award template. |
| SourceTemplateName | String | Name of the source award template. |
| SourceTemplateNumber | String | Number of the source award template. |
| CreatedFrom | String | The method of creating the award, for example, FROM_TEMPLATE or BLANK. |
| AwardSource | String | The source from which the award is created, for example, from the UI or the REST service. |
| DateChangeRequestId | Long | The identifier of the process submitted to update the award dates and budget period dates. |
| ShipToAccountId | String | The ship-to account identifier of the customer who receives the goods and services. |
| ShipToAccountNumber | String | The ship-to account number of the customer who receives the goods and services. |
| BillToAccountId | String | The bill-to account identifier of the customer who's responsible for receiving and paying the invoice. |
| BillToAccountNumber | String | The bill-to account number of the customer who's responsible for receiving and paying the invoice. |
| Finder | String | finder |
The Award Attachments resource is used to view attachments associated with the award.
| Name | Type | Description |
| AwardsAwardId [KEY] | Long | Identifier of the award. |
| AttachedDocumentId [KEY] | Long | The unique identifier of the attached document. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| DatatypeCode | String | A value that indicates the data type. |
| FileName | String | The file name of the attachment. |
| DmFolderPath | String | The folder path from which the attachment is created. |
| DmDocumentId | String | The document ID from which the attachment is created. |
| DmVersionNumber | String | The document version number from which the attachment is created. |
| Url | String | The URL of a web page type attachment. |
| CategoryName | String | The category of the attachment. |
| UserName | String | The login credentials of the user who created the attachment. |
| Uri | String | The URI of a Topology Manager type attachment. |
| FileUrl | String | The URI of the file. |
| UploadedText | String | The text content for a new text attachment. |
| UploadedFileContentType | String | The content type of the attachment. |
| UploadedFileLength | Long | The size of the attachment file. |
| UploadedFileName | String | The name to assign to a new attachment file. |
| ContentRepositoryFileShared | Bool | Indicates whether the attachment is shared |
| Title | String | The title of the attachment. |
| Description | String | The description of the attachment. |
| ErrorStatusCode | String | The error code, if any, for the attachment. |
| ErrorStatusMessage | String | The error message, if any, for the attachment. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| FileContents | String | The contents of the attachment. |
| ExpirationDate | Datetime | The expiration date of the contents in the attachment. |
| LastUpdatedByUserName | String | The user name who last updated the record. |
| CreatedByUserName | String | The user name who created the record. |
| AsyncTrackerId | String | Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. |
| FileWebImage | String | The base64 encoded image of the file displayed in .png format if the source is a convertible image. |
| DownloadInfo | String | JSON object represented as a string containing information used to programmatically retrieve a file attachment. |
| PostProcessingAction | String | The name of the action that can be performed after an attachment is uploaded. |
| AwardId | Long | awardid |
| Finder | String | finder |
The Award Budget Periods resource is used to view award budget period attributes such as budget period name, start date and end date.
| Name | Type | Description |
| AwardsAwardId [KEY] | Long | Identifier of the award. |
| AwardBudgetPeriodId [KEY] | Long | The unique identifier of the award budget period. |
| AwardId | Long | The unique internal identifier of the award. |
| BudgetPeriod | String | The time interval assigned to the award for which the budget, actual, commitment, and available amount are shown. |
| StartDate | Date | Start date of the budget period for the award. |
| EndDate | Date | End date of the budget period for the award. |
| CreatedBy | String | The user that created the award budget period. |
| CreationDate | Datetime | The date when the award budget period was created. |
| LastUpdateDate | Datetime | The date when the award budget period was last updated. |
| LastUpdatedBy | String | The user that last updated the award budget period. |
| Finder | String | finder |
The Award Certifications resource is used to view the certification attributes of the award.
| Name | Type | Description |
| AwardsAwardId [KEY] | Long | Identifier of the award. |
| AwardCertificationId [KEY] | Long | The unique identifier of the award certification. |
| AwardId | Long | Unique identifier of the award. |
| CertificationId | Long | The unique identifier of certification. |
| CertificationName | String | The name of the Award Certifications. |
| CertificationDate | Date | The date of Certification. |
| CertifiedByPersonId | Long | The unique ID of the person who gave the Certification. |
| CertifiedByPersonName | String | The name of the person who gave the Certification. |
| Status | String | The status of the Certification. |
| ApprovalDate | Date | The approval date of the Certification. |
| ExpirationDate | Date | The Expiration Date of the Certification. |
| ExpeditedReviewFlag | Bool | The Expediated Review indicator of the Certification. |
| Comments | String | The Award Certification Comment. |
| ExemptionNumber | String | Number that determines whether the research involves more than minimal risk and meets the criteria specified by federal regulations, and therefore, is exempt from protocol approvals. |
| AssuranceNumber | String | Assurance of compliance number. Indicates whether the organization complies with the regulations for the protection of animal or human research subjects. |
| FullReviewFlag | Bool | Indicates whether the award certification requires a full review. |
| CreatedBy | String | The user that created the award certification. |
| CreationDate | Datetime | The date when the award certification was created. |
| LastUpdatedBy | String | The user that last updated the award certification. |
| LastUpdateDate | Datetime | The date when the award certification was last updated. |
| Finder | String | finder |
The Award CFDAs resource is used to view the attributes specific to award federal domestic assistance program.
| Name | Type | Description |
| AwardsAwardId [KEY] | Long | Identifier of the award. |
| AwardCFDAId [KEY] | Long | The unique identifier of the assistance listing number associated with the award. |
| AwardId | Long | The unique internal identifier of the award. |
| Cfda | String | Number used to identify the nature of federal funding received in the form of award from sponsors. |
| ProgramTitle | String | Name of the assistance listing number. |
| CreationDate | Datetime | The date when the award ALN was created. |
| CreatedBy | String | The user that created the award ALN. |
| LastUpdateDate | Datetime | The date when the award ALN was last updated. |
| LastUpdatedBy | String | The user that last updated the award ALN. |
| Finder | String | finder |
The Award Department Credits resource is used to view the organization credit attributes for the award.
| Name | Type | Description |
| AwardsAwardId [KEY] | Long | Identifier of the award. |
| AwardOrganizationCreditId [KEY] | Long | The unique Identifier of Award Organization Credit. |
| AwardId | Long | The unique internal identifier of the award. |
| OrganizationId | Long | The unique internal identifier of the Organization. |
| OrganizationName | String | The name of the Organization. |
| CreditPercentage | Double | The credit percentage value of Award Organization Credit. |
| CreatedBy | String | The user that created the award department credit. |
| CreationDate | Datetime | The date when the award department credit was created. |
| LastUpdatedBy | String | The user that last updated the award department credit. |
| LastUpdateDate | Datetime | The date when the award department was last updated. |
| Finder | String | finder |
The Award Errors resource is used to view validation errors associated with the award.
| Name | Type | Description |
| AwardsAwardId [KEY] | Long | Identifier of the award. |
| AwardId | Long | The unique internal identifier of the award. |
| AwardErrorId [KEY] | Long | The unique identifier of the award error. |
| ErrorType | String | The identifier of the error type. |
| ErrorCode | String | The identifier of the error code. |
| MessageText | String | The error message to be displayed. |
| CreatedBy | String | The user that created the award error. |
| CreationDate | Datetime | The date when the award error was created. |
| LastUpdateDate | Datetime | The date when the award error was last updated. |
| LastUpdatedBy | String | The user that last updated the award error. |
| MessageUserDetails | String | Additional information about the cause and resolution of the error. |
| Finder | String | finder |
The Award Fundings resource is used to view award funding attributes such as funding issue type and funding issue name.
| Name | Type | Description |
| AwardsAwardId [KEY] | Long | Identifier of the award. |
| AwardFundingId [KEY] | Long | Unique identifier of the award funding. |
| AwardFundingSourceId | Long | Unique identifier of the award funding source. |
| AwardId | Long | Unique identifier of the award. |
| BudgetPeriod | String | Name of the budget period for the award. |
| BudgetPeriodId | Long | Unique identifier of the award budget period. |
| FundingSourceId | Long | Unique identifier of the funding source. |
| DirectFundingAmount | Decimal | Total funding amount granted for the award. |
| IndirectFundingAmount | Decimal | Burden amount granted by the sponsor as part of funding amount. |
| CurrencyCode | String | Currency code representing the award currency. The currency code is a three-letter ISO code associated with a currency. |
| FundingIssueDate | Date | Date when the funding was issued. |
| FundingIssueDescription | String | Description of the funding issue. |
| FundingIssueNumber | String | Number of the funding issue. |
| FundingIssueType | String | Type code of funding issued, for example BASE or SUPPLEMENT. |
| FundingIssueTypeName | String | Type of funding issued, for example Base or Supplement. |
| FundingSourceName | String | Name of the funding source. |
| FundingSourceNumber | String | Number of the funding source, entered by the user. |
| CreatedBy | String | The user that created the award funding. |
| CreationDate | Datetime | The date when the award funding was created. |
| LastUpdateDate | Datetime | The date when the award funding was last updated. |
| LastUpdatedBy | String | The user that last updated the award funding. |
| Finder | String | finder |
The Award Project Fundings resource is used to view funding allocation attributes for the award project.
| Name | Type | Description |
| AwardsAwardId [KEY] | Long | Identifier of the award. |
| AwardfundingAwardFundingId [KEY] | Long | Identifier of the award funding. |
| AwardProjectFundingId [KEY] | Long | Unique identifier of the award project funding allocation. |
| AwardId | Long | Unique identifier of the award. |
| AwardProjectLinkId | Long | Unique identifier of the award project. |
| FundingAmount | Decimal | Funding amount allocated to the award project. |
| CurrencyCode | String | Currency code representing the award currency. The currency code is a three-letter ISO code associated with a currency. |
| ProjectName | String | Name of the project to which the funding is allocated. |
| ProjectNumber | String | Number of the project to which the funding is allocated. |
| ProjectId | Long | Unique identifier of the award project. |
| CreatedBy | String | The user that created the award project funding allocation. |
| CreationDate | Datetime | The date when the award project funding allocation was created. |
| LastUpdateDate | Datetime | The date when the award project funding allocation was last updated. |
| LastUpdatedBy | String | The user that last updated the award project funding allocation. |
| Finder | String | finder |
The Award Funding Sources resource is used to view the attributes used to create or update a funding source for the award.
| Name | Type | Description |
| AwardsAwardId [KEY] | Long | Identifier of the award. |
| AwardFundingSourceSourceId [KEY] | Long | The unique identifier of the award funding source association. |
| AwardId | Long | The unique identifier of the award. |
| FundingSourceId | Long | The unique identifier of the selected funding source. |
| FundingSourceName | String | The name of the selected funding source. |
| FundingSourceNumber | String | The unique number associated with the selected funding source. |
| RequiredBySponsor | String | Indicates whether the selected funding source is marked as required by sponsor. Valid values are N and Y. |
| ApprovalPersonId | Long | The unique identifier of the person who approved the selected funding source. |
| ApprovalPersonName | String | The name of the person who approved the selected funding source. |
| ApprovalPersonNumber | String | The number of the person who approved the selected funding source. |
| ApprovalDate | Date | The approval date of the selected award funding source. |
| Type | String | The type of the selected award funding source. |
| CreatedBy | String | The user that created the award funding source. |
| CreationDate | Datetime | The date when the award funding source was created. |
| LastUpdatedBy | String | The user that last updated the award funding source. |
| LastUpdateDate | Datetime | The date when the award funding source was last updated. |
| Finder | String | finder |
A list of all the descriptive flexfields available for awards.
| Name | Type | Description |
| AwardsAwardId [KEY] | Long | Identifier of the award. |
| Id [KEY] | Long | System-generated primary key column. |
| AdditionalInformation | String | Additional information |
| FundCode | String | FundCode |
| _FLEX_Context | String | Structure definition of the Award Descriptive Flexfield. |
| _FLEX_Context_DisplayValue | String | Context Segment |
| AwardId | Long | awardid |
| Finder | String | finder |
The Award Keywords resource is used to view the keyword attributes for the award.
| Name | Type | Description |
| AwardsAwardId [KEY] | Long | Identifier of the award. |
| AwardKeywordId [KEY] | Long | The unique identifier for Award Keyword. |
| AwardId | Long | Unique identifier of the award. |
| KeywordId | Long | The unique identifier for Keyword. |
| KeywordName | String | The name of the keyword. |
| CreatedBy | String | The user that created the award keyword. |
| CreationDate | Datetime | The date when the award keyword was created. |
| LastUpdatedBy | String | The user that last updated the award keyword |
| LastUpdateDate | Datetime | The date when the award keyword was last updated. |
| Finder | String | finder |
The Award Personnel resource is used to view the award personnel attributes such as person name, role.
| Name | Type | Description |
| AwardsAwardId [KEY] | Long | Identifier of the award. |
| AwardPersonnelId [KEY] | Long | The unique identifier for award personnel association. |
| AwardId | Long | The unique identifier of the award. |
| PersonName | String | Name of the person in HCM. |
| PersonNumber | String | Number of the person in Human Resources. |
| PhoneNumber | String | Phone number of the person selected from Human Resources to administer and manage awards. |
| EmailAddress | String | Email address for the selected person from Human Resources. |
| JobTitle | String | Job title of the person selected from Human Resources. |
| OrganizationName | String | Name of the Organization of the selected person. |
| PersonId | Long | The unique identifier of the selected internal person from Human Resources. |
| PartyId | Long | The unique identifier of the selected external person. |
| InternalFlag | Bool | Indicates whether the selected person is internal or external. |
| RoleId | Long | Unique identifier of the selected role of the person. |
| Role | String | The role performed by the selected person. |
| StartDate | Date | Start date of the duration for the award person association. |
| EndDate | Date | End date of the duration for the award person association. |
| CreditPercent | Double | Credit percentage value associate for the selected person. |
| CreatedBy | String | The user that created the award personnel. |
| CreationDate | Datetime | The date when the award personnel was created. |
| LastUpdatedBy | String | The user that last updated the award personnel. |
| LastUpdateDate | Datetime | The date when the award personnel was last updated. |
| Finder | String | finder |
A list of all the descriptive flexfields available for award personnel.
| Name | Type | Description |
| AwardsAwardId [KEY] | Long | Identifier of the award. |
| AwardpersonnelAwardPersonnelId [KEY] | Long | Identifier of the award personnel. |
| Id [KEY] | Long | The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId= |
| _FLEX_ValidationDate | Date | Validation date |
| _FLEX_Context | String | Structure definition of the Award Personnel Descriptive Flexfield. |
| _FLEX_NumOfSegments | Int | _FLEX_NumOfSegments |
| _FLEX_NumOfVisibleSegments | Int | _FLEX_NumOfVisibleSegments |
| AwardId | Long | awardid |
| Finder | String | finder |
The Award Projects resource is used to view the attributes of an award project, such as project name and project number.
| Name | Type | Description |
| AwardsAwardId [KEY] | Long | Identifier of the award. |
| AwardProjectId [KEY] | Long | Unique identifier of the award project. |
| AwardId | Long | Unique identifier of the award. |
| AwardName | String | Name of the award. |
| AwardNumber | String | Number of the award. |
| ProjectId | Long | Unique identifier of the award project. |
| ProjectName | String | Name of the project associated to the award. |
| ProjectNumber | String | Number of the project associated to the award. |
| BurdenScheduleId | Long | The unique identifier of the burden schedule. |
| BurdenScheduleName | String | Name of the burden schedule assigned at the award project level. |
| BurdenScheduleFixedDate | Date | Specific date used to determine the right set of burden multipliers for the award project. |
| CurrencyCode | String | Currency code representing the award project currency. The currency code is a three-letter ISO code. |
| CreatedBy | String | The user that created the award project. |
| LastUpdateDate | Datetime | The date when the award project was last updated. |
| CreationDate | Datetime | The date when the award project was created. |
| LastUpdatedBy | String | The user that last updated the award project. |
| Finder | String | finder |
The Award Project Attachments resource is used to view attachments associated with the award project.
| Name | Type | Description |
| AwardsAwardId [KEY] | Long | Identifier of the award. |
| AwardprojectAwardProjectId [KEY] | Long | Identifier of the award project. |
| AttachedDocumentId [KEY] | Long | The unique identifier of the attached document. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| DatatypeCode | String | A value that indicates the data type. |
| FileName | String | The file name of the attachment. |
| DmFolderPath | String | The folder path from which the attachment is created. |
| DmDocumentId | String | The document ID from which the attachment is created. |
| DmVersionNumber | String | The document version number from which the attachment is created. |
| Url | String | The URL of a web page type attachment. |
| CategoryName | String | The category of the attachment. |
| UserName | String | The login credentials of the user who created the attachment. |
| Uri | String | The URI of a Topology Manager type attachment. |
| FileUrl | String | The URI of the file. |
| UploadedText | String | The text content for a new text attachment. |
| UploadedFileContentType | String | The content type of the attachment. |
| UploadedFileLength | Long | The size of the attachment file. |
| UploadedFileName | String | The name to assign to a new attachment file. |
| ContentRepositoryFileShared | Bool | Indicates whether the attachment is shared |
| Title | String | The title of the attachment. |
| Description | String | The description of the attachment. |
| ErrorStatusCode | String | The error code, if any, for the attachment. |
| ErrorStatusMessage | String | The error message, if any, for the attachment. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| FileContents | String | The contents of the attachment. |
| ExpirationDate | Datetime | The expiration date of the contents in the attachment. |
| LastUpdatedByUserName | String | The user name who last updated the record. |
| CreatedByUserName | String | The user name who created the record. |
| AsyncTrackerId | String | Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. |
| FileWebImage | String | The base64 encoded image of the file displayed in .png format if the source is a convertible image. |
| DownloadInfo | String | JSON object represented as a string containing information used to programmatically retrieve a file attachment. |
| PostProcessingAction | String | The name of the action that can be performed after an attachment is uploaded. |
| AwardId | Long | awardid |
| Finder | String | finder |
The Award Project Certifications resource is used to view certification attributes of the award project.
| Name | Type | Description |
| AwardsAwardId [KEY] | Long | Identifier of the award. |
| AwardprojectAwardProjectId [KEY] | Long | Identifier of the award project. |
| AwardProjectCertificationId [KEY] | Long | Unique identifier of the certification assigned to the award or award project. |
| CertificationName | String | Name of the award project certification. |
| CertificationDate | Date | Date when the certification for the award project was performed. |
| AssuranceNumber | String | Assurance of compliance number. |
| ApprovalDate | Date | Date when the award project certification was approved. |
| Comments | String | Comments for the award project certification. |
| CertificationStatus | String | Status of the award project certification. |
| CertifiedBy | Long | Unique identifier of the person certifying the award project certification. |
| FullReviewFlag | Bool | Indicates if the award project certification requires a full review. |
| ExemptionNumber | String | Number that determines whether the research involves no more than minimal risk and meets criteria specified by federal regulations, and is therefore exempt from protocol approvals. |
| ExpeditedReviewFlag | Bool | Indicates whether the award project certification requires an expedited review. |
| CertifiedByPersonName | String | Person certifying the award project certification. |
| ExpirationDate | Date | Date when the award project certification expires. |
| AwardId | Long | Unique identifier of the award. |
| CertificationId | Long | Unique identifier of the certification. |
| AwdProjectLnkId | Long | Unique identifier of the award project. |
| LastUpdateDate | Datetime | The date when the award project certification was last updated. |
| LastUpdatedBy | String | The user that last updated the award project certification. |
| CreatedBy | String | The user that created the award project certification. |
| CreationDate | Datetime | The date when the award project certification was created. |
| Finder | String | finder |
The Award Project Organization Credits resource is used to view organization credit attributes for the award project.
| Name | Type | Description |
| AwardsAwardId [KEY] | Long | Identifier of the award. |
| AwardprojectAwardProjectId [KEY] | Long | Identifier of the award project. |
| AwardOrganizationCreditId [KEY] | Long | Unique identifier of the organization credit assigned to the award or award project. |
| OrganizationName | String | Name of the organization that receives credit. |
| CreditPercentage | Double | Percentage of credit that the organization receives. |
| AwardId | Long | Unique identifier of the award. |
| OrganizationId | Long | The unique identifier of the organization. |
| CreatedBy | String | The user that created the award project organization credit. |
| CreationDate | Datetime | The date when the award project organization credit was created. |
| LastUpdateDate | Datetime | The date when the award project organization credit was last updated. |
| LastUpdatedBy | String | The user that last updated the award project organization credit. |
| Finder | String | finder |
A list of all the descriptive flexfields available for award projects.
| Name | Type | Description |
| AwardsAwardId [KEY] | Long | Identifier of the award. |
| AwardprojectAwardProjectId [KEY] | Long | Identifier of the award project. |
| Id [KEY] | Long | The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId= |
| _FLEX_Context | String | Structure definition of the Award Descriptive Flexfield. |
| _FLEX_Context_DisplayValue | String | Context Segment |
| AwardId | Long | awardid |
| Finder | String | finder |
The Award Project Funding Sources resource is used to view funding sources of the award project.
| Name | Type | Description |
| AwardsAwardId [KEY] | Long | Identifier of the award. |
| AwardprojectAwardProjectId [KEY] | Long | Identifier of the award project. |
| AwardProjectFundingSourceId [KEY] | Long | Unique identifier of the funding source assignment to the award project. |
| FundingSourceName | String | Name of the funding source. |
| FundingSourceNumber | String | Number of the funding source, entered by the user. |
| FundingSourceType | String | Type of the funding source. |
| AwardFundingSourceId | Long | Unique identifier of the award funding source. |
| FundingSourceId | Long | Unique identifier of the funding source. |
| AwardId | Long | Unique identifier of the award. |
| CreatedBy | String | The user that created the award project funding source. |
| CreationDate | Datetime | The date when the award project funding source was created. |
| LastUpdateDate | Datetime | The date when the award project funding source was last updated. |
| LastUpdatedBy | String | The user that last updated the award project funding source. |
| InternalFundingSourceBurdeningFlag | Bool | Enable or disable Burdening for the internal funding source. |
| Finder | String | finder |
The Award Project Keywords resource is used to view keyword attributes for the award project.
| Name | Type | Description |
| AwardsAwardId [KEY] | Long | Identifier of the award. |
| AwardprojectAwardProjectId [KEY] | Long | Identifier of the award project. |
| AwardProjectKeywordId [KEY] | Long | Unique identifier of the keyword assigned to the award or award project. |
| AwardId | Long | Unique identifier of the award. |
| AwardProjectLinkId | Long | Unique identifier of the award project. |
| KeywordId | Long | Unique identifier of the keyword. |
| KeywordName | String | Name of the keyword used to describe and track the subject of the award or award project. |
| Description | String | Description of the keyword associated with the award project. |
| CreatedBy | String | The user that created the award project keyword. |
| CreationDate | Datetime | The date when the award project keyword was created. |
| LastUpdateDate | Datetime | The date when the award project keyword was last updated. |
| LastUpdatedBy | String | The user that last updated the award project keyword. |
| Finder | String | finder |
The Award Project Override Burden Schedules resource is used to view the override burden schedule assigned to the award project.
| Name | Type | Description |
| AwardsAwardId [KEY] | Long | Identifier of the award. |
| AwardprojectAwardProjectId [KEY] | Long | Identifier of the award project. |
| BurdenScheduleId [KEY] | Long | Identifier of the burden schedule. |
| AwardId | Long | Identifier of the award. |
| AwardProjectId | Long | Identifier of the award project. |
| BurdenScheduleName | String | The name of a burden schedule which is set of burden multipliers that is maintained for use across projects. |
| BurdenScheduleDescription | String | The description of a burden schedule which is set of burden multipliers that is maintained for use across projects. |
| DefaultBurdenStructureName | String | The name of a burden structure which is assigned as the default burden structure on a burden schedule. A burden structure determines how cost bases are grouped and what types of burden costs are applied to the cost bases. |
| DefaultOrganizationHierarchyName | String | A structure that determines the relationships between organizations like which organizations are subordinate to other organizations. This hierarchy is the default hierarchy for burden schedule versions. |
| DefaultOrganizationHierarchyCode | String | The internal code of the structure that determines the relationships between organizations. |
| HierarchyVersionName | String | The version of the organization hierarchy that is assigned to the burden schedule. |
| HierarchyVersionId | String | The identifier of the version of the organization hierarchy that is assigned to the burden schedule. |
| HierarchyStartOrganizationName | String | The top-level organization of the organization hierarchy that is assigned to the burden schedule. |
| HierarchyStartOrganizationId | Long | The identifier of the top-level organization of the organization hierarchy that is assigned to the burden schedule. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| OrganizationClassificationName | String | The name for a group of organizations to classify them, for example, to allow to own the enterprise's projects or project tasks, or to incur costs on the enterprise's projects or project tasks. |
| OrganizationClassificationCode | String | The internal code for a group of organizations to classify them, for example, to allow to own the enterprise's projects or project tasks, or to incur costs on the enterprise's projects or project tasks. |
| Finder | String | finder |
The Versions resource is used to view versions for the override burden schedule assigned to the award project.
| Name | Type | Description |
| AwardsAwardId [KEY] | Long | Identifier of the award. |
| AwardprojectAwardProjectId [KEY] | Long | Identifier of the award project. |
| AwardprojectoverrideburdenschedulesBurdenScheduleId [KEY] | Long | Identifier of the burden schedule. |
| VersionName | String | A version of a burden schedule is a set of burden multipliers. One burden schedule can have many versions. |
| VersionId [KEY] | Long | The identifier of the version of a set of burden multipliers. |
| BurdenScheduleId | Long | Identifier of the burden schedule. |
| VersionStartDate | Date | The date from which a burden schedule version is active. |
| VersionEndDate | Date | The date after which a burden schedule version is no longer active. |
| BurdenStructureName | String | The name of a burden structure which is assigned to a burden schedule version. A burden structure determines how cost bases are grouped and what types of burden costs are applied to the cost bases. |
| OrganizationHierarchyName | String | A structure that determines the relationships between organizations like which organizations are subordinate to other organizations. |
| OrganizationHierarchyCode | String | The internal code of the structure that determines the relationships between organizations. |
| HierarchyVersionName | String | The version of the organization hierarchy that is assigned to the burden schedule version. |
| HierarchyVersionId | String | The identifier of the version of the organization hierarchy that is assigned to the burden schedule version. |
| HierarchyStartOrganizationName | String | The top-level organization of the organization hierarchy that is assigned to the burden schedule version. |
| HierarchyStartOrganizationId | Long | The identifier of the top-level organization of the organization hierarchy that is assigned to the burden schedule version. |
| HoldVersionFromBuildFlag | Bool | Indicates that the build burden schedule process will skip the schedule version even if it has been built. |
| BuildStatus | String | The current state of a burden schedule version in relation to build processing. The status can be New, Active, or Active with Unbuilt Changes. |
| LastActiveBuildDate | Date | The date on which a burden schedule version most recently underwent successful build processing. Because the processing was successful, the multipliers on the version are available for use. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| OrganizationClassificationName | String | The name for a group of organizations to classify them, for example, to allow to own the enterprise's projects or project tasks, or to incur costs on the enterprise's projects or project tasks. |
| OrganizationClassificationCode | String | The internal code for a group of organizations to classify them, for example, to allow to own the enterprise's projects or project tasks, or to incur costs on the enterprise's projects or project tasks. |
| Multipliers | String | The Multipliers resource is used to view multipliers for the override burden schedule assigned to the award project. |
| AwardId | Long | awardid |
| Finder | String | finder |
The Award Project Personnel resource is used to view personnel references associated with the award project
| Name | Type | Description |
| AwardsAwardId [KEY] | Long | Identifier of the award. |
| AwardprojectAwardProjectId [KEY] | Long | Identifier of the award project. |
| AwardProjectPersonnelId [KEY] | Long | Unique identifier of the project personnel. |
| PersonName | String | Name of the person assigned to the award project. |
| PersonNumber | String | Number of the person selected from Human Resources to administer and manage awards. |
| PhoneNumber | String | Phone number of the person selected from Human Resources to administer and manage awards. |
| EmailAddress | String | E-mail of the person selected from Human Resources to administer and manage awards. |
| JobTitle | String | Primary job profile of the person selected from Human Resources to administer and manage awards. |
| OrganizationName | String | Primary organization of the person selected from Human Resources to administer and manage awards. |
| CreditPercentage | Double | Percentage of credit that the person assigned to the award project receives. |
| StartDate | Date | Start date for the person assigned to the award project. |
| EndDate | Date | End date for the person assigned to the award project. |
| InternalFlag | Bool | Indicates whether the person is internal, for example, an employee or external, for example, customer contact. |
| AwardId | Long | Unique identifier of the award. |
| AwdProjectLnkId | Long | Unique identifier of the award project. |
| PersonId | Long | The unique identifier of the person in human resources. |
| PartyId | Long | The unique identifier of the party in Oracle Fusion Trading Community Architecture. |
| RoleId | Long | Unique identifier of the role for the internal person assigned to the award project. |
| RoleName | String | Role for the internal person assigned to the award project. |
| CreatedBy | String | The user that created the award project personnel. |
| CreationDate | Datetime | The date when the award project personnel was created. |
| LastUpdateDate | Datetime | The date when the award project personnel was last updated. |
| LastUpdatedBy | String | The user that last updated the award project personnel. |
| Finder | String | finder |
A list of all the descriptive flexfields available for award project personnel.
| Name | Type | Description |
| AwardsAwardId [KEY] | Long | Identifier of the award. |
| AwardprojectAwardProjectId [KEY] | Long | Identifier of the award project. |
| AwardprojectpersonnelAwardProjectPersonnelId [KEY] | Long | Identifier of the award project personnel. |
| Id [KEY] | Long | The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId= |
| _FLEX_ValidationDate | Date | Validation date. |
| _FLEX_Context | String | Structure definition of the Award Personnel Descriptive Flexfield. |
| _FLEX_NumOfSegments | Int | _FLEX_NumOfSegments |
| _FLEX_NumOfVisibleSegments | Int | _FLEX_NumOfVisibleSegments |
| AwardId | Long | awardid |
| Finder | String | finder |
The Award Project Reference Types resource is used to view attributes associated with the award project reference type.
| Name | Type | Description |
| AwardsAwardId [KEY] | Long | Identifier of the award. |
| AwardprojectAwardProjectId [KEY] | Long | Identifier of the award project. |
| AwardProjectReferenceId [KEY] | Long | Unique identifier of the reference type assigned to the award. |
| ReferenceTypeName | String | Name of the reference type assigned to an award project for identification purposes. For example, Proposal Number. |
| ReferenceValue | String | Value of the reference type, for example, the related proposal number. |
| Description | String | Description of the reference type assigned to an award project. |
| ReferenceComment | String | Comments for the reference type or value assigned to the award. |
| ReferenceId | Long | Unique identifier of the reference type. |
| AwardId | Long | Unique identifier of the award. |
| CreatedBy | String | The user that created the award project reference. |
| CreationDate | Datetime | The date when the award project reference was created. |
| LastUpdateDate | Datetime | The date when the award project reference was last updated. |
| LastUpdatedBy | String | The user that last updated the award project reference. |
| Finder | String | finder |
The Award Project Task Burden Schedules resource is used to view the task burden schedule of the award project.
| Name | Type | Description |
| AwardsAwardId [KEY] | Long | Identifier of the award. |
| AwardprojectAwardProjectId [KEY] | Long | Identifier of the award project. |
| AwardProjectScheduleId [KEY] | Long | Unique identifier of the project schedule |
| BurdenScheduleName | String | Name of the burden schedule |
| BurdenScheduleFixedDate | Date | Fixed date of the burden schedule |
| AwardId | Long | Unique identifier of the award. |
| BurdenScheduleId | Long | The unique identifier of the burden schedule specified at the project or project task of an award. |
| ProjectId | Long | Unique identifier of the project. |
| TaskId | Long | Unique identifier of the task. |
| TaskName | String | Name of the task to which the funding is allocated. |
| TaskNumber | String | Number of the task to which the funding is allocated. |
| CreatedBy | String | The user that created the award project burden schedule |
| CreationDate | Datetime | The date when the award project burden schedule was created. |
| LastUpdateDate | Datetime | The date when the award project burden schedule was last updated. |
| LastUpdatedBy | String | The user that last updated the award project burden schedule. |
| Finder | String | finder |
The Award References resource is used to view the attributes specific to award reference type.
| Name | Type | Description |
| AwardsAwardId [KEY] | Long | Identifier of the award. |
| AwardReferenceId [KEY] | Long | The unique identifier of the award reference. |
| AwardId | Long | Unique identifier of the award. |
| ReferenceId | Long | Unique identifier of the selected reference. |
| ReferenceTypeName | String | The name of the type of the selected reference. |
| ReferenceValue | String | The value set for the reference. |
| ReferenceComment | String | Comments given for the award reference. |
| Description | String | Description for the award reference. |
| CreatedBy | String | The user that created the award reference. |
| CreationDate | Datetime | The date when the award reference was created. |
| LastUpdatedBy | String | The user that last updated the award reference. |
| LastUpdateDate | Datetime | The date when the award reference was last updated. |
| Finder | String | finder |
The Award Terms and Conditions resource is used to view the attributes of the terms and conditions associated to the award.
| Name | Type | Description |
| AwardsAwardId [KEY] | Long | Identifier of the award. |
| AwardTermsId [KEY] | Long | The unique identifier of award terms and conditions. |
| AwardId | Long | The unique identifier of Award. |
| TermsCategoryId | Long | The unique identifier of term and conditions category. |
| TermsCategoryName | String | The terms and conditions category name. |
| TermsId | Long | Unique identifier of terms and conditions. |
| TermsName | String | Terms and conditions name. |
| TermsOperator | String | Terms and conditions operator. |
| TermsValue | String | Terms and conditions term value. |
| Description | String | Award terms and conditions description. |
| CreatedBy | String | The user that created the award terms. |
| CreationDate | Datetime | The date when the award terms was created. |
| LastUpdatedBy | String | The user that last updated the award terms. |
| LastUpdateDate | Datetime | The date when the award term was last updated. |
| Finder | String | finder |
The Awards By Projects LOV resource is used to view the awards for a particular project. This service data object contains a list of awards with details such as award id, award name, and award number.
| Name | Type | Description |
| AwardId | Long | The unique internal identifier of the award. |
| ProjectId | Long | The unique internal identifier of the project. |
| AwardName | String | Name of the award. |
| AwardNumber | String | Number of the award. |
The Award Templates LOV resource is used to view all or a filtered set of award templates. This object includes attributes which are used to display one or more attributes of one or many award templates.
| Name | Type | Description |
| TemplateId [KEY] | Long | The identifier of the award template. |
| TemplateNumber | String | The number of the award template. |
| TemplateName | String | The name of the award template. |
| StartDateActive | Date | The active start date of the award template. |
| EndDateActive | Date | The active end date of the award template. |
| Description | String | The description of the award template. |
| CurrencyCode | String | The currency code of the award template. |
| BudgetPeriodCount | Int | The count of the budget period of the award template. |
| BudgetPeriodFrequency | String | The frequency of the budget period of the award template. |
| BudgetPeriodFormat | String | The format of the budget period of the award template. |
| BudgetPeriodPrefix | String | The prefix of the budget period of the award template. |
| BudgetPeriodSeparator | String | The separator of the budget period of the award template. |
| ContractApprovalFlag | Bool | Indicates whether the award template contract should be sent for approval. |
| DefaultTemplateFlag | Bool | Indicates whether the award template should be used as the default in the Quick Create Award process. |
| LegalEntityId | Long | The identifier of the legal entity of the award template. |
| LocEnabledFlag | Bool | Indicates whether the award template is enabled for letter of credit billing. |
| TemplateSource | String | The source of the award template. |
| AwardType | String | The award type of the award template. |
| AwardPurposeCode | String | The purpose code of the award template. |
| SponsorAwardNumber | String | The sponsor award number of the award template. |
| SponsorId | Long | The identifier of the sponsor of the award template. |
| FederalFlag | Bool | Indicates whether the award template is from a federal sponsor. |
| BudgetaryControlFlag | Bool | Indicates whether the award template is enabled for budgetary control. |
| ProjectTemplateId | Long | The identifier of the project template of the award template. |
| ProjectTemplateName | String | The name of the project template of the award template. |
| ProjectTemplateNumber | String | The number of the project template of the award template. |
| PartyId | Long | The identifier of the party of the award template. |
| PartyName | String | The name of the party of the award template. |
| BusinessUnitId | Long | The identifier of the business unit of the award template. |
| BusinessUnitName | String | The name of the business unit of the award template. |
| AwardOwningOrgId | Long | The identifier of the organization that owns the award template. |
| AwardOwningOrgName | String | The name of the organization that owns the award template. |
| MulticurrencyFlag | Bool | Indicates whether the award template is set for multiple currencies. |
| DefaultContractTypeId | Long | The identifier of the default contract type of the award template. |
| DefaultContractTypeName | String | The name of the default contract type of the award template. |
| DefaultInterCompanyFlag | Bool | Indicates whether the award template is setup for intercompany transactions. |
| PrincipalInvestigatorName | String | The name of the principal investigator of the award template. |
| PrincipalInvestigatorId | Long | The identifier of the principal investigator of the award template. |
| CostShareFlag | Bool | Indicates whether the award template has a cost share component. |
| Finder | String | finder |
| SearchTerm | String | searchterm |
The LOV for Burden Schedules resource is used to view a list of values of burden schedules. This object includes attributes which are used to store values of a burden schedule.
| Name | Type | Description |
| BurdenScheduleId [KEY] | Long | Identifier of the burden schedule. |
| Name | String | Name of the burden schedule which is also referred to as a standard burden schedule. A burden schedule is a set of burden multipliers that's maintained for use across projects. |
| Description | String | Description of the burden schedule which is also referred to as a standard burden schedule. A burden schedule is a set of burden multipliers that's maintained for use across projects. |
| Type | String | The burden schedule type, either firm or provisional, assigned to the set of multipliers. |
| FromDate | Date | The date from which a burden schedule is active. |
| ToDate | Date | The date after which a burden schedule is no longer active. |
| Finder | String | finder |
| UserDate | Date | userdate |
The Change Order resource is used to create, view, update, or delete a change order. A change order is an event, action, or condition that affects the scope, value, or duration of a project or task.
| Name | Type | Description |
| CancelDate | Date | Date when the change order was canceled. Application calculated field. |
| ChangeDocumentId [KEY] | Long | Unique identifier of a project change order. Mandatory for PATCH operation. |
| CancelReason | String | User comments for cancelling the change order. Mandatory for cancelling the change order. |
| CancelType | String | The code of the reason for canceling the change order. Mandatory for cancelling the change order. Valid values are DUPLICATE, INSUFFICIENT_INFORMATION, NO_LONGER_REQUIRED, OTHER, and REJECTED. |
| Comments | String | User comments for the change order. |
| CreatorId | Long | Identifier of the creator for a change order. Mandatory for POST operation if Creator Name or Creator Email is not provided. |
| Description | String | Description of the change order. |
| ImpactIfNotImpl | String | Impact if the change is not implemented. |
| Justification | String | Justification for a change order. |
| Name | String | Name of the change order. |
| OwnerId | Long | Unique identifier of the owner of change order. The default value is creator of the change order. |
| Priority | String | The code of the priority of a change order. Valid values are HIGH, LOW, and MEDIUM. The default value is MEDIUM. |
| ProjectId | Long | Unique identifier of the project for which change document is created. |
| Reason | String | The code of the reason for which the change order is created, rejected, and canceled. Valid values are BUDGET_REVISION, CLIENT_SCOPE_CHANGES, CONTRACT_MODIFICATION, DESIGN_CHANGES, GENERAL, OTHER, SCHEDULE_MODIFICATION, and SCOPE_REVISION. The default value is GENERAL. |
| Stage | String | The code of the current stage of a change order. Valid values are CREATE, IMPACT_ANALYSIS, APPROVAL, CLOSE, REVIEW, IMPLEMENTATION. The default value is CREATE. |
| Status | String | The code of the current status of a change order. Status is derived from stage of the change order. You need to mention status only when you want to cancel the change order. Valid value is CANCELED. |
| OwnerName | String | Name of the owner of a change order. The default value is the creator name of the change order. |
| OwnerEmail | String | Email of the owner of a change order. The default value is the creator email of the change order. |
| ProjectName | String | Name of the project for which change order is created. |
| ChangeDocumentNumber | Long | Unique number of the change order. Application calculated field. |
| CreatorName | String | Name of the creator of a change order. |
| CreatorEmail | String | Email of the creator of a change order. |
| CreationDate | Datetime | Date when the change order was created. Application calculated. |
| Customer | String | Customer of the project for which change order is created. If project is specified for the change order, customer is defaulted to project customer. |
| TaskId | Long | Unique identifier of the task for which change document is created. |
| TaskName | String | Name of the task for which change order is created. |
| TaskNumber | String | Unique number of the task associated with a specific project for which change order is created. |
| Bind_ChangeDocumentId | String | bind_changedocumentid |
| Bind_ChangeDocumentNumber | String | bind_changedocumentnumber |
| Bind_CreatorId | String | bind_creatorid |
| Bind_Name | String | bind_name |
| Bind_OwnerId | String | bind_ownerid |
| Bind_ProjectId | String | bind_projectid |
| Bind_Stage | String | bind_stage |
| Bind_Status | String | bind_status |
| Bind_TaskId | Long | bind_taskid |
| Finder | String | finder |
The Change Impacts resource is used to create, view, update, or delete the impacts due to the respective change order.
| Name | Type | Description |
| ChangeOrdersChangeDocumentId [KEY] | Long | Unique identifier of a project change order. |
| ImpactId [KEY] | Long | Unique identifier of the impact to the change order. |
| ImpactOwnerId | Long | Resource identifier of the impact owner. |
| Area | String | The code of the impact area of a change order. Valid values are BUDGET_AND_FORECAST, CONTRACTS, OTHERS, PROJECT_PLAN, REQUIREMENTS, and RESOURCES. The default value is PROJECT_PLAN. |
| EffortsInHours | Decimal | Effort required in hours to implement the change requested. |
| EstimatedCost | Decimal | Estimated cost to implement the change requested. |
| EstimatedRevenue | Decimal | Estimated revenue to implement the change requested. |
| Currency | String | Currency code for the amounts impacted by the change. If project is specified for the change order, currency is defaulted to project currency. Otherwise, default value for currency is USD. |
| Summary | String | Summary of the impact of a change order. |
| Description | String | Description of the impact of a change order. |
| ContractAmount | Decimal | Contract amount of the impact of a change order. |
| ImpactOwnerName | String | Name of the impact owner. |
| ImpactOwnerEmail | String | Email of the impact owner. |
| ImpactTo | String | The detail of the impacted object type such as a cost budget or revenue budget. |
| ImpactedObjectId | Long | Identifier of the impacted object such as a budget version or a forecast version. |
| Bind_ChangeDocumentId | String | bind_changedocumentid |
| Bind_ChangeDocumentNumber | String | bind_changedocumentnumber |
| Bind_CreatorId | String | bind_creatorid |
| Bind_Name | String | bind_name |
| Bind_OwnerId | String | bind_ownerid |
| Bind_ProjectId | String | bind_projectid |
| Bind_Stage | String | bind_stage |
| Bind_Status | String | bind_status |
| Bind_TaskId | Long | bind_taskid |
| ChangeDocumentId | Long | changedocumentid |
| Finder | String | finder |
The Change Impact Details resource is used to view the impact details for a change order.
| Name | Type | Description |
| ChangeOrdersChangeDocumentId [KEY] | Long | Unique identifier of a project change order. Mandatory for PATCH operation. |
| ChangeimpactsImpactId [KEY] | Long | Unique identifier of the impact to the change order. |
| ChangeDocumentId | Long | External identifier of a project change order. Updatable only at creation time. |
| ChangeImpactId | Long | Unique identifier of the impact to the change order. Updatable only at creation time. |
| FinishDate | Date | The finish date of the change impact detail. |
| ImpactDetailsId [KEY] | Long | Unique identifier of the impact detail of the change order. |
| PCBurdenedCost | Decimal | The amount of change to the burdened cost in project currency. |
| PCRawCost | Decimal | The amount of change to the raw cost in project currency. |
| PCRevenue | Decimal | The amount of change to the revenue in project currency. |
| PfcBurdenedCost | Decimal | The amount of change to the burdened cost in project ledger currency. |
| PfcRawCost | Decimal | The amount of change to the raw cost in project ledger currency. |
| PfcRevenue | Decimal | The amount of change to the revenue in project ledger currency. |
| ProjElementId | Long | Identifier of the task or the project that is impacted by the change. Updatable only at creation time. |
| Quantity | Decimal | The amount of change to the quantity. |
| RbsElementId | Long | Identifier of the resource that is impacted by the change. Updatable only at creation time. |
| StartDate | Date | The start date of the change impact detail. |
| TCBurdenedCost | Decimal | The amount of change to the burdened cost in transaction currency. |
| TCRawCost | Decimal | The amount of change to the raw cost in transaction currency. |
| TCRevenue | Decimal | The amount of change to the revenue in transaction currency. |
| TransactionCurrency | String | The currency code for the change impact in transaction currency. |
| UnitOfMeasure | String | The unit to measure the quantity such as hours or tons. |
| ResourceName | String | Name of the resource that's impacted by the change. Updatable only at creation time. |
| ProjectOrTaskName | String | Name of the task or the project for which change order impact detail is created. Updatable only at creation time. |
| Bind_ChangeDocumentId | String | bind_changedocumentid |
| Bind_ChangeDocumentNumber | String | bind_changedocumentnumber |
| Bind_CreatorId | String | bind_creatorid |
| Bind_Name | String | bind_name |
| Bind_OwnerId | String | bind_ownerid |
| Bind_ProjectId | String | bind_projectid |
| Bind_Stage | String | bind_stage |
| Bind_Status | String | bind_status |
| Bind_TaskId | Long | bind_taskid |
| Finder | String | finder |
The Change Participants resource is used to view the participants for a change order.
| Name | Type | Description |
| ChangeOrdersChangeDocumentId [KEY] | Long | Unique identifier of a project change order. Mandatory for PATCH operation. |
| ParticipantId [KEY] | Long | Unique identifier of the change order participant. |
| ParticipantResourceId | Long | Resource identifier of the change order participant. |
| AssessmentFlag | Bool | Indicates whether a participant is an assessor on the change order. Valid values are Y and N. The default value is N. |
| AssessmentStatus | String | Assessment status of assessor for a change order. Valid values are In Progress and Completed. |
| ReviewFlag | Bool | Indicates whether a participant is a reviewer on the change order. Valid values are Y and N. The default value is N. |
| ReviewStatus | String | Review status of participant for a change order. Valid values are In Progress and Completed. |
| ApproveFlag | Bool | Indicates whether a participant is an approver on the change order. Valid values are Y, N, and R. The default value is N. |
| ApproveStatus | String | Approval status of participant for a change order. Valid values are In Progress, Completed, and Rejected. |
| ImplementationFlag | Bool | Indicates whether a participant is an implementor on the change order. Valid values are Y and N. The default value is N. |
| ImplementationStatus | String | Implementation status of participant for a change order. Valid values are In Progress and Completed. |
| AssessmentComments | String | Assessment comments by participant for a change order. |
| ReviewComments | String | Review comments by participant for a change order. |
| ApproveComments | String | Approval or rejection comments by participant for a change order. Mandatory for rejecting the change order. |
| ImplementationComments | String | Implementation comments by participant for a change order. |
| RejectType | String | The code of the rejection type for a change order. Mandatory for rejecting the change order. Valid values are INSUFFICIENT_INFORMATION, OTHER, SCOPE_REDUCTION, and UNACCEPTABLE_RISK. |
| RejectDate | Date | Date when change order was rejected. Calculated by application. |
| ParticipantName | String | Name of the change order participant. |
| ParticipantEmail | String | Email of the change order participant. |
| Bind_ChangeDocumentId | String | bind_changedocumentid |
| Bind_ChangeDocumentNumber | String | bind_changedocumentnumber |
| Bind_CreatorId | String | bind_creatorid |
| Bind_Name | String | bind_name |
| Bind_OwnerId | String | bind_ownerid |
| Bind_ProjectId | String | bind_projectid |
| Bind_Stage | String | bind_stage |
| Bind_Status | String | bind_status |
| Bind_TaskId | Long | bind_taskid |
| ChangeDocumentId | Long | changedocumentid |
| Finder | String | finder |
The Contract Project and Task Bill Rate Overrides resource is used to view project task rate overrides defined at the contract bill plan or revenue plan level.
| Name | Type | Description |
| RateOverrideId [KEY] | Long | The unique identifier of the rate override. |
| ContractId | Long | Identifier of the contract to which the rate override belongs. |
| ContractNumber | String | Number of the contract to which the rate override belongs. |
| ContractType | String | Name of the type of contract to which the rate override belongs. |
| BillPlanId | Long | Identifier of the plan to which the rate override belongs. |
| BillPlanName | String | Name of the bill plan to which the rate override belongs. |
| PlanType | String | Name of the type of plan to which the rate override belongs. You must enter either Bill Plan or Revenue Plan. |
| ContractLineId | Long | Identifier of the contract line to which the rate override belongs. |
| ContractLineNumber | String | Number of the contract line to which the rate override belongs. |
| ContractLineName | String | Name of the contract line to which the rate override belongs. |
| ProjectId | Long | Identifier of the project to which the rate override belongs. |
| ProjectNumber | String | Number of the project to which the rate override belongs. |
| ProjectName | String | Name of the project to which the rate override belongs. |
| TaskId | Long | Identifier of the task to which the rate override belongs. |
| TaskNumber | String | Number of the task to which the rate override belongs. |
| TaskName | String | Name of the task to which the rate override belongs. |
| PersonId | Long | Identifier of the person to which the rate override belongs. |
| PersonNumber | String | Number of the person to which the rate override belongs. |
| PersonName | String | Name of the person to which the rate override belongs. |
| PersonEmail | String | Email of the person to which the rate override belongs. |
| ProjectRoleId | Long | Identifier of the project role to which the rate override belongs. |
| ProjectRoleName | String | Name of the project role to which the rate override belongs. |
| JobId | Long | Identifier of the job to which the rate override belongs. |
| JobCode | String | Code of the job to which the rate override belongs. |
| JobName | String | Name of the job to which the rate override belongs. |
| ExpenditureTypeId | Long | Identifier of the expenditure type to which the rate override belongs. |
| ExpenditureTypeName | String | Name of the expenditure type to which the rate override belongs. |
| Rate | Decimal | The rate assigned to the rate override. |
| CurrencyCode | String | Currency code associated with the rate override. |
| CurrencyName | String | Currency name associated with the rate override. |
| FromDate | Date | Date from which the rate override is effective. The date format is YYYY-MM-DD. |
| ToDate | Date | Date after which the rate override is no longer effective. The date format is YYYY-MM-DD. |
| RateOverrideReasonCode | String | The reason code for changing the rate override. |
| RateOverrideReason | String | The reason for changing the rate override. Enter a valid meaning of the lookup code for the Discount Reason lookup type. |
| CreationDate | Datetime | The date when the record was created. |
| CreatedBy | String | The user who created the record. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| Finder | String | finder |
The LOV for Deliverable and Work Item Types resource is used to list deliverable and work item type values. The deliverable type provides a way to classify the output that must be produced to complete a requirement, project, or task. Examples include functional design documents, test plans, or physical objects. Work items originate in Oracle Innovation Management, Oracle Product Development, and Oracle Sourcing.
| Name | Type | Description |
| DeliverableTypeId [KEY] | Long | Unique identifier of the deliverable or work item type. |
| Description | String | Text to describe the deliverable or work item type. |
| DisabledFlag | Bool | Indicates if the deliverable type should no longer be used. True indicates the deliverable type is disabled and should no longer be used. False indicates it's not disabled. |
| FromDate | Date | Date when the deliverable type is available to use for creating and editing deliverables. |
| Name | String | Name of the deliverable or work item type. |
| ToDate | Date | Date when the deliverable type should no longer be used for creating and updating deliverables. |
| DeliverableTypeClass | String | The code representing the classification of the deliverable or work item type. Values include DOCUMENT, GENERAL, PLM_CHANGE, PLM_CONCEPT, PLM_ITEM, PLM_PROPOSAL, PLM_RQMT, and PON_NEGOTIATION. |
| Bind_currentDate | Date | bind_currentdate |
| Finder | String | finder |
The Enterprise Project and Task Codes resource is used to view the definitions of the enterprise project and task codes. Project codes are used to capture organization-specific extended attributes for projects. Similarly, task codes are used to capture organization-specific extended attributes for tasks.
| Name | Type | Description |
| CodeId [KEY] | Long | Unique identifier of the enterprise code. |
| EnterpriseCode | String | Name of the enterprise code used to extend attributes of project or tasks. |
| EnterpriseCodeId | String | Identifier of the enterprise project code or enterprise task code. |
| DataType | String | Type of the value of the enterprise project or task code. Valid values are LOV, NUMBER, TEXT. |
| ColumnName | String | Label that will be externally visible for the enterprise project or task code. |
| ColumnDescription | String | Description of the enterprise project or task code. |
| DisableFlag | Bool | Indicates if the enterprise code is disabled. Value is true if it's disabled and value is false if the project or task code is enabled. |
| CodePurpose | String | Indicates if the enterprise code will be used for projects or for project tasks. Valid values are TASK, PROJECTS. |
| CreatedBy | String | User who created the record. |
| LastUpdatedBy | String | The user who last updated the record. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| CreationDate | Datetime | Date when the record was created. |
| Finder | String | finder |
List of accepted values for an enterprise project code or task code.
| Name | Type | Description |
| EnterpriseProjectAndTaskCodesCodeId [KEY] | Long | The identifier of the enterprise project or task code. |
| ValueId [KEY] | Long | Identifier of an accepted value for the enterprise project or task code of type list of values. |
| DisplaySequence | Decimal | The order in which the value is displayed within the list of valid accepted values of the enterprise project or task code. |
| AcceptedValue | String | An accepted value of the enterprise project or task code. |
| AcceptedValueDisableFlag | Bool | Indicates if the enterprise project or task code accepted value is disabled. Value is true if it's disabled and value is false if the enterprise code accepted value is enabled. |
| CreatedBy | String | User who created the record. |
| CreationDate | Datetime | Date when the record was created. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| CodeId | Long | codeid |
| Finder | String | finder |
The Project Billing Event Types LOV resource is used to view a project billing event type. This object includes attributes which are used to store values of a project billing event type.
| Name | Type | Description |
| EventTypeId [KEY] | Long | Identifier of the event type. |
| StartDateActive | Date | The date from which the event type is active. |
| EndDateActive | Date | The date until which the event type is active. |
| InvoiceFlag | Bool | Indicates the category used to report event related revenue. |
| RevenueFlag | Bool | Indicates if the event type is to be used for revenue. |
| EventTypeName | String | Name of the event type that classifies the event by category and identifies whether the event is to be used for revenue only, invoice only, or both invoice and revenue. |
| Description | String | The description of the event. For billing events, the description is displayed as the invoice line description. |
| RevenueCategory | String | Indicates if the event type is to be used for invoice. |
| AllowAdjustmentFlag | Bool | Indicates if the event type can be adjusted after creation. |
| MigrationFlag | Bool | Indicates if the event type is imported from a third-party application. |
| Finder | String | finder |
| RevenueCategoryCode | String | revenuecategorycode |
| SearchTerm | String | searchterm |
The project expenditure type resource is used to list expenditure types. An expenditure type is classifications of cost that is associated an expenditure item. Expenditure types are grouped into cost groups and revenue groups.
| Name | Type | Description |
| ExpenditureTypeName | String | Name of the expenditure type. |
| SystemLinkageFunction | String | The system linkage that classifies the expenditure type in order to drive expenditure processing for the items classified by the expenditure type. |
| ExpenditureTypeId [KEY] | Long | Unique identifier of expenditure type |
| ExpenditureTypeStartActiveDate | Date | Active start date of expenditure type. |
| ExpenditureTypeEndActiveDate | Date | Active finish date of expenditure type. |
| SystemLinkageFunctionName | String | The system linkage name that classifies the expenditure type in order to drive expenditure processing for the items classified by the expenditure type. |
| Finder | String | finder |
The Expenditure Types LOV resource is used to view an expenditure type. This object includes attributes which are used to store values of an expenditure type.
| Name | Type | Description |
| ExpenditureTypeId [KEY] | Long | Unique identifier of the expenditure type. |
| ExpenditureTypeName | String | Name of the expenditure type. |
| ExpenditureTypeDescription | String | Description of the expenditure type. |
| RevenueCategory | String | A category grouping of expenditure types by type of revenue. |
| RevenueCategoryCode | String | Code of a category grouping of expenditure types by type of revenue. |
| UnitOfMeasure | String | The default value of units on costing or planning transactions. |
| UnitOfMeasureCode | String | Code of the default value of units on costing or planning transactions. |
| ExpenditureCategoryId | Long | Unique identifier of the expenditure category. |
| ExpenditureCategory | String | Name of the expenditure category. |
| ExpenditureTypeStartDate | Date | Start date of an expenditure type. |
| ExpenditureTypeEndDate | Date | End date of an expenditure type. |
| ExpTypeClassCode | String | exptypeclasscode |
| ExpTypeClassDate | Date | exptypeclassdate |
| ExpTypeClassName | String | exptypeclassname |
| ExpTypeDate | Date | exptypedate |
| Finder | String | finder |
| SearchTerm | String | searchterm |
The Expenditure Type Classes LOV resource is used to view an expenditure type class. This object includes attributes which are used to store values of an expenditure type class.
| Name | Type | Description |
| ExpenditureTypesLOVExpenditureTypeId [KEY] | Long | Unique identifier of the expenditure type. |
| ExpenditureTypeId | Long | Unique identifier of parent resource expenditure type. |
| ExpenditureTypeClassId [KEY] | Long | Unique id identifier for expenditure type class. |
| ExpTypeClassName | String | The expenditure type class name that classifies the expenditure type in order to drive expenditure processing for the items classified by the expenditure type. |
| ExpTypeClassCode | String | The expenditure type class code classifies the expenditure type in order to drive expenditure processing for the items classified by the expenditure type. |
| ExpTypeClassStartDate | Date | Start date of an expenditure type class. |
| ExpTypeClassEndDate | Date | End date of an expenditure type class. |
| ExpenditureCategory | String | expenditurecategory |
| ExpenditureCategoryId | Long | expenditurecategoryid |
| ExpTypeClassDate | Date | exptypeclassdate |
| ExpTypeDate | Date | exptypedate |
| Finder | String | finder |
| SearchTerm | String | searchterm |
The Financial Project Plan resource is used to view the financial project plan version.
| Name | Type | Description |
| PlanVersionId [KEY] | Long | Identifier of the financial project plan version. |
| ProjectPlanType | String | Name of the project plan type from which the financial project plan is created. |
| ProjectId | Long | Identifier of the project for which the financial project plan is created. You must enter either Project Name or Project Number but not for all three or a combination of them while creating a financial project plan. |
| ProjectNumber | String | Number of the project for which the financial project plan is created. You must enter either Project ID or Project Name but not for all three or a combination of them while creating a financial project plan. |
| ProjectName | String | Name of the project for which the financial project plan is created. You must enter either Project ID or Project Number but not for all three or a combination of them while creating a financial project plan. |
| PlannedEffort | Decimal | Measure of the effort planned for in the financial project plan version, expressed in hours. |
| ITDActualEffort | Decimal | Actual effort for the project from the start of the project till the current date, expressed in hours. |
| BaselineEffort | Decimal | Measure of the effort planned in the baseline financial project plan version, expressed in hours. |
| RawCostInProjectCurrency | Decimal | Planned cost for the project in project currency that corresponds to the work performed. |
| ITDActualRawCostInProjectCurrency | Decimal | Actual cost incurred for the project in project currency that corresponds to the work performed from the start date of the project till the current date. |
| BaselineRawCostInProjectCurrency | Decimal | Planned cost for the project in project currency in the baseline financial project plan version that corresponds to the work performed. |
| BurdenedCostInProjectCurrency | Decimal | Total planned cost for the project in project currency that includes both raw and burden costs. |
| ITDActualBurdenedCostInProjectCurrency | Decimal | Actual cost incurred for the project, including raw and burden costs, in project currency from the start date of the project till the current date. |
| BaselineBurdenedCostInProjectCurrency | Decimal | Total planned cost for the project, including raw and burden costs, in project currency in the baseline financial project plan version. |
| RawCostInProjectLedgerCurrency | Decimal | Planned cost for the project in project ledger currency that corresponds to the work performed. |
| ITDActualRawCostInProjectLedgerCurrency | Decimal | Actual cost incurred for the project in project ledger currency that corresponds to the work performed from the start date of the project till the current date. |
| BaselineRawCostInProjectLedgerCurrency | Decimal | Planned cost for the project in project ledger currency in the baseline financial project plan version that corresponds to the work performed. |
| BurdenedCostInProjectLedgerCurrency | Decimal | Total planned cost for the project in project ledger currency that includes both raw and burden costs. |
| ITDActualBurdenedCostInProjectLedgerCurrency | Decimal | Actual cost incurred for the project, including raw and burden costs, in project ledger currency from the start date of the project till the current date. |
| BaselineBurdenedCostInProjectLedgerCurrency | Decimal | Total planned cost for the project, including raw and burden costs, in project ledger currency in the baseline financial project plan version. |
| PlanVersionStatus | String | Indicates the status of the financial project plan version. Valid values are Current Working, Processing, and Failed. |
| DeferProcessing | String | Indicates that the financial project plan version will be managed in a deferred mode. |
| Finder | String | finder |
The Planning Options resource is used to view the planning options configured for the financial project plan version. Planning options are user-definable options, that include plan settings, rate settings, currency settings, and generation options, and are used to control planning scenarios. Financial project plan versions inherit planning options that are defined for the project plan type that's associated to the project.
| Name | Type | Description |
| FinancialProjectPlansPlanVersionId [KEY] | Long | Identifier of the financial project plan version. |
| PlanningOptionId [KEY] | Long | Unique identifier of the summary level planning option in the financial project plan version. |
| MultipleTransactionCurrencies | String | Indicates that the plan can use multiple transaction currencies for planning. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected. |
| ThirdPartySchedulingFlag | Bool | Indicates that the plan can use a third-party scheduling tool. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected. |
| EnableCostsForPlanFlag | Bool | Indicates whether resource assignments can be created on the project and allow capturing costs for the project. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected. |
| SetUnplannedAssignmentsAsPlannedAssignmentsFlag | Bool | Indicates whether resource assignments can be created as planned on the project on incurring costs for the project. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected. |
| AssociateProjectCostsToSummaryTaskAssignmentsFlag | Bool | Indicates whether project costs for a resource assignment from a lowest level task can be associated to a planned resource assignment on the financial project plan at a higher level in the task structure. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected. |
| PlanningResourceBreakdownStructure | String | Primary planning resource breakdown structure associated with the project. |
| CalendarType | String | The type of calendar, such as accounting calendar or project accounting calendar, used for entering and displaying periodic financial information. |
| RateDerivationDateType | String | The date type, such as system date or fixed date, that's used as the basis for deriving rates for calculating amounts on a None time-phased resource assignment version. |
| RateDerivationDate | Datetime | The date that's used as the basis for deriving rates for calculating amounts on a None time-phased resource assignment version. |
| PeriodProfile | String | Defines how time periods are grouped and displayed when editing resource assignment versions. |
| CurrentPlanningPeriod | String | Current planning period that drives the display of the periodic information. It can be the project accounting period or accounting period depending on the selected calendar type. This value isn't applicable when the calendar type is set to NONE. |
| MaintainManualSpreadOnDateChanges | String | Indicates whether the periodic planning is retained in the plan version on plan line date modifications. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected. |
| UseSameDatesForTaskAssignmentsAsTaskDatesFlag | Bool | Indicates whether you can use the same dates for the task assignments as the task dates. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected. |
| RollUpTaskDatesFlag | Bool | Indicates whether summary task dates are rolled up from the lowest level task dates. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected. |
| SynchronizeTaskTransactionDatesWithTaskPlannedDatesFlag | Bool | Indicates whether task transaction dates are synchronized with task planned dates. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected. |
| BufferForSynchronizeTaskTransactionDatesWithTaskPlannedDates | Decimal | Buffer value to adjust the task transaction dates to be changed along with the task planned dates. |
| ProjectCurrency | String | Currency for the project. |
| ProjectLedgerCurrency | String | Project ledger currency for the project. |
| UseSameConversionAttributeForAllCurrencyConversionsFlag | Bool | Indicates whether you can use the same currency conversion attribute for all currencies. |
| RateTypeForCostConversion | String | Rate type that's used as a cost conversion attribute for planning currencies. |
| DateTypeForCostConversion | String | Date type that's used as a cost conversion attribute for planning currencies. |
| FixedDateForCostConversion | Datetime | The date that's used to derive conversion rates for calculating planned costs for planning currencies. |
| RateTypeForConversionInPC | String | Rate type that's used as a cost conversion attribute for project currency. |
| DateTypeForConversionInPC | String | Date type that's used as a cost conversion attribute for project currency. |
| FixedDateForConversionInPC | Datetime | The date that's used to derive conversion rates for calculating planned costs for project currency. |
| RateTypeForConversionInPLC | String | Rate type that's used as a cost conversion attribute for project ledger currency. |
| DateTypeForConversionInPLC | String | Date type that's used as a cost conversion attribute for project ledger currency. |
| FixedDateForConversionInPLC | Datetime | The date that's used to derive conversion rates for calculating planned costs for project ledger currency. |
| UsePlanningRatesFlag | Bool | Enables utilization of planning rates for resources and resource classes when calculating resource assignment amounts. |
| BurdenScheduleCostOptions | String | A set of burden multipliers that's maintained for use across projects. Also referred to as a standard burden schedule. |
| PersonCostOptions | String | Rate schedule used for the calculation of cost amounts for named persons. |
| JobCostOptions | String | Rate schedule used for the calculation of cost amounts for jobs. |
| NonlaborResourceCostOptions | String | Rate schedule used for the calculation of cost amounts for non-labor resources. |
| ResourceClassCostOptions | String | Rate schedule used for the calculation of cost amounts for resource classes. This is used for cost calculation when rates are unavailable in rate schedules for named persons, jobs, or non-labor resources. |
| ProjectRoleCostOptions | String | Rate schedule used for the calculation of cost amounts for project role. |
| PhysicalPercentCompleteCalculationMethod | String | Calculates physical percent complete at the lowest level task. The valid values are Cost, Effort, and Manual Entry. |
| EstimateToCompleteMethod | String | Calculates estimate-to-complete value for the task and task assignment. The valid values are Remaining Plan and Manual Entry. |
| AllowNegativeETCCalculationFlag | Bool | Indicates whether estimate-to-complete values can be lesser than zero. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected. |
| UpdatePlannedQuantityWithEACQuantityFlag | Bool | Indicates whether planned values for task assignments can be updated with estimate-at-completion values while publishing progress. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected. |
| AutomaticallyGenerateForecastVersionFlag | Bool | Indicates if a forecast is being created using the financial plan type while publishing progress. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected. |
| ForecastFinancialPlanType | String | The name of the financial plan type that's used to create the forecast version. |
| AutoApproveFlag | Bool | Indicates if the budget that was created using the financial plan type is baselined. |
| PrimaryPhysicalPercentCompleteBasis | String | Determines the primary physical percent complete value for summary tasks. The valid values are Cost, Effort, and Manual Entry. |
| AutomaticallyGenerateBudgetVersionFlag | Bool | Indicates if a forecast is being created using the financial plan type while publishing progress. A value of Y indicates that the attribute is selected. A value of N indicates that the attribute isn't selected. |
| BudgetFinancialPlanType | String | The name of the financial plan type that's used to create the budget version. |
| AutoBaselineFlag | Bool | Indicates if the budget that was created using the financial plan type is baselined. |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
The Planning Currency resource is used to view project and planning currencies.
| Name | Type | Description |
| FinancialProjectPlansPlanVersionId [KEY] | Long | Identifier of the financial project plan version. |
| PlanningoptionsPlanningOptionId [KEY] | Long | Unique identifier of the summary level planning option in the financial project plan version. |
| PlanningCurrencyId [KEY] | Long | Identifier of the planning currency. |
| PlanningCurrencyCode | String | Currency code for the planning currency. |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
A listing of all the descriptive flexfields available for planning options in the financial project plan version.
| Name | Type | Description |
| FinancialProjectPlansPlanVersionId [KEY] | Long | Identifier of the financial project plan version. |
| PlanningoptionsPlanningOptionId [KEY] | Long | Unique identifier of the summary level planning option in the financial project plan version. |
| PlanningOptionId [KEY] | Long | Unique identifier of the summary level planning option in the financial project plan version. |
| _FLEX_Context | String | Code that identifies the context for the segments of the planning options flexfields. |
| _FLEX_Context_DisplayValue | String | Name of the context for the segments of the planning options flexfields. |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
The Resource Assignments resource is used to view a financial project plan resource assignment.
| Name | Type | Description |
| FinancialProjectPlansPlanVersionId [KEY] | Long | Identifier of the financial project plan version. |
| PlanningElementId [KEY] | Long | Identifier of the resource assignment on the financial project plan version. |
| TaskId | Long | Identifier of the task for which a financial project plan resource assignment is created. You must enter either Task Name or Task Number but not for all three or a combination of them while creating a financial project plan resource assignment. |
| TaskNumber | String | Number of the task for which a financial project plan resource assignment is created. You must enter either Task Name or Task ID but not for all three or a combination of them while creating a financial project plan resource assignment. |
| TaskName | String | Name of the task for which a financial project plan resource assignment is created. You must enter either Task ID or Task Number but not for all three or a combination of them while creating a financial project plan resource assignment. |
| RbsElementId | Long | Identifier of the resource breakdown structure element used to create the financial project plan resource assignments line. |
| ResourceName | String | Name or alias of the resource included in the planning resource breakdown structure that is used to create the financial project plan resource assignment. |
| PlanningStartDate | Datetime | The date that is planned on the financial project plan for a resource to begin their assignment on a project task. |
| PlanningFinishDate | Datetime | The date that is planned on the financial project plan for a resource to finish their assignment on a project task. |
| BaselineStartDate | Datetime | The date that is planned on the baseline financial project plan for a resource to begin their assignment on a project task. |
| BaselineFinishDate | Datetime | The date that is planned on the baseline financial project plan for a resource to finish their assignment on a project task. |
| SpreadCurve | String | Name of the set of distribution factors that enables the application to automatically distribute quantity and cost for a resource on a task assignment across a range of accounting or project accounting periods. |
| UnitOfMeasure | String | Unit of work that measures the quantity of effort for which the resource is planned for on the financial project plan resource assignment. |
| ResourceClass | String | Grouping of predefined resource types to which the resource in the financial project plan resource assignment belongs. A list of valid values are Labor, Equipment, Material Items, and Financial Resources. |
| UseTaskDatesAsTaskAssignmentDatesFlag | Bool | Indicates if the resource assignment dates on the task in the financial project plan resource assignment are the same as the task dates on the project. |
| RateBasedFlag | Bool | Indicates if the financial project plan resource assignment is rate based. |
| UnplannedFlag | Bool | Indicates if the financial project plan resource assignment is unplanned. |
| AdministrativeCode | String | Action identifier used for administrative purpose only. |
| MaintainManualSpreadOnDateChanges | String | Indicates whether the periodic planning is retained in the plan version on plan line date modifications. |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
The Planning Amounts resource is used to view a financial project plan resource assignment amounts.
| Name | Type | Description |
| FinancialProjectPlansPlanVersionId [KEY] | Long | Identifier of the financial project plan version. |
| ResourceassignmentsPlanningElementId [KEY] | Long | Identifier of the resource assignment on the financial project plan version. |
| PlanLineId [KEY] | Long | Identifier of the summary level planning amounts for a resource assignment in the financial project plan. |
| PlannedQuantity | Decimal | Measure of the effort planned for in the financial project plan resource assignment, expressed in hours. |
| ITDActualQuantity | Decimal | Actual effort for the financial project plan resource assignment from the start of the project till the current date, expressed in hours. |
| BaselineQuantity | Decimal | Measure of the effort planned for the resource assignment in the baseline financial project plan version, expressed in hours. |
| Currency | String | Code that identifies the planning currency on the financial project plan resource assignment. |
| RawCost | Decimal | Planned cost for the financial project plan resource assignment in planning currency that corresponds to the work performed. |
| ITDActualRawCost | Decimal | Actual cost incurred for the financial project plan resource assignment in planning currency that corresponds to the work performed from the start date of the project till the current date. |
| BaselineRawCost | Decimal | Planned cost for the project in planning currency in the baseline financial project plan version that corresponds to the work performed. |
| BurdenedCost | Decimal | Total planned cost for the financial project plan resource assignment in planning currency that includes both raw and burden costs. |
| ITDActualBurdenedCost | Decimal | Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in planning currency from the start date of the project till the current date. |
| BaselineBurdenedCost | Decimal | Total planned cost for the baseline financial project plan resource assignment, including raw and burden costs, in planning currency. |
| EffectiveRawCostRate | Decimal | Cost rate that is used to calculate amounts for a financial project plan resource assignment. Quantity multiplied by the effective raw cost rate gives the raw cost amounts. |
| StandardRawCostRate | Decimal | Rate derived from the rate schedule for calculating the planned raw cost for the financial project plan resource assignment. |
| EffectiveBurdenedCostRate | Decimal | Cost rate that is used to calculate amounts for a financial project plan resource assignment. Quantity multiplied by the effective burdened cost rate gives the burdened cost amounts. |
| StandardBurdenedCostRate | Decimal | Average rate derived from the rate schedule for calculating the planned burdened cost for the financial project plan resource assignment. |
| RawCostInProjectCurrency | Decimal | Planned cost for the financial project plan resource assignment in project currency that corresponds to the work performed. |
| ITDActualRawCostInProjectCurrency | Decimal | Actual cost incurred for the financial project plan resource assignment in project currency that corresponds to the work performed from the start date of the project till the current date. |
| BaselineRawCostInProjectCurrency | Decimal | Planned cost for the baseline financial project plan resource assignment in project currency that corresponds to the work performed. |
| BurdenedCostInProjectCurrency | Decimal | Total planned cost for the financial project plan resource assignment in project currency that includes both raw and burden costs. |
| ITDActualBurdenedCostInProjectCurrency | Decimal | Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in project currency from the start date of the project till the current date. |
| BaselineBurdenedCostInProjectCurrency | Decimal | Total planned cost for the baseline financial project plan resource assignment, including raw and burden costs, in project currency. |
| RawCostInProjectLedgerCurrency | Decimal | Planned cost for the financial project plan resource assignment in project ledger currency that corresponds to the work performed. |
| ITDActualRawCostInProjectLedgerCurrency | Decimal | Actual cost incurred for the financial project plan resource assignment in project ledger currency that corresponds to the work performed from the start date of the project till the current date. |
| BaselineRawCostInProjectLedgerCurrency | Decimal | Planned cost for the baseline financial project plan resource assignment in project ledger currency that corresponds to the work performed. |
| BurdenedCostInProjectLedgerCurrency | Decimal | Total planned cost for the financial project plan resource assignment in project ledger currency that includes both raw and burden costs. |
| ITDActualBurdenedCostInProjectLedgerCurrency | Decimal | Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in project ledger currency from the start date of the project till the current date. |
| BaselineBurdenedCostInProjectLedgerCurrency | Decimal | Total planned cost for the financial project plan resource assignment, including raw and burden costs, in project ledger currency in the baseline financial project plan version. |
| ManualSpreadFlag | Bool | Indicates if the periodic planning is modified and retained for the plan line on date changes. |
| BaselineCurrency | String | Currency of the rendered baseline amounts. |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
The Plan Lines descriptive flexfields resource is used to view additional information for planning amounts in financial project plans.
| Name | Type | Description |
| FinancialProjectPlansPlanVersionId [KEY] | Long | Identifier of the financial project plan version. |
| ResourceassignmentsPlanningElementId [KEY] | Long | Identifier of the resource assignment on the financial project plan version. |
| PlanningamountsPlanLineId [KEY] | Long | Identifier of the summary level planning amounts for a resource assignment in the financial project plan. |
| PlanLineId [KEY] | Long | Identifier of the summary level planning amounts for a plan line in the financial project plan. |
| _FLEX_Context | String | Code that identifies the context for the segments of the plan lines flexfields. |
| _FLEX_Context_DisplayValue | String | Name of the context for the segments of the plan lines flexfields. |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
The Version Errors resource is used to view the errors in a financial project plan resource assignment.
| Name | Type | Description |
| FinancialProjectPlansPlanVersionId [KEY] | Long | Identifier of the financial project plan version. |
| PlanVersionId | Decimal | Identifier of the project budget version. |
| TaskNumber | String | Number of the task which is used to create a budget line. |
| TaskName | String | Name of the task which is used to create a budget line. |
| ResourceName | String | The name of the resource which is used to create a budget line. |
| TransactionCurrencyCode | String | Currency code for budget line with errors. |
| PeriodName | String | Period for which the periodic budget amount is entered. |
| ErrorType | String | Specifies whether a warning or error. |
| MessageName | String | Message code for the issue encountered. |
| MessageText | String | Error or warning that occurs or information that informs users to know what action to take or to understand what is happening. |
| MessageCause | String | Explanation for the resaon of an error or warning message. |
| MessageUserDetails | String | More detailed explanation of the message text that explains why the message occurred. |
| MessageUserAction | String | States the response that the end users must perform to continue and complete their tasks in response to an error or warning message. |
| Finder | String | finder |
Lists the findername along with the attributes for a particular view.
| Name | Type | Description |
| ViewName | String | Name of the view for which finder needs to be found. |
| FinderName | String | Name of Finder. |
| AttributeFinderColumn | String | Name of Finder Attribute. |
| Type | String | Datatype of Finder Attribute. |
Descriptive Flexfield Contexts List of Values
| Name | Type | Description |
| ApplicationId [KEY] | Long | ApplicationId |
| DescriptiveFlexfieldCode [KEY] | String | DescriptiveFlexfieldCode |
| ContextCode [KEY] | String | ContextCode |
| Name | String | Name |
| Description | String | Description |
| EnabledFlag | String | EnabledFlag |
| Bind_ApplicationId | Long | bind_applicationid |
| Bind_DescriptiveFlexfieldCode | String | bind_descriptiveflexfieldcode |
| Finder | String | finder |
The Award Project Funding Sources LOV resource is used to view an award project funding source. The service data object contains a list of funding sources with details such as funding source name and number.
| Name | Type | Description |
| FundingSourceId [KEY] | Long | The unique identifier of the funding source. |
| FundingSourceNumber | String | The number of the funding source. |
| FundingSourceName | String | The source name of the funding source. |
| FundingSourceTypeName | String | The name of the funding source type. |
| FundingSourceTypeCode | String | The code of the funding source type. |
| FundingSourceFromDate | Date | The date from which the funding source is active. |
| FundingSourceToDate | Date | The date till which the funding source is active. |
| ActiveDate | Date | activedate |
| Finder | String | finder |
The Grants Keywords resource is used to view the grants keywords, which are used to uniquely describe and track the key subject area of an award or grants personnel.
| Name | Type | Description |
| KeywordName | String | Name of the keyword that's used to uniquely describe and track the key subject area of the grants personnel. |
| KeywordId [KEY] | Long | Identifier of the keyword. |
| FromDate | Date | Date when the keyword becomes active. |
| ToDate | Date | Date after which the keyword is inactive. |
| Description | String | Details of the keyword that's used to track the key subject area for the grants personnel. |
| Finder | String | finder |
The Grants Personnel resource is used to view Grants personnel.
| Name | Type | Description |
| PersonId [KEY] | Long | Identifier of the person selected from Human Resources to administer and manage awards. |
| EligiblePiFlag | Bool | Indicates whether the person is qualified to be a principal investigator, the person primarily responsible for research. List of accepted values are True or False. |
| CertifiedDate | Date | Date when the person completed the conflict of interest review. Enter a start date in this format: YYYY-MM-DD. |
| OrganizationName | String | Organization assigned to the primary assignment of the person in Human Resources. |
| JobName | String | Job assigned to the primary assignment of the person in Human Resources. |
| PersonNumber | String | Number of the person selected from Human Resources to administer and manage awards. The application checks the attributes of this person in the following order: Email, Person Number, Person Name. The application first searches for a matching email, then a matching person number, then a matching person name. |
| ActivePerson | String | Indicates if the person has an active primary assignment in Human Resources as of the current date. |
| ReviewCompleted | String | Indicates whether a conflict of interest exists according to the institution policy and whether the person has completed the review. List of accepted values are True or False. |
| EmailAddress | String | Email of the person selected from Human Resources to administer and manage awards. The application checks the attributes of this person in the following order: Email, Person Number, Person Name. The application first searches for a matching email, then a matching person number, then a matching person name. |
| PersonName | String | Name of the person selected from Human Resources to administer and manage awards. The application checks the attributes of this person in the following order: Email, Person Number, Person Name. The application first searches for a matching email, then a matching person number, then a matching person name. |
| Finder | String | finder |
A listing of all the descriptive flexfields available for Grants personnel.
| Name | Type | Description |
| GrantsPersonnelPersonId [KEY] | Long | Identifier of the person selected from Human Resources to administer and manage awards. |
| PersonId [KEY] | Long | Identifier of the person selected from Human Resources to administer and manage awards. |
| _FLEX_Context | String | Context of the descriptive flexfield. |
| _FLEX_Context_DisplayValue | String | Context display value of the descriptive flexfield. |
| Finder | String | finder |
The Grants Personnel Keywords resource is used to view keywords that are associated to Grants personnel.
| Name | Type | Description |
| GrantsPersonnelPersonId [KEY] | Long | Identifier of the person selected from Human Resources to administer and manage awards. |
| KeywordId | Decimal | Identifier of the keyword selected from Grants keywords. |
| PersonId | Decimal | Identifier of the person selected from Human Resources to administer and manage awards. |
| KeywordName | String | Name of the keyword that's used to uniquely describe and track the key subject area for the Grants personnel. |
| FromDate | Date | Date when the keyword becomes active. |
| ToDate | Date | Date after which the keyword is inactive. |
| Description | String | Details of the keyword that's used to track the key subject area for the Grants personnel. |
| PersonnelKeywordId [KEY] | Long | Identifier of the keyword associated with the Grants personnel. |
| Finder | String | finder |
The Grants Sponsors resource is used to get all or a filtered set of funding sources.
| Name | Type | Description |
| SponsorId [KEY] | Long | The unique identifier of the sponsor. |
| PartyId | Long | The unique party identifier of the sponsor. |
| SponsorName | String | The name of the sponsor. |
| SponsorNumber | String | The unique number of the sponsor. |
| PrimaryContactName | String | The primary contact name of the sponsor. |
| PrimaryURL | String | The primary URL of the sponsor. |
| PrimaryContactPhone | String | The primary contact phone number of the sponsor. |
| PrimaryContactAddresss | String | The primary contact address of the sponsor. |
| PrimaryContactEmail | String | The primary contact email address of the sponsor. |
| SponsorAccountId | Long | The unique identifier of the sponsor account. |
| FederalFlag | Bool | Indicates whether the sponsor billing is federal. |
| LetterOfCreditFlag | Bool | Indicates whether the sponsor billing is letter of credit. |
| LetterOfCreditNumber | String | The unique number of the sponsor letter of credit. |
| Comments | String | The comments about the sponsor. |
| RelatedSponsorId | Long | The unique identifier of the related sponsor. |
| RelatedSponsorAccountId | Long | The unique identifier of the related sponsor account. |
| BurdenScheduleId | Long | The unique identifier of the burden schedule. |
| BurdenScheduleName | String | The name of the burden schedule. |
| CreatedBy | String | Created By |
| CreationDate | Datetime | Creation Date |
| LastUpdatedBy | String | Last Updated Date |
| LastUpdateDate | Datetime | Last Updated By |
| StatusCode | String | The status code of the sponsor. |
| Status | String | The status of the sponsor. |
| SponsorAccountNumber | String | The unique number of the sponsor account. |
| SponsorAccountName | String | The name of the sponsor account. |
| RelatedSponsorAccountName | String | The name of the related sponsor account. |
| RelatedSponsorAccountNumber | String | The unique number of the related sponsor account. |
| RelatedSponsorName | String | The name of the related sponsor. |
| RelatedSponsorNumber | String | The unique number of the related sponsor. |
| Finder | String | finder |
The Grants Sponsor Account Details resource is used to get the details of the sponsor account.
| Name | Type | Description |
| GrantsSponsorsSponsorId [KEY] | Long | The unique identifier of the sponsor. |
| SponsorAccountDetailsId [KEY] | Long | The unique identifier or the sponsor account details. |
| SponsorId | Long | The unique identifier of the sponsor. |
| SponsorName | String | The name of the sponsor. |
| SponsorNumber | String | The unique number of the sponsor. |
| SponsorAccountName | String | The name of the sponsor account. |
| SponsorAccountNumber | String | The unique number of the sponsor account. |
| PrimaryFlag | Bool | Indicates whether the sponsor account is primary. |
| LetterOfCreditFlag | Bool | Indicates whether the sponsor billing is letter of credit. |
| LetterOfCreditNumber | String | The unique number of the sponsor letter of credit. |
| Comments | String | The comment about the sponsor account details. |
| RelatedSponsorAccountName | String | The name of the related sponsor account. |
| RelatedSponsorAccountNumber | String | The unique number of the related sponsor account. |
| RelatedSponsorAccountId | Long | The unique identifier of the related sponsor account. |
| RelatedSponsorId | Long | The unique identifier of the related sponsor. |
| SponsorAccountId | Long | The unique identifier of the sponsor account. |
| CreatedBy | String | Created By |
| CreationDate | Datetime | Creation Date |
| LastUpdateDate | Datetime | Last Updated Date |
| LastUpdatedBy | String | Last Updated By |
| RelatedSponsorName | String | The name of the related sponsor. |
| RelatedSponsorNumber | String | The unique number of the related sponsor. |
| Finder | String | finder |
The Grants Sponsor Reference Types resource is used to get sponsor reference types.
| Name | Type | Description |
| GrantsSponsorsSponsorId [KEY] | Long | The unique identifier of the sponsor. |
| SponsorReferenceId [KEY] | Long | The unique identifier of the sponsor reference type. |
| SponsorReferenceType | String | The type of the sponsor reference, for example, Industry. |
| SponsorReferenceValue | String | The value of the sponsor reference type, for example, State Government or Local Government. |
| Description | String | The description of the sponsor reference type. |
| Comments | String | The comments about the sponsor reference type. |
| CreatedBy | String | Created By |
| CreationDate | Datetime | Creation Date |
| LastUpdatedBy | String | Last Updated Date |
| LastUpdateDate | Datetime | Last Updated By |
| Finder | String | finder |
| SponsorId | Long | sponsorid |
The LOV for Project Business Units resource is used to view a list of project business units. A business unit is a unit of an enterprise that performs one or many business functions that can be rolled up in a management hierarchy. A project business unit is one within which the project is created, and in which the project customer revenue and receivable invoices are processed.
| Name | Type | Description |
| BusinessUnitId [KEY] | Long | Identifier of the project business unit. |
| LegalEntityId | String | Identifier of the legal entity associated with the project business unit. |
| LocationId | Long | Identifier of the location associated with the project business unit. |
| ManagerId | String | Identifier of the person who manages the project business unit. |
| BusinessUnitName | String | Name of the project business unit. |
| PrimaryLedgerId | String | Identifier of the primary ledger associated with the project business unit. |
| ProfitCenterFlag | Bool | Indicates that the business unit is a profit center and it operates under one legal entity. |
| ActiveFlag | Bool | Indicates whether the business unit is currently active or not. |
| LegalEntity | String | Recognized party with given rights and responsibilities by legislation. Legal entities generally have the right to own property, the right to trade, the responsibility to repay debt , and the responsibility to account for themselves to company regulators, taxation authorities, and owners according to rules specified in the relevant legislation. |
| BillPlanId | String | billplanid |
| Finder | String | finder |
| Id | String | id |
| Intent | String | intent |
| MajorVersion | String | majorversion |
| SearchTerm | String | searchterm |
The Project and Task Cost Rate Overrides resource is used to view, create, update, or delete the cost rate overrides defined for a project.
| Name | Type | Description |
| RateOverrideId [KEY] | Long | The unique identifier of the rate override. |
| ProjectId | Long | Identifier of the project to which the rate override belongs. |
| ProjectNumber | String | Number of the project to which the rate override belongs. |
| ProjectName | String | Name of the project to which the rate override belongs. |
| TaskId | Long | Identifier of the task to which the rate override belongs. |
| TaskNumber | String | Number of the task to which the rate override belongs. |
| TaskName | String | Name of the task to which the rate override belongs. |
| PersonId | Long | Identifier of the person to which the rate override belongs. |
| PersonNumber | String | Number of the person to which the rate override belongs. |
| PersonEmail | String | Email of the person to which the rate override belongs. |
| PersonName | String | Name of the person to which the rate override belongs. |
| JobId | Long | Identifier of the job to which the rate override belongs. |
| JobCode | String | Code of the job to which the rate override belongs. |
| JobName | String | Name of the job to which the rate override belongs. |
| ExpenditureTypeId | Long | Identifier of the expenditure type to which the rate override belongs. |
| ExpenditureTypeName | String | Name of the expenditure type to which the rate override belongs. |
| Rate | Decimal | The rate assigned to the rate override. |
| CurrencyCode | String | Currency code associated with the rate override. |
| CurrencyName | String | Currency name associated with the rate override. |
| FromDate | Date | Date from which the rate override is effective. The date format is YYYY-MM-DD. |
| ToDate | Date | Date after which the rate override is no longer effective. The date format is YYYY-MM-DD. |
| RateOverrideReasonCode | String | The reason code for changing the rate override. |
| RateOverrideReason | String | The reason for changing the rate override. Enter a valid meaning of the lookup code for the Discount Reason lookup type. |
| CreationDate | Datetime | The date when the record was created. |
| CreatedBy | String | The user who created the record. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| Finder | String | finder |
The project asset resource is used to view project asset and asset assignments, including those from Project Portfolio Management and those imported from third-party applications. Asset Assignment is a child of the Asset.
| Name | Type | Description |
| ProjectAssetId [KEY] | Long | The unique identifier of a system-generated project asset. This is a mandatory attribute. |
| ProjectId | Long | Identifier of the project to which the asset belongs. You can enter either this attribute, the project name, or the project number while creating an asset. |
| ProjectName | String | Name of the project to which the asset belongs. You can enter either this attribute, the project ID, or the project number while creating an asset. |
| ProjectNumber | String | Number of the project to which the asset belongs. You can enter either this attribute, the project ID, or the project name while creating an asset. |
| ProjectAssetType | String | The identifier that determines when project costs become an asset. This is a mandatory attribute. It can be either ESTIMATED, AS-BUILT, or RETIREMENT_ADJUSTMENT. The default value is ESTIMATED. |
| AssetName | String | Name of the project asset that identifies an asset within a project. This is a mandatory attribute. |
| AssetNumber | String | The project asset number that identifies an asset in a project. This is a mandatory attribute, and can be user-defined or generated by Fixed Assets. You must provide the asset number and FA asset ID in Patch mode to associate the FA asset with the project asset. |
| AssetDescription | String | Description of the project asset that identifies an asset within a project upon transfer to Oracle Assets. This is a mandatory attribute. |
| CapitalEventId | Long | Identifier of the event that's assigned to the project asset. You may enter either this attribute, the event number, or the event name. |
| EventName | String | Name of the event that's assigned to the project asset. You may enter either this attribute, the event number, or the event ID. |
| CapitalEventNumber | Long | Number of the event that's assigned to the project asset. You may enter either this attribute, the event ID, or the event name. |
| EstimatedInServiceDate | Date | The estimated date on which an asset is placed in service. |
| DatePlacedInService | Date | The date on which an asset is placed in service. |
| CapitalizedFlag | Bool | Indicates whether the asset has been interfaced to Oracle Assets. The two options are Y and N. The default value is N. |
| CapitalizedDate | Date | The last date on which nonreversing cost adjustments were interfaced to Oracle Assets. |
| CapitalizedCost | Decimal | The cost amount that has been interfaced to Oracle Assets for capitalization. |
| TotalAssetCost | Decimal | The asset's cost amount, grouped into asset lines. |
| ReverseFlag | Bool | Indicates whether the asset will be reversed in the next Generate Asset Lines run. This is a mandatory attribute. The two options are Y and N. The default value is N. |
| ReversalDate | Date | The last date on which reversing asset lines were created. This is a system-generated date. |
| CapitalHoldFlag | Bool | Indicates whether the generation of new asset lines should be prevented. This is a mandatory attribute. The two options are Y and N. The default value is N. |
| BookTypeCode | String | The corporate book to which the asset is assigned. |
| AssetCategoryId | Long | Identifier of the asset category to which the asset is assigned. You may enter either this attribute, the asset category, or both. |
| AssetKeyIdentifier | Long | Identifier of the key flexfield code combination for the asset. You may enter either this attribute, the asset key, or both. |
| AssetUnits | Decimal | The number of asset units. |
| EstimatedCost | Decimal | The estimated cost of the asset. |
| EstimatedAssetUnits | Decimal | The estimated number of asset units. |
| SourceApplication | String | Identifier of the external project management system from which the project was imported. |
| SourceReference | String | Identifier of the project in the external project management system from which the project was imported. |
| LocationId | Long | Identifier of the location to which the asset is assigned. You may enter either this attribute, the location, or both when assigning a location to the asset. |
| AssignedToPersonId | Long | Identifier of the individual to whom the asset is assigned. You may enter either this attribute, the person name, or person number when assigning an individual to an asset. |
| PersonName | String | Name of the individual to whom the asset is assigned. You may enter either this attribute, the person Id, or person number when assigning an individual to an asset. |
| PersonNumber | String | Number of the individual to whom the asset is assigned. You may enter either this attribute, the person ID, or the person name when assigning an individual to an asset. |
| DepreciateFlag | Bool | Indicates whether the asset should be depreciated in Oracle Assets. The two options are Y and N. The default value is Y. |
| DepreciationExpenseIdentifier | Long | Identifier of the depreciation expense account for the asset. You may enter either this attribute, the depreciation expense account, or both. |
| AmortizeFlag | Bool | Indicates whether cost adjustments should be amortized in Oracle Assets. The two options are Y and N. The default value is N. |
| CostAdjustmentFlag | Bool | Indicates whether asset cost adjustments have been interfaced to Oracle Assets. The two options are Y and N. The default value is N. |
| NewMasterFlag | Bool | Determines whether this cost adjustment will reclassify the asset within Oracle Assets. |
| BusinessUnitId | Long | Identifier of the business unit associated with the project in which the asset has been assigned. This is a mandatory attribute. |
| BusinessUnitName | String | Name of the business unit associated with the project in which the asset has been assigned. |
| FixedAssetsAssetId | Long | Identifier of the asset in Oracle Fixed Assets used for tieback purposes. Users must provide the asset number along with the FA asset ID in PATCH mode if they're trying to associate an Oracle FA asset with the Projects asset. |
| FixedAssetsPeriodName | String | Period into which an asset was posted in Fixed Assets. |
| ParentAssetId | Long | Identifier of the parent asset in which multiple assets can be identified. You may enter a combination of this attribute, the parent asset description, or the parent asset number when associating an asset to a parent asset. |
| ParentAssetDescription | String | Description of the parent asset in which multiple assets can be identified. You may enter a combination of this attribute, the parent asset ID, or the parent asset number when associating an asset to a parent asset. |
| ParentAssetNumber | String | Number of the parent asset in which multiple assets can be identified. You may enter a combination of this attribute, the parent asset ID, or the parent asset description when associating an asset to a parent asset. |
| ManufacturerName | String | The name of the asset manufacturer. |
| ModelNumber | String | The model number of the asset. |
| TagNumber | String | Tag number of the asset. |
| SerialNumber | String | The serial number of the asset. |
| RetirementTargetAssetId | Long | The asset identifier used to capture retirement costs when another asset, or assets retire. You may enter either this attribute, the retirement target asset description, or the retirement target asset number when selecting an asset to capture the retirement costs. |
| RetirementTargetAssetDescription | String | Description of the asset used to capture retirement costs when another asset, or assets, retire. You may enter this attribute, Retirement Target Asset ID, or Retirement Target Asset Number, when selecting an asset to capture the retirement costs. |
| RetirementTargetAssetNumber | String | Number of the asset used to capture the retirement costs when another asset or assets retire. You may enter this attribute, the retirement target asset ID, or the retirement target asset description when selecting an asset to capture the retirement costs. |
| LocationCombination | String | Segment values for location, concatenated using delimiters. |
| AssetKeyCombination | String | Segment values for asset keys, concatenated using a delimiter. |
| AssetCategoryCombination | String | Segment values for asset categories, concatenated using a delimiter. |
| DepreciationExpenseAccountCombination | String | Segment values for depreciation expense accounts, concatenated using delimiters. |
| AssociateFAToPPMAssetFlag | Bool | Indicates whether the asset number recorded exists in Fixed Assets. The two options are Y and N. The default value is N. |
| Finder | String | finder |
| SysEffectiveDate | String | syseffectivedate |
The project asset assignment resource is used to view project asset assignments, including those from Project Portfolio Management and those imported from third-party applications.
| Name | Type | Description |
| ProjectAssetsProjectAssetId [KEY] | Long | Identifier of the project asset. |
| AssetAssignmentId [KEY] | Long | The system-generated identifier of the asset assignment transaction. This is a mandatory attribute. |
| ProjectAssetId | Long | Identifier of a project asset. This is a mandatory attribute. |
| ProjectId | Long | The identifier of the project to which asset assignment is made. You can enter either this attribute, the project name, or the project number while creating an asset assignment. |
| ProjectName | String | The name of the project to which asset assignment is made. You can enter either this attribute, the project ID, or the project number while creating an asset assignment. |
| ProjectNumber | String | The number of the project to which asset assignment is made. You must enter either this attribute, the project ID, or the project name while creating an asset assignment. |
| TaskId | Long | The identifier of the task to which asset assignment is made. This is a mandatory attribute. You must enter at least this attribute, or the task name or number while creating an asset assignment. The value is 0 on project-level assignments. |
| TaskName | String | The name of the task to which asset assignment is made. You must enter at least this attribute, the task ID, or the task number while creating an asset assignment. |
| TaskNumber | String | The number of the task to which asset assignment is made. You must enter at least this attribute, the task ID, or the Task Name while creating an asset assignment. |
| AssetDescription | String | assetdescription |
| AssetName | String | assetname |
| Finder | String | finder |
| SysEffectiveDate | String | syseffectivedate |
The operations from the Project Assets/Project Asset Descriptive Flexfields category.
| Name | Type | Description |
| ProjectAssetsProjectAssetId [KEY] | Long | Identifier of the project asset. |
| _FLEX_Context | String | Context Prompt |
| _FLEX_Context_DisplayValue | String | Context Prompt |
| AssetDescription | String | assetdescription |
| AssetName | String | assetname |
| Finder | String | finder |
| ProjectAssetId | Long | projectassetid |
| ProjectName | String | projectname |
| SysEffectiveDate | String | syseffectivedate |
The Project Award Distributions resource is used to distribute a cost using the active funding patterns for date ranges that include the expenditure item date provided.
| Name | Type | Description |
| AwardDistributionId [KEY] | Long | Unique identifier of the transactions in the batch. |
| AwardDistributionBatchId | Long | Batch identifier assigned to the set of transactions provided in the input payload. |
| AwardDistributionStatus | String | Award distribution status indicator for the transaction. |
| SourceLineIdOne | String | Primary key identifier populated and used with the batch identifier by the source application that's invoking the award distribution process. |
| SourceLineIdTwo | String | Primary key identifier populated and used with the batch identifier by the source application that's invoking the award distribution process. |
| SourceLineIdThree | String | Primary key identifier populated and used with the batch identifier by the source application that's invoking the award distribution process. |
| SourceLineIdFour | String | Primary key identifier populated and used with the batch identifier by the source application that's invoking the award distribution process. |
| SourceLineIdFive | String | Primary key identifier populated and used with the batch identifier by the source application that's invoking the award distribution process. |
| SourceLineIdSix | String | Primary key identifier populated and used with the batch identifier by the source application that's invoking the award distribution process. |
| TransactionNumber | String | The transaction number that uniquely identifies the source transaction within the application. |
| DistributePatternId | Long | Unique identifier of the funding pattern that was used to distribute the transaction. |
| DistributePatternSetId | Long | Unique identifier of the funding pattern distribution set that was used to distribute the transaction. |
| CreationDate | Datetime | The date when the record was created. |
| CreatedBy | String | The user that created the record. |
| LastUpdateDate | Datetime | The date the record was last updated. |
| LastUpdatedBy | String | The user that last updated the record. |
| ProjectNumber | String | The number of the project on the cost to be distributed. |
| ProjectName | String | The name of the project associated with the cost to be distributed. |
| FundingPatternName | String | The user-defined name of the funding pattern. |
| FundingPatternStart | Date | The start date of the funding pattern that, with the end date, defines the expenditure item date range applicable to the pattern. |
| FundingPatternEnd | Date | The end date of the funding pattern that, with the start date, defines the expenditure item date range applicable to the pattern. |
| FundingPatternTaskNumber | String | The number of the project task defined as a determinant on the funding pattern. |
| FundingPatternTaskName | String | The name of the project task defined as a determinant on the funding pattern. |
| FundingPatternStatus | String | The status of the funding pattern at the time this distribution was created. |
| ProviderLedgerCurrencyCode | String | The provider ledger currency code. |
| DenomCurrencyCode | String | The transaction currency code. |
| Finder | String | finder |
This is a child resource of Project Award Distributions that provides the cost distribution records created by the Award Distribution process.
| Name | Type | Description |
| ProjectAwardDistributionsAwardDistributionId [KEY] | Long | Finds an award distribution based on the unique identifier. |
| AwardDistributionLineId [KEY] | Long | Unique identifier of the distribution line. |
| AwardDistributionId | Long | Unique identifier of the award distribution associated with the distribution line. |
| AwardDistributionStatus | String | Award distribution status indicator associated with the distribution line. |
| DenomRawCost | Decimal | Distributed raw cost upon applying the distribution percentage, in transaction currency. |
| DenomBurdenedCost | Decimal | Distributed burdened cost in transaction currency. |
| RawCostInProviderLedgerCurrency | Decimal | Distributed raw cost in provider ledger currency. |
| BurdenedCostInProviderLedgerCurrency | Decimal | Distributed burdened cost in provider ledger currency. |
| Quantity | Decimal | Quantity distributed upon applying the distribution percentage. |
| FundingSourceId | Long | Identifier of the contract funding source in the distribution rule that created the distribution line. |
| ContractId | Long | Identifier of the contract from the distribution rule that created the distribution line. |
| DistributionPercentage | Double | Percentage of the funding pattern distribution set rule. |
| DistBaseAmount | Decimal | Raw cost from the original transaction, in transaction currency. |
| DistDenomBurdenedCost | Decimal | Burdened cost from original transaction, in transaction currency. |
| DistBurdenedCostInProviderLedgerCurrency | Decimal | Burdened cost from the original transaction, in provider ledger currency. |
| DistRawCostInProviderLedgerCurrency | Decimal | Raw cost from original transaction, in provider ledger currency. |
| DistBaseQuantity | Decimal | Quantity from the original transaction. |
| DistributePatternRuleId | Long | Identifier of the funding pattern distribution set rule. |
| DistributeRuleSetNumber | Int | Number of the funding pattern distribution set. |
| DistributionSetPrecedence | Int | Order in which the distribution rules in the funding pattern distribution set must be applied. |
| CreatedBy | String | The user that created the record. |
| CreationDate | Datetime | The date when the record was created. |
| LastUpdateDate | Datetime | The date the record was last updated. |
| LastUpdatedBy | String | The user that last updated the record. |
| DistributePatternSetId | Long | Identifier of the distribution set that's the parent to the rule used to generate this line. |
| ValidationStatusCode | String | The distribution line validation code, indicating whether it passed project cost validation. |
| BudgetaryControlValueStatus | String | Budgetary control status of the distribution line, indicating whether it passed the check funds process. |
| FundingSourceName | String | The name of the funding source on the funding pattern distribution set rule. |
| FundingSourceNumber | String | The number of the funding source on the funding pattern distribution set rule. |
| DistributionSetName | String | The user-defined name of the distribution set. |
| AwardName | String | The name of the award on the funding pattern distribution set rule. |
| AwardNumber | String | The number of the award on the funding pattern distribution set rule. |
| Finder | String | finder |
The Project Budgets resource is used to view a project budget.
| Name | Type | Description |
| FinancialPlanType | String | Name of the financial plan type used to create the budget version. |
| PlanningAmounts | String | The planning amount, either cost or revenue, that you must specify when using a financial plan type that allows creation of cost and revenue versions separately. |
| PlanVersionId [KEY] | Long | Identifier of the project budget version. |
| PlanVersionNumber | Long | Plan version number for the project budget. |
| PlanVersionName | String | Plan version name for the project budget. |
| PlanVersionDescription | String | Plan version description for the project budget. |
| PlanVersionStatus | String | Plan version status for the project budget. |
| ProjectId | Long | Identifier of the project on which the budget is created. |
| ProjectNumber | String | Number of the project on which the budget is created. |
| ProjectName | String | Name of the project on which the budget is created. |
| BudgetCreationMethod | String | Code that identifies the budget creation method. A list of valid values defined in the PJO_BUDGET_CREATION_METHOD are: MANUAL, GENERATE, and COPY. |
| SourcePlanVersionId | Long | Identifier of the source plan version. The SourcePlanVersionId attributes takes precedence over all the other attributes such as generation source, plan type, and so on. |
| BudgetGenerationSource | String | Value of the financial plan type to create a budget from an existing budget. Valid values are: Financial Plan Type and Project Plan Type. |
| SourcePlanType | String | Name of the financial plan type to create a budget from an existing budget. |
| SourcePlanVersionStatus | String | Status of the source plan version when creating a budget using a financial project plan. Valid values are: Current Working and Baseline. |
| SourcePlanVersionNumber | Long | Number of the source plan version. |
| LockedFlag | Bool | Indicates if the project forecast version is locked. |
| LockedBy | String | Name of the user who has locked the project forecast version. |
| CopyAdjustmentPercentage | Decimal | Percentage value, either positive or negative, used to adjust the existing values when creating new version values. |
| PCRawCostAmounts | Decimal | Budget raw cost amounts in project currency of the budget version. |
| PCBurdenedCostAmounts | Decimal | Budget burdened cost amounts in project currency of the budget version. |
| PCRevenueAmounts | Decimal | Budget revenue amounts in project currency of the budget version. |
| PFCRawCostAmounts | Decimal | Budget raw cost amounts in project ledger currency of the budget version. |
| PFCBurdenedCostAmounts | Decimal | Budget burdened cost amounts in project ledger currency of the budget version. |
| PFCRevenueAmounts | Decimal | Budget revenue amounts in project ledger currency of the budget version. |
| DeferFinancialPlanCreation | String | Indicates that the budget version will be created in a deferred mode. Valid values are Y and N. The default value is Y. A value of Y means that the budget version will be created in a deferred mode by the Process Financial Plan Versions process. A value of N means that the budget version will be created in real time and included in the response of the POST operation. |
| AdministrativeCode | String | Identifies the action that an administrator can perform on the budget version based on specific requirements. Not to be used in typical implementations. |
| PlanningOptionId | Long | Identifier of the planning option setup for the financial or project plan version. |
| ProjectResourcesStatus | String | Status of the project resources to be used for generation. Valid values are: All and Confirmed. |
| RbsVersionId | Long | Identifier of the resource breakdown structure that is attached to the project for which you can view summarized data. |
| PlanningResourceBreakdownStructure | String | Planning resource breakdown structure associated with the project. |
| Finder | String | finder |
The Attachment resource is used to view delete attachments for project budgets.
| Name | Type | Description |
| ProjectBudgetsPlanVersionId [KEY] | Long | Identifier of the project budget version. |
| AttachedDocumentId [KEY] | Long | The unique identifier of the attached document. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| DatatypeCode | String | A value that indicates the data type. |
| FileName | String | The file name of the attachment. |
| DmFolderPath | String | The folder path from which the attachment is created. |
| DmDocumentId | String | The document ID from which the attachment is created. |
| DmVersionNumber | String | The document version number from which the attachment is created. |
| Url | String | The URL of a web page type attachment. |
| CategoryName | String | The category of the attachment. |
| UserName | String | The login credentials of the user who created the attachment. |
| Uri | String | The URI of a Topology Manager type attachment. |
| FileUrl | String | The URI of the file. |
| UploadedText | String | The text content for a new text attachment. |
| UploadedFileContentType | String | The content type of the attachment. |
| UploadedFileLength | Long | The size of the attachment file. |
| UploadedFileName | String | The name to assign to a new attachment file. |
| ContentRepositoryFileShared | Bool | Indicates whether the attachment is shared |
| Title | String | The title of the attachment. |
| Description | String | The description of the attachment. |
| ErrorStatusCode | String | The error code, if any, for the attachment. |
| ErrorStatusMessage | String | The error message, if any, for the attachment. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| FileContents | String | The contents of the attachment. |
| ExpirationDate | Datetime | The expiration date of the contents in the attachment. |
| LastUpdatedByUserName | String | The user name who last updated the record. |
| CreatedByUserName | String | The user name who created the record. |
| AsyncTrackerId | String | Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. |
| FileWebImage | String | The base64 encoded image of the file displayed in .png format if the source is a convertible image. |
| DownloadInfo | String | JSON object represented as a string containing information used to programmatically retrieve a file attachment. |
| PostProcessingAction | String | The name of the action that can be performed after an attachment is uploaded. |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | Long | projectid |
The Planning Options resource is used to view the planning options configured for the project budget version. Planning options are user-definable options, including plan settings, rate settings, currency settings, and generation options that are used to control planning scenarios. Budget versions inherit planning options that are defined for financial plan types.
| Name | Type | Description |
| ProjectBudgetsPlanVersionId [KEY] | Long | Identifier of the project budget version. |
| PlanningOptionId [KEY] | Long | Identifier of the planning option setup for the financial or project plan version. |
| PlanningResourceBreakdownStructure | String | Planning resource breakdown structure associated with the project. |
| PlanningLevel | String | Level of the budget at which amounts can be entered. |
| CalendarType | String | The type of calendar, such as accounting calendar or project accounting calendar, used for entering and displaying periodic financial information. |
| PeriodProfile | String | Defines how time periods are grouped and displayed when editing budget versions. |
| RateDerivationDateType | String | The date type, for example, the system date or a fixed date that is used as the basis for deriving rates for calculating amounts on a none time phase budget version. |
| RateDerivationDate | Datetime | The date that is used as the basis for deriving rates for calculating amounts on a none time phase budget version. |
| CostRateDerivationDateType | String | The date type, for example, the system date or a fixed date that is used as the basis for deriving rates for calculating cost amounts. |
| CostRateDerivationDate | Datetime | The date that is used as the basis for deriving rates for calculating cost amounts. |
| BillRateDerivationDateType | String | The date type, for example, the system date or a fixed date that is used as the basis for deriving rates for calculating revenue amounts. |
| BillRateDerivationDate | Datetime | The date that is used as the basis for deriving rates for calculating revenue amounts. |
| MultipleTransactionCurrencies | String | Indicates that the plan can use multiple transaction currencies. A value of Y indicates that the attribute is selected. A value of N means that the attribute is not selected. |
| DesignateAsApprovedCostBudgetFlag | Bool | Indicates whether a financial plan type is an approved cost budget. |
| DesignateAsApprovedRevenueBudgetFlag | Bool | Indicates whether a financial plan type is an approved revenue budget. |
| CurrentPlanningPeriod | String | Current planning period that drives the display of the periodic information. It can be the project accounting period or accounting period depending on the selected calendar type. This value is not applicable when the calendar type is set to NONE. |
| MaintainManualSpreadOnDateChanges | String | Indicates whether the periodic planning is retained in the plan version on plan line date modifications. A value of Y indicates that the attribute is selected. A value of N means that the attribute is not selected. |
| EnableBudgetaryControls | String | Indicates whether a financial plan type is eligible for integration with budgetary controls. A value of Y indicates that the attribute is selected. A value of N means that the attribute is not selected. |
| AssignTaskResourceInSingleCurrencyFlag | Bool | Indicates whether a budget line is enabled for assigning resources in a single currency for a task. |
| ProjectCurrency | String | Currency for the project. |
| ProjectLedgerCurrency | String | Project ledger currency for the project. |
| UseSameConversionAttributeForAllCurrencyConversionsFlag | Bool | Indicates whether you can use the same currency conversion attribute for all currencies. |
| CostRateTypeForConversionInPC | String | Cost rate type that is used as a cost conversion attribute for project currency. |
| CostDateTypeForConversionInPC | String | Date type that is used as a cost conversion attribute for project currency. |
| CostFixedDateForConversionInPC | Datetime | The date that is used to derive rates for calculating planned costs for project currency. |
| CostRateTypeForConversionInPLC | String | Cost rate type that is used as a cost conversion attribute for project ledger currency. |
| CostDateTypeForConversionInPLC | String | Date type that is used as a cost conversion attribute for project ledger currency. |
| CostFixedDateForConversionInPLC | Datetime | The date that is used to derive rates for calculating planned costs for project ledger currency. |
| RateTypeForCostConversion | String | Cost rate type that is used as a cost conversion attribute for planning currencies. |
| DateTypeForCostConversion | String | Date type that is used as a cost conversion attribute for planning currencies. |
| FixedDateForCostConversion | Datetime | The date that is used to derive rates for calculating planned costs for planning currencies. |
| RevenueRateTypeForConversionInPC | String | Revenue rate type that is used as a revenue conversion attribute for project currency. |
| RevenueDateTypeForConversionInPC | String | Date type that is used as a revenue conversion attribute for project currency. |
| RevenueFixedDateForConversionInPC | Datetime | The date that is used to derive rates for calculating planned revenue for project currency. |
| RevenueRateTypeForConversionInPLC | String | Revenue rate type that is used as a revenue conversion attribute for project ledger currency. |
| RevenueDateTypeForConversionInPLC | String | Date type that is used as a revenue conversion attribute for project ledger currency. |
| RevenueFixedDateForConversionInPLC | Datetime | The date that is used to derive rates for calculating planned revenue for project ledger currency. |
| RateTypeForRevenueConversion | String | Revenue rate type that is used as a revenue conversion attribute for planning currencies. |
| DateTypeForRevenueConversion | String | Date type that is used as a revenue conversion attribute for planning currencies. |
| FixedDateForRevenueConversion | Datetime | The date that is used to derive rates for calculating planned revenue for planning currencies. |
| UsePlanningRatesFlag | Bool | Enables utilization of planning rates for resources and resource classes when calculating budget amounts. |
| BurdenScheduleCostOptions | String | A set of burden multipliers that is maintained for use across projects. Also referred to as a standard burden schedule. |
| PersonCostOptions | String | Rate schedule used for the calculation of cost amounts for named persons. |
| JobCostOptions | String | Rate schedule used for the calculation of cost amounts for jobs. |
| NonlaborResourceCostOptions | String | Rate schedule used for the calculation of cost amounts for non-labor resources. |
| ResourceClassCostOptions | String | Rate schedule used for the calculation of cost amounts for resource classes. This is used for cost calculation when rates are unavailable in rate schedules for named persons, jobs, or non-labor resources. |
| PersonRevenueOptions | String | Rate schedule used for the calculation of revenue amounts for named persons. |
| JobRevenueOptions | String | Rate schedule used for the calculation of revenue amounts for jobs. |
| NonlaborResourceRevenueOptions | String | Rate schedule used for the calculation of revenue amounts for non-labor resources. |
| ResourceClassRevenueOptions | String | Rate schedule used for the calculation of revenue amounts for resource classes. This is used for revenue calculation when rates are unavailable in rate schedules for named persons, jobs, or non-labor resources. |
| RevenueGenerationMethod | String | Determines whether budget revenue is calculated based on quantity and rates, event amounts, or the spread ratio specified for tasks. |
| RetainOverrideRatesFromSourceFlag | Bool | Indicates whether user specified cost and revenue rates from the source must be retained when generating the target budget version. |
| DefaultReportingOption | String | Indicates whether cost or revenue quantity is used for reporting quantity when planning for cost and revenue in a separate budget version. By default, it is set to Cost when planning amounts are cost only or cost and revenue together. When the planning amounts are revenue only, it is set to Revenue. |
| ReportCost | String | Determines the cost amount types that are used to calculate and report margins on budgets. |
| AmountScale | String | The scale on which amounts are displayed on the user interface. For example, if you select to view amounts in 1000s, the $100,000,000 amount is displayed as 100,000. |
| CurrencyType | String | Indicates whether the project currency or the project ledger currency is used for displaying amounts when reviewing budget amounts. |
| ProjectRoleCostOptions | String | Rate schedule used for the calculation of cost amounts for project role. This is used for cost calculation when rates are unavailable in rate schedules for named persons. |
| ProjectRoleRevenueOptions | String | Rate schedule used for the calculation of revenue amounts for project role. This is used for revenue calculation when rates are unavailable in rate schedules for named persons. |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | Long | projectid |
The Amount Type resource is used to select the cost and revenue items to include in a financial plan type.
| Name | Type | Description |
| ProjectBudgetsPlanVersionId [KEY] | Long | Identifier of the project budget version. |
| PlanningoptionsPlanningOptionId [KEY] | Long | Unique identifier of the summary level planning option in the project budget version. |
| AmountTypeId [KEY] | Long | Identifier of the project budget version amoun types. |
| QuantityFlag | Bool | Indicates whether the quantity for a budget version is editable. |
| RawCostFlag | Bool | Indicates whether the raw cost amounts for a budget version are editable. |
| BurdenedCostFlag | Bool | Indicates whether the burdened cost amounts for a budget version are editable. |
| RevenueFlag | Bool | Indicates whether the revenue for a budget version is editable. |
| RawCostRateFlag | Bool | Indicates whether the raw cost rate is editable. |
| BurdenedCostRateFlag | Bool | Indicates whether the burdened cost rate is editable. |
| BillRateFlag | Bool | Indicates whether the revenue rate is editable. |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | Long | projectid |
The Budgetary Control Setting resource is used to view and update project and top resource control levels.
| Name | Type | Description |
| ProjectBudgetsPlanVersionId [KEY] | Long | Identifier of the project budget version. |
| PlanningoptionsPlanningOptionId [KEY] | Long | Unique identifier of the summary level planning option in the project budget version. |
| BudgetaryControlSettingId [KEY] | Long | Identifier of the budgetary control settings for the project budget. |
| ControlBudget | String | Name of the control budget. |
| ControlLevel | String | The budgetary control level for the budget version. |
| DefaultRateType | String | The default rate type for budgetary control for the budget version. |
| TolerancePercentage | Decimal | The budgetary control level tolerance percentage. |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | Long | projectid |
The Export Option resource is used to select the planning options attributes to export.
| Name | Type | Description |
| ProjectBudgetsPlanVersionId [KEY] | Long | Identifier of the project budget version. |
| PlanningoptionsPlanningOptionId [KEY] | Long | Unique identifier of the summary level planning option in the project budget version. |
| ExportOptionId [KEY] | Long | Identifier of the project budget version export options. |
| DisplayRatesAndAmountsInMultipleTransactionCurrenciesFlag | Bool | Indicates whether to display the currency conversion attributes and amounts in multiple transaction currencies if the plan type allows planning in multiple transaction currencies. |
| PlanningCurrency | String | Currency used for planning in the budget line. This value is always set to true and the attribute is exported. |
| PlanningResource | String | Resource used for financial planning in budgets. This value is always set to true and the attribute is exported. |
| ResourceClass | String | Resource class associated with the budget line. This value is always set to true and the attribute is exported. |
| SpreadCurve | String | Spread curve associated with the budget line. This value is always set to true and the attribute is exported. |
| TaskName | String | Name assigned to a task. This value is always set to true and the attribute is exported. |
| TaskNumber | String | Number of the task. This value is always set to true and the attribute is exported. |
| BurdenedCostStandardMultiplier | String | Standard multiplier derived from the burden schedule for calculating burdened cost. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute is not selected for export. |
| BurdenedCostStandardRate | String | Standard rate derived from the rate schedule for calculating the burdened cost. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute is not selected for export. |
| StandardRawCostRate | String | Rate derived from the rate schedule for calculating raw cost. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute is not selected for export. |
| TotalMarginInProjectCurrency | String | Total margin in the project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute is not selected for export. |
| TotalMarginInProjectLedgerCurrency | String | Total margin in the project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute is not selected for export. |
| MarginPercentage | String | Margin expressed as a percentage. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute is not selected for export. |
| TotalBurdenedCostInProjectCurrency | String | Total burdened costs incurred on the project, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute is not selected for export. |
| TotalBurdenedCostInProjectLedgerCurrency | String | Total burdened costs incurred on the project, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute is not selected for export. |
| ProjectCurrencyConversionCostRate | String | Cost rate used when converting the amounts to project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute is not selected for export. |
| ProjectCurrencyConversionCostDate | String | Date that is used as a cost conversion attribute for project currency. A value of Y indicates that the attribute is selected for export. A value of N means that the attribute is not selected for export. |
| ProjectCurrencyConversionCostDateType | String | Date type that is used as a cost conversion attribute for project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute is not selected for export. |
| ProjectCurrencyConversionCostRateType | String | The type of currency conversion rate for the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute is not selected for export. |
| ProjectLedgerCurrencyConversionCostRate | String | Cost rate used when converting the amounts to project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute is not selected for export. |
| ProjectLedgerCurrencyConversionCostDate | String | Date that is used as a cost conversion attribute for project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute is not selected for export. |
| ProjectLedgerCurrencyConversionCostDateType | String | Date type that is used as a cost conversion attribute for project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute is not selected for export. |
| ProjectLedgerCurrencyConversionCostRateType | String | The type of currency conversion rate for the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute is not selected for export. |
| TotalRawCostInProjectCurrency | String | Total raw costs that are directly attributable to the work performed in the current budget, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute is not selected for export. |
| TotalRawCostInProjectLedgerCurrency | String | Total raw costs that are directly attributable to the work performed, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N means that the attribute is not selected for export. |
| ProjectCurrencyConversionRevenueRate | String | Revenue rate used when converting the amounts to project currency. A value of Y indicates that the attribute is selected for export. A value of N means that the attribute is not selected for export. |
| ProjectCurrencyConversionRevenueDate | String | Date that is used as a revenue conversion attribute for project currency. A value of Y indicates that the attribute is selected for export. A value of N means that the attribute is not selected for export. |
| ProjectCurrencyConversionRevenueDateType | String | Date type that is used as a revenue conversion attribute for project currency. A value of Y indicates that the attribute is selected for export. A value of N means that the attribute is not selected for export. |
| ProjectCurrencyConversionRevenueRateType | String | The type of currency conversion rate for the project. A value of Y indicates that the attribute is selected for export. A value of N means that the attribute is not selected for export. |
| ProjectLedgerCurrencyConversionRevenueRate | String | Revenue rate used when converting the amounts to project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N means that the attribute is not selected for export. |
| ProjectLedgerCurrencyConversionRevenueDate | String | Date that is used as a revenue conversion attribute for project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N means that the attribute is not selected for export. |
| ProjectLedgerCurrencyConversionRevenueDateType | String | Date type that is used as a revenue conversion attribute for project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N means that the attribute is not selected for export. |
| ProjectLedgerCurrencyConversionRevenueRateType | String | The type of currency conversion rate for the project. A value of Y indicates that the attribute is selected for export. A value of N means that the attribute is not selected for export. |
| TotalRevenueInProjectCurrency | String | Total planned revenue that is associated with the accounting period or a financial plan line in the budget, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N means that the attribute is not selected for export. |
| TotalRevenueInProjectLedgerCurrency | String | Total planned revenue that is associated with the accounting period or a financial plan line in the budget, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N means that the attribute is not selected for export. |
| StandardRevenueRate | String | Rate derived from the rate schedule for calculating revenue. A value of Y indicates that the attribute is selected for export. A value of N means that the attribute is not selected for export. |
| EffectiveBurdenedCostRate | String | User entered rate for calculating the burdened cost. A value of Y indicates that the attribute is selected for export. A value of N means that the attribute is not selected for export. |
| TotalBurdenedCost | String | Total burdened costs incurred on the project. A value of Y indicates that the attribute is selected for export. A value of N means that the attribute is not selected for export. |
| EffectiveRawCostRate | String | User entered rate for calculating the raw cost. A value of Y indicates that the attribute is selected for export. A value of N means that the attribute is not selected for export. |
| TotalRawCost | String | Total cost directly attributable to the work performed. A value of Y indicates that the attribute is selected for export. A value of N means that the attribute is not selected for export. |
| TotalQuantity | String | Total quantity of resource effort that is required to complete a task or project, including labor and equipment. A value of Y indicates that the attribute is selected for export. A value of N means that the attribute is not selected for export. |
| TotalMargin | String | Total margin (difference between revenue and cost) in a project. A value of Y indicates that the attribute is selected for export. A value of N means that the attribute is not selected for export. |
| EffectiveRevenueRate | String | User entered rate for calculating revenue. A value of Y indicates that the attribute is selected for export. A value of N means that the attribute is not selected for export. |
| TotalRevenue | String | Total planned revenue that is associated with the accounting period or a plan line in the budget. A value of Y indicates that the attribute is selected for export. A value of N means that the attribute is not selected for export. |
| ToDate | String | End date of the budget line. A value of Y indicates that the attribute is selected for export. A value of N means that the attribute is not selected for export. |
| BurdenedCostEffectiveMultiplier | String | Multiplier used to calculate the burdened costs. A value of Y indicates that the attribute is selected for export. A value of N means that the attribute is not selected for export. |
| FromDate | String | From date of the budget line. A value of Y indicates that the attribute is selected for export. A value of N means that the attribute is not selected for export. |
| UnitOfMeasure | String | Unit of measure for a resource. A value of Y indicates that the attribute is selected for export. A value of N means that the attribute is not selected for export. |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | Long | projectid |
The Planning Currency resource is used to view delete project and planning currencies.
| Name | Type | Description |
| ProjectBudgetsPlanVersionId [KEY] | Long | Identifier of the project budget version. |
| PlanningoptionsPlanningOptionId [KEY] | Long | Unique identifier of the summary level planning option in the project budget version. |
| PlanningCurrencyId [KEY] | Long | Identifier of the planning currency. |
| PlanningCurrencyCode | String | Currency code for the planning currency. |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | Long | projectid |
A listing of all the descriptive flexfields available for planning options in project budget versions.
| Name | Type | Description |
| ProjectBudgetsPlanVersionId [KEY] | Long | Identifier of the project budget version. |
| PlanningoptionsPlanningOptionId [KEY] | Long | Unique identifier of the summary level planning option in the project budget version. |
| PlanningOptionId [KEY] | Long | Unique identifier of the summary level planning option in the project budget version. |
| _FLEX_Context | String | Code that identifies the context for the segments of the planning options flexfields. |
| _FLEX_Context_DisplayValue | String | Name of the context for the segments of the planning options flexfields. |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | Long | projectid |
The Planning Resources resource is used to view a project budget line.
| Name | Type | Description |
| ProjectBudgetsPlanVersionId [KEY] | Long | Identifier of the project budget version. |
| PlanningElementId [KEY] | Long | Identifier of a planning element. |
| TaskId | Long | Identifier of the task which is used to create a budgetline |
| TaskNumber | String | Number of the task which is used to create a budgetline. |
| TaskName | String | Name of the task which is used to create a budgetline. |
| RbsElementId | Long | Identifier of the resource used to create the budget line. |
| ResourceName | String | The name of the resource used to create the budget line. |
| UnitOfMeasure | String | The unit, such as Hours, that is used to measure the work or effort that is planned for a resource. |
| PlanningStartDate | Datetime | Budget line start date. |
| PlanningEndDate | Datetime | Budget line end date. |
| MaintainManualSpreadOnDateChanges | String | MaintainManualSpreadOnDateChanges |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | Long | projectid |
The Planning Amounts resource is used to view periodic amounts for a budget line.
| Name | Type | Description |
| ProjectBudgetsPlanVersionId [KEY] | Long | Identifier of the project budget version. |
| PlanningresourcesPlanningElementId [KEY] | Long | Identifier of the project budget line. |
| PlanLineId [KEY] | Long | Identifier of a planning amount line. |
| Quantity | Decimal | Measure of the effort planned for the budget line. |
| Currency | String | Currency code for the budget lines. |
| RawCostAmounts | Decimal | Budget line raw cost amounts in transaction currency. |
| BurdenedCostAmounts | Decimal | Budget line burdened cost amounts in transaction currency. |
| RevenueAmounts | Decimal | Budget line revenue amounts in transaction currency. |
| EffectiveRawCostRate | Decimal | Effective raw cost rate for budget line. |
| StandardRawCostRate | Decimal | Standard raw cost rate for budget line. |
| EffectiveBurdenedCostRate | Decimal | Effective burdened cost rate for budget line. |
| StandardBurdenedCostRate | Decimal | Standard burdened cost rate for budget line. |
| EffectiveRevenueRate | Decimal | Effective revenue rate for budget line. |
| StandardRevenueRate | Decimal | Standard revenue rate for budget line. |
| PCRawCostAmounts | Decimal | Budget line raw cost amounts in project currency. |
| PCBurdenedCostAmounts | Decimal | Budget line burdened cost amounts in project currency. |
| PCRevenueAmounts | Decimal | Budget line revenue amounts in project currency. |
| PFCRawCostAmounts | Decimal | Budget line raw cost amounts in project ledger currency. |
| PFCBurdenedCostAmounts | Decimal | Budget line burdened cost amounts in project ledger currency. |
| PFCRevenueAmounts | Decimal | Budget line revenue amounts in project ledger currency. |
| ManualSpreadFlag | Bool | Indicates if the periodic planning is modified and retained for the plan line on date changes. |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | Long | projectid |
The Plan Lines Descriptive Flexfields resource is used to view additional information for planning amounts in project budgets.
| Name | Type | Description |
| ProjectBudgetsPlanVersionId [KEY] | Long | Identifier of the project budget version. |
| PlanningresourcesPlanningElementId [KEY] | Long | Identifier of the project budget line. |
| PlanningamountsPlanLineId [KEY] | Long | Identifier of the summary level planning amounts for a planning resource in the project budget. |
| PlanLineId [KEY] | Long | Identifier of the summary level planning amounts for a plan line in the project budget. |
| _FLEX_Context | String | Code that identifies the context for the segments of the plan lines flexfields. |
| _FLEX_Context_DisplayValue | String | Name of the context for the segments of the plan lines flexfields. |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | Long | projectid |
The Planning Amount Details resource is used to view periodic amounts for a budget line.
| Name | Type | Description |
| ProjectBudgetsPlanVersionId [KEY] | Long | Identifier of the project budget version. |
| PlanningresourcesPlanningElementId [KEY] | Long | Identifier of the project budget line. |
| PlanningamountsPlanLineId [KEY] | Long | Identifier of the summary level planning amounts for a planning resource in the project budget. |
| PlanLineDetailId [KEY] | Long | Identifier of a plan line detail |
| PeriodName | String | Period for which the budgets are created. |
| Quantity | Decimal | Measure of the effort planned for the budget line by period. |
| RawCostAmounts | Decimal | Periodic budget line raw cost amounts in transaction currency. |
| BurdenedCostAmounts | Decimal | Periodic budget line burdened cost amounts in transaction currency. |
| RevenueAmounts | Decimal | Periodic budget line revenue amounts in transaction currency. |
| EffectiveRawCostRate | Decimal | Effective raw cost rate for periodic line. |
| StandardRawCostRate | Decimal | Standard raw cost rate for periodic line. |
| EffectiveBurdenedCostRate | Decimal | Effective burdened cost rate for periodic line. |
| StandardBurdenedCostRate | Decimal | Standard burdened cost rate for periodic line. |
| EffectiveRevenueRate | Decimal | Effective revenue rate for periodic line. |
| StandardRevenueRate | Decimal | Standard revenue rate for periodic line. |
| PCRawCostAmounts | Decimal | Periodic budget line raw cost amounts in project currency. |
| PCBurdenedCostAmounts | Decimal | Periodic budget line burdened cost amounts in project currency. |
| PCRevenueAmounts | Decimal | Periodic budget line revenue amounts in project currency. |
| PFCRawCostAmounts | Decimal | Periodic budget line raw cost amounts in project ledger currency. |
| PFCBurdenedCostAmounts | Decimal | Periodic budget line burdened cost amounts in project ledger currency. |
| PFCRevenueAmounts | Decimal | Periodic budget line revenue amounts in project ledger currency. |
| ManualSpreadFlag | Bool | Indicates if the periodic planning is modified and retained for the plan line on date changes. |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | Long | projectid |
The Project Budget Summary resource is used to view a project budget.
| Name | Type | Description |
| FinancialPlanType | String | Name of the financial plan type used to create the budget version. |
| PlanVersionId [KEY] | Long | Identifier of the project budget version. |
| PlanVersionNumber | Long | Plan version number for the project budget. |
| PlanVersionName | String | Plan version name for the project budget. |
| PlanVersionDescription | String | Plan version description for the project budget. |
| PlanVersionStatus | String | Plan version status for the project budget. |
| ProjectId | Long | Identifier of the project on which the budget is created. |
| ProjectNumber | String | Number of the project on which the budget is created. |
| ProjectName | String | Name of the project on which the budget is created. |
| PlanningAmounts | String | The planning amount, either cost or revenue, that you must specify when using a financial plan type that allows creation of cost and revenue versions seperately. |
| PCRawCostAmounts | Decimal | Budget raw cost amounts in project currency of the budget version. |
| PCBurdenedCostAmounts | Decimal | Budget burdened cost amounts in project currency of the budget version. |
| PCRevenueAmounts | Decimal | Budget revenue amounts in project currency of the budget version. |
| PFCRawCostAmounts | Decimal | Budget raw cost amounts in project ledger currency of the budget version. |
| PFCBurdenedCostAmounts | Decimal | Budget burdened cost amounts in project ledger currency of the budget version. |
| PFCRevenueAmounts | Decimal | Budget revenue amounts in project ledger currency of the budget version. |
| Finder | String | finder |
The Resources resource is used to view a project budget version resource.
| Name | Type | Description |
| ProjectBudgetSummaryPlanVersionId [KEY] | Long | Identifier of the project budget version. |
| RbsElementId [KEY] | Long | Identifier of the resource used to create the project budget line. |
| ResourceName | String | The name of the resource used to create the project budget line. |
| ResourceFormat | String | Resource format to add resource element to the planning resource breakdown structure. |
| ResourceClass | String | A resource type that is available for use within resource format hierarchies on planning resource breakdown structure. |
| ParentElementId | Long | Identifier of the parent resource breakdown structure element. |
| Quantity | Decimal | Measure of the effort planned for the project budget line. |
| Currency | String | Currency code for the project budget lines. |
| RawCostAmounts | Decimal | Project budget line raw cost amounts in transaction currency. |
| BurdenedCostAmounts | Decimal | Project budget line burdened cost amounts in transaction currency. |
| RevenueAmounts | Decimal | Project budget line revenue amounts in transaction currency. |
| PCRawCostAmounts | Decimal | Project budget line raw cost amounts in project currency. |
| PCBurdenedCostAmounts | Decimal | Project budget line burdened cost amounts in project currency. |
| PCRevenueAmounts | Decimal | Project budget line revenue amounts in project currency. |
| PFCRawCostAmounts | Decimal | Project budget line raw cost amounts in project ledger currency. |
| PFCBurdenedCostAmounts | Decimal | Project budget line burdened cost amounts in project ledger currency. |
| PFCRevenueAmounts | Decimal | Project budget line revenue amounts in project ledger currency. |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | Long | projectid |
The Budget Lines resource is used to view a resource's project budget line.
| Name | Type | Description |
| ProjectBudgetSummaryPlanVersionId [KEY] | Long | Identifier of the project budget version. |
| ResourcesRbsElementId [KEY] | Long | Identifier of the resource used to create the project budget line. |
| TaskId | Long | Identifier of the task which is used to create a budget budget line |
| TaskNumber | String | Number of the task which is used to create a budget budget line. |
| TaskName | String | Name of the task which is used to create a budget budget line. |
| ResourceFormat | String | Resource format to add resource element to the planning resource breakdown structure. |
| ResourceClass | String | A resource type that is available for use within resource format hierarchies on planning resource breakdown structure. |
| SpreadCurve | String | Spread curves distributes quantity, cost, and revenue amounts automatically across accounting or project accounting periods. |
| RbsElementId | Long | Identifier of the resource used to create the project budget line. |
| ResourceName | String | The name of the resource used to create the project budget line. |
| PlanningStartDate | Date | Project budget line start date. |
| PlanningEndDate | Date | Project budget line end date. |
| Quantity | Decimal | Measure of the effort planned for the project budget line. |
| Currency | String | Currency code for the project budget lines. |
| RawCostAmounts | Decimal | Project budget line raw cost amounts in transaction currency. |
| BurdenedCostAmounts | Decimal | Project budget line burdened cost amounts in transaction currency. |
| RevenueAmounts | Decimal | Project budget line revenue amounts in transaction currency. |
| EffectiveRawCostRate | Decimal | Effective raw cost rate for project budget line. |
| StandardRawCostRate | Decimal | Standard raw cost rate for project budget line. |
| EffectiveBurdenedCostRate | Decimal | Effective burdened cost rate for project budget line. |
| StandardBurdenedCostRate | Decimal | Standard burdened cost rate for project budget line. |
| EffectiveRevenueRate | Decimal | Effective revenue rate for project budget line. |
| StandardRevenueRate | Decimal | Standard revenue rate for project budget line. |
| PCRawCostAmounts | Decimal | Project budget line raw cost amounts in project currency. |
| PCBurdenedCostAmounts | Decimal | Project budget line burdened cost amounts in project currency. |
| PCRevenueAmounts | Decimal | Project budget line revenue amounts in project currency. |
| PFCRawCostAmounts | Decimal | Project budget line raw cost amounts in project ledger currency. |
| PFCBurdenedCostAmounts | Decimal | Project budget line burdened cost amounts in project ledger currency. |
| PFCRevenueAmounts | Decimal | Project budget line revenue amounts in project ledger currency. |
| TaskSequence | Long | Position of the task in the hierarchical arrangement. |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | Long | projectid |
The Planning Amount Details resource is used to view a project budget line periodic amounts.
| Name | Type | Description |
| ProjectBudgetSummaryPlanVersionId [KEY] | Long | Identifier of the project budget version. |
| ResourcesRbsElementId [KEY] | Long | Identifier of the resource used to create the project budget line. |
| PeriodName | String | Period for which the periodic budget amount is entered. |
| Quantity | Decimal | Measure of the effort planned for the budget line by period. |
| RawCostAmounts | Decimal | Periodic budget line raw cost amounts in transaction currency. |
| BurdenedCostAmounts | Decimal | Periodic budget line burdened cost amounts in transaction currency. |
| RevenueAmounts | Decimal | Periodic budget line revenue amounts in transaction currency. |
| EffectiveRawCostRate | Decimal | Effective raw cost rate for periodic line. |
| StandardRawCostRate | Decimal | Standard raw cost rate for periodic line. |
| EffectiveBurdenedCostRate | Decimal | Effective burdened cost rate for periodic line. |
| StandardBurdenedCostRate | Decimal | Standard burdened cost rate for periodic line. |
| EffectiveRevenueRate | Decimal | Effective revenue rate for periodic line. |
| StandardRevenueRate | Decimal | Standard revenue rate for periodic line. |
| PCRawCostAmounts | Decimal | Periodic budget line raw cost amounts in project currency. |
| PCBurdenedCostAmounts | Decimal | Periodic budget line burdened cost amounts in project currency. |
| PCRevenueAmounts | Decimal | Periodic budget line revenue amounts in project currency. |
| PFCRawCostAmounts | Decimal | Periodic budget line raw cost amounts in project ledger currency. |
| PFCBurdenedCostAmounts | Decimal | Periodic budget line burdened cost amounts in project ledger currency. |
| PFCRevenueAmounts | Decimal | Periodic budget line revenue amounts in project ledger currency. |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | Long | projectid |
The Tasks resource is used to view a project budget version task.
| Name | Type | Description |
| ProjectBudgetSummaryPlanVersionId [KEY] | Long | Identifier of the project budget version. |
| TaskId [KEY] | Long | Identifier of the task which is used to create a project budget line |
| TaskNumber | String | Number of the task which is used to create a project budget line. |
| TaskName | String | Name of the task which is used to create a project budget line. |
| ParentTaskId | Long | Identifier of the parent task. |
| PlanningStartDate | Date | Scheduled start date of the project task. |
| PlanningEndDate | Date | Scheduled end date of the project task. |
| Quantity | Decimal | Measure of the effort planned for the project budget line. |
| Currency | String | Currency code for the project budget lines. |
| RawCostAmounts | Decimal | Project budget line raw cost amounts in transaction currency. |
| BurdenedCostAmounts | Decimal | Project budget line burdened cost amounts in transaction currency. |
| RevenueAmounts | Decimal | Project budget line revenue amounts in transaction currency. |
| PCRawCostAmounts | Decimal | Project budget line raw cost amounts in project currency. |
| PCBurdenedCostAmounts | Decimal | Project budget line burdened cost amounts in project currency. |
| PCRevenueAmounts | Decimal | Project budget line revenue amounts in project currency. |
| PFCRawCostAmounts | Decimal | Project budget line raw cost amounts in project ledger currency. |
| PFCBurdenedCostAmounts | Decimal | Project budget line burdened cost amounts in project ledger currency. |
| PFCRevenueAmounts | Decimal | Project budget line revenue amounts in project ledger currency. |
| TaskSequence | Long | Position of the task in the hierarchical arrangement. |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | Long | projectid |
The Budget Lines resource is used to view a task's project budget line.
| Name | Type | Description |
| ProjectBudgetSummaryPlanVersionId [KEY] | Long | Identifier of the project budget version. |
| TasksTaskId [KEY] | Long | Identifier of the task which is used to create a project budget line. |
| RbsElementId | Long | Identifier of the resource used to create the project budget line. |
| ResourceName | String | The name of the resource used to create the project budget line. |
| TaskId | Long | Identifier of the task which is used to create a budget budget line |
| TaskNumber | String | Number of the task which is used to create a budget budget line. |
| TaskName | String | Name of the task which is used to create a budget budget line. |
| ResourceFormat | String | Resource format to add resource element to the planning resource breakdown structure. |
| ResourceClass | String | A resource type that is available for use within resource format hierarchies on planning resource breakdown structure. |
| SpreadCurve | String | Spread curves distributes quantity, cost, and revenue amounts automatically across accounting or project accounting periods. |
| PlanningStartDate | Date | Project budget line start date. |
| PlanningEndDate | Date | Project budget line end date. |
| Quantity | Decimal | Measure of the effort planned for the project budget line. |
| Currency | String | Currency code for the project budget lines. |
| RawCostAmounts | Decimal | Project budget line raw cost amounts in transaction currency. |
| BurdenedCostAmounts | Decimal | Project budget line burdened cost amounts in transaction currency. |
| RevenueAmounts | Decimal | Project budget line revenue amounts in transaction currency. |
| EffectiveRawCostRate | Decimal | Effective raw cost rate for project budget line. |
| StandardRawCostRate | Decimal | Standard raw cost rate for project budget line. |
| EffectiveBurdenedCostRate | Decimal | Effective burdened cost rate for project budget line. |
| StandardBurdenedCostRate | Decimal | Standard burdened cost rate for project budget line. |
| EffectiveRevenueRate | Decimal | Effective revenue rate for project budget line. |
| StandardRevenueRate | Decimal | Standard revenue rate for project budget line. |
| PCRawCostAmounts | Decimal | Project budget line raw cost amounts in project currency. |
| PCBurdenedCostAmounts | Decimal | Project budget line burdened cost amounts in project currency. |
| PCRevenueAmounts | Decimal | Project budget line revenue amounts in project currency. |
| PFCRawCostAmounts | Decimal | Project budget line raw cost amounts in project ledger currency. |
| PFCBurdenedCostAmounts | Decimal | Project budget line burdened cost amounts in project ledger currency. |
| PFCRevenueAmounts | Decimal | Project budget line revenue amounts in project ledger currency. |
| TaskSequence | Long | Position of the task in the hierarchical arrangement. |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | Long | projectid |
The Planning Amount Details resource is used to view a project budget line periodic amounts.
| Name | Type | Description |
| ProjectBudgetSummaryPlanVersionId [KEY] | Long | Identifier of the project budget version. |
| TasksTaskId [KEY] | Long | Identifier of the task which is used to create a project budget line. |
| PeriodName | String | Period for which the periodic budget amount is entered. |
| Quantity | Decimal | Measure of the effort planned for the budget line by period. |
| RawCostAmounts | Decimal | Periodic budget line raw cost amounts in transaction currency. |
| BurdenedCostAmounts | Decimal | Periodic budget line burdened cost amounts in transaction currency. |
| RevenueAmounts | Decimal | Periodic budget line revenue amounts in transaction currency. |
| EffectiveRawCostRate | Decimal | Effective raw cost rate for periodic line. |
| StandardRawCostRate | Decimal | Standard raw cost rate for periodic line. |
| EffectiveBurdenedCostRate | Decimal | Effective burdened cost rate for periodic line. |
| StandardBurdenedCostRate | Decimal | Standard burdened cost rate for periodic line. |
| EffectiveRevenueRate | Decimal | Effective revenue rate for periodic line. |
| StandardRevenueRate | Decimal | Standard revenue rate for periodic line. |
| PCRawCostAmounts | Decimal | Periodic budget line raw cost amounts in project currency. |
| PCBurdenedCostAmounts | Decimal | Periodic budget line burdened cost amounts in project currency. |
| PCRevenueAmounts | Decimal | Periodic budget line revenue amounts in project currency. |
| PFCRawCostAmounts | Decimal | Periodic budget line raw cost amounts in project ledger currency. |
| PFCBurdenedCostAmounts | Decimal | Periodic budget line burdened cost amounts in project ledger currency. |
| PFCRevenueAmounts | Decimal | Periodic budget line revenue amounts in project ledger currency. |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | Long | projectid |
The Version Errors resource is used to view project budget version errors.
| Name | Type | Description |
| ProjectBudgetSummaryPlanVersionId [KEY] | Long | Identifier of the project budget version. |
| ErrorType | String | Specifies whether a warning or error. |
| TaskNumber | String | Number of the task which is used to create a budgetline. |
| TaskName | String | Name of the task which is used to create a budgetline. |
| ResourceName | String | The name of the resource used to create the budget line. |
| PeriodName | String | Period for which the periodic budget amount is entered. |
| MessageText | String | Error or warning that occurrs or information that informs users, to know what action to take or to understand what is happening. |
| TransactionCurrencyCode | String | Currency code for budget line with errors. |
| MessageUserDetails | String | More detailed explanation of message text that states why the message occurred. |
| MessageCause | String | Explanation for the reason of an error or warning message. |
| MessageUserAction | String | States the response that end users must perform to continue and complete their tasks in response to an error or warning message. |
| MessageName | String | Message code for the issue encountered. |
| PlanVersionId | Long | Identifier of the project budget version. |
| TaskSequence | Long | Position of the task in the hierarchical arrangement. |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| ProjectId | Long | projectid |
The Version Errors resource is used to view project budget version errors.
| Name | Type | Description |
| ProjectBudgetsPlanVersionId [KEY] | Long | Identifier of the project budget version. |
| PlanVersionId | Decimal | Identifier of the project budget version. |
| TaskNumber | String | Number of the task which is used to create a budget line. |
| TaskName | String | Name of the task which is used to create a budget line. |
| ResourceName | String | The name of the resource which is used to create a budget line. |
| TransactionCurrencyCode | String | Currency code for budget line with errors. |
| PeriodName | String | Period for which the periodic budget amount is entered. |
| ErrorType | String | Specifies whether a warning or error. |
| MessageName | String | Message code for the issue encountered. |
| MessageText | String | Error or warning that occurs or information that informs users to know what action to take or to understand what is happening. |
| MessageCause | String | Explanation for the resaon of an error or warning message. |
| MessageUserDetails | String | More detailed explanation of the message text that explains why the message occurred. |
| MessageUserAction | String | States the response that the end users must perform to continue and complete their tasks in response to an error or warning message. |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| ProjectId | Long | projectid |
The LOV for Project Class Codes resource is used to view a list of values of project class codes. This object includes attributes which are used to store values of a project class code.
| Name | Type | Description |
| ClassCategoryId | Long | Identifier of the project class category. |
| ClassCodeId [KEY] | Long | Identifier of the project class code. |
| Name | String | Name of the project class code. A class code is a value within a class category that can be used to classify a project. |
| Description | String | Description of the project class code. A class code is a value within a class category that can be used to classify a project. |
| FromDate | Date | The date from which a project class code is active. |
| ToDate | Date | The date after which a project class code is no longer active. |
| CategoryId | Long | categoryid |
| Finder | String | finder |
| ProjectUnitId | Long | projectunitid |
| SearchTerm | String | searchterm |
| UserDate | Date | userdate |
The project commitments resource is used to view project commitments. This includes viewing, creating, and deleting project commitments that are imported from third-party applications and viewing commitments that are created in other Oracle Fusion applications such as supplier invoices, requisitions, purchase orders, and so on.
| Name | Type | Description |
| CommitmentId [KEY] | Long | Unique identifier of the commitment transaction. |
| CommitmentNumber | String | Number of the commitment transaction. Examples include purchase requisition number, purchase order number, supplier invoice number, and external commitment transaction number. |
| BusinessUnitId | Long | Identifier of the expenditure business unit that incurred the commitment cost. You must enter at least one from among this attribute and Business Unit while creating a project commitment. |
| BusinessUnit | String | Name of the expenditure business unit that incurred the commitment cost. You must enter at least one from among this attribute and Business Unit ID while creating a project commitment. |
| OrganizationId | Long | Identifier of the expenditure organization to which the commitment cost is charged. You must enter at least one from among this attribute and Organization while creating a project commitment. The organization must be an active project expenditure organization as of the expenditure item date. |
| Organization | String | Name of the expenditure organization to which the commitment cost is charged. You must enter at least one from among this attribute and Organization ID while creating a project commitment. The organization must be an active project expenditure organization as of the expenditure item date. |
| TransactionSourceId | Long | Identifier of the application in which the commitment transaction was originally created. You must enter at least one from among this attribute and Transaction Source while creating a project commitment. |
| TransactionSource | String | Name of the application in which the commitment transaction was originally created. You must enter at least one from among this attribute and Transaction Source ID while creating a project commitment. |
| DocumentId | Long | Identifier of the document used to capture the commitment transaction. You must enter at least one from among this attribute and Document while creating a project commitment. The document must be active and enabled for commitment sources. |
| Document | String | Name of the document used to capture the commitment transaction. You must enter at least one from among this attribute and Document ID while creating a project commitment. The document must be active and enabled for commitment sources. |
| DocumentEntryId | Long | Identifier of the document entry used to capture the commitment transaction. You must enter at least one from among this attribute and Document Entry while creating a project commitment. |
| DocumentEntry | String | Name of the document entry used to capture the commitment transaction. You must enter at least one from among this attribute and Document Entry ID while creating a project commitment. |
| ProjectId | Long | Identifier of the project to which the commitment cost is charged. You must enter at least one from among this attribute, Project Number, and Project Name while creating a project commitment. The project must be active and in an appropriate status. |
| ProjectNumber | String | Number of the project to which the commitment cost is charged. You must enter at least one from among this attribute, Project ID, and Project Name while creating a project commitment. The project must be active and in an appropriate status. |
| ProjectName | String | Name of the project to which the commitment cost is charged. You must enter at least one from among this attribute, Project ID, and Project Number while creating a project commitment. The project must be active and in an appropriate status. |
| TaskId | Long | Identifier of the task to which the commitment cost is charged. You must enter at least one from among this attribute, Task Number, and Task Name while creating a project commitment. The task must be active and included in a published task structure. |
| TaskNumber | String | Number of the task to which the commitment cost is charged. You must enter at least one from among this attribute, Task ID, and Task Name while creating a project commitment. The task must be active and included in a published task structure. |
| TaskName | String | Name of the task to which the commitment cost is charged. You must enter at least one from among this attribute, Task ID, and Task Number while creating a project commitment. The task must be active and included in a published task structure. |
| CommitmentSourceType | String | Identifies the commitment transaction as either internal or external. A list of accepted values - Internal, External, or All - is defined in the lookup type PJC_COMMITMENT_TYPE. Default value is External while creating a project commitment. |
| CommitmentType | String | Identifies the commitment transaction as either purchase requisition, purchase order, supplier invoice, or external. A list of accepted values is defined in the lookup type PJC_CMT_LINE_TYPE. Default value is External while creating a project commitment. |
| ProcessingStatus | String | Identifies the commitment transaction as either unprocessed, processed, or error. A list of accepted values - Processed, Unprocessed, or Error - is defined in the lookup type PJC_CMT_PROCESSING_STATUS. Default value is Unprocessed while creating a project commitment. |
| ApprovedFlag | Bool | Identifies if the commitment transaction is approved or not in the source application. A value of true means that the project commitment is in approved status and a value of false means that the project commitment is not in approved status. |
| CommitmentCreationDate | Date | Date on which the commitment transaction is created. Default value is the system date while creating a project commitment. |
| OriginalTransactionReference | String | Original transaction reference of a third-party commitment transaction. If duplicate references aren't allowed by the document, then multiple project commitments can't refer to the same original transaction. |
| OriginallyOrderedQuantity | Decimal | Original quantity on the purchase order. |
| OriginallyOrderedAmount | Decimal | Original amount on the purchase order. |
| OrderedAmount | Decimal | Amount ordered on the purchase order. |
| DeliveredAmount | Decimal | Amount on the purchase order that is delivered. |
| CanceledAmount | Decimal | Amount on the purchase order that is cancelled. |
| OverbilledAmount | Decimal | Amount that is overbilled by the supplier. |
| InvoicedAmount | Decimal | Amount on the purchase order that is invoiced. |
| OutstandingInvoiceAmount | Decimal | Amount on the purchase order that is not yet invoiced by the supplier. |
| OutstandingDeliveryAmount | Decimal | Amount for the purchase order quantity that is not yet delivered. |
| OrderedQuantity | Decimal | Quantity ordered on the purchase order. |
| DeliveredQuantity | Decimal | Quantity on the purchase order that is delivered. |
| CanceledQuantity | Decimal | Quantity on the purchase order that is cancelled. |
| InvoicedQuantity | Decimal | Quantity on the purchase order that is invoiced. |
| OverbilledQuantity | Decimal | Quantity that is overbilled by the supplier. |
| OutstandingInvoiceQuantity | Decimal | Quantity on the purchase order that is not yet invoiced by the supplier. |
| OutstandingDeliveryQuantity | Decimal | Quantity on the purchase order that is not yet delivered. |
| Quantity | Decimal | Quantity entered on the commitment transaction. You must enter a value for this attribute while creating a project commitment that is not externally costed and uses a rate-based expenditure type. |
| Currency | String | Code identifying the currency in which the commitment transaction cost is incurred. You must enter a value for this attribute for project commitment transactions that are externally costed or accounted. The currency must be an active valid general ledger currency. |
| BurdenedCostInTransactionCurrency | Decimal | Total committed cost in the transaction currency for the project. You must provide a value for this attribute while creating an externally burdened project commitment transaction for a project that is enabled for burdening. |
| RawCostInTransactionCurrency | Decimal | Cost committed in the transaction currency for the project that is directly attributable to the work performed. You must provide a value for this attribute while creating an externally costed project commitment transaction. |
| RawCostInProjectCurrency | Decimal | Cost committed in the project currency for the project that is directly attributable to the work performed . |
| BurdenedCostInProjectCurrency | Decimal | Total committed cost in the project currency for the project. |
| RawCostInReceiverLedgerCurrency | Decimal | Cost committed in the receiver ledger currency for the project that is directly attributable to the work performed. |
| BurdenedCostInReceiverLedgerCurrency | Decimal | Total committed cost in the receiver ledger currency for the project. |
| RawCostInProviderLedgerCurrency | Decimal | Cost committed in the provider ledger currency for the project that is directly attributable to the work performed. You must provide a value for this attribute while creating an externally accounted project commitment transaction. |
| BurdenedCostInProviderLedgerCurrency | Decimal | Total committed cost in the provider ledger currency for the project. You must provide a value for this attribute while creating a project commitment transaction for which the burdened cost is accounted externally. |
| ExpenditureTypeId | Long | Identifier of the expenditure type. You must enter at least one from among this attribute and Expenditure Type while creating a project commitment. The expenditure type must be active as of the expenditure item date. |
| ExpenditureType | String | A classification of cost that is assigned to each project commitment transaction. Expenditure types are grouped into cost groups (expenditure categories) and revenue groups (revenue categories). You must enter at least one from among this attribute and Expenditure Type ID while creating a project commitment. The expenditure type must be active as of the expenditure item date. |
| ExpenditureItemDate | Date | Date on which the commitment cost was incurred. The expenditure item date must lie within the project start and finish dates. |
| ProviderProjectAccountingDate | Date | Date used to determine the provider project accounting period of the commitment transaction. |
| ProviderProjectAccountingPeriod | String | Project accounting period of the commitment transaction in the project accounting calendar of the provider organization. |
| ProviderAccountingDate | Date | Date used to determine the provider accounting period for a commitment transaction. You must provide a value for this attribute for an externally accounted project commitment transaction. |
| ProviderAccountingPeriod | String | Accounting period of the commitment transaction in the accounting calendar of the provider organization. |
| ReceiverAccountingPeriod | String | Accounting period of the commitment transaction in the accounting calendar of the receiver organization. The receiver is the organization that owns the project that incurred the commitment cost. |
| ReceiverAccountingDate | Date | Date used to determine the receiver accounting period for a commitment transaction. The receiver is the organization that owns the project that incurred the commitment cost. |
| ReceiverProjectAccountingDate | Date | Date used to determine the receiver project accounting period of the commitment transaction. The receiver is the organization that owns the project that incurred the commitment cost. |
| ReceiverProjectAccountingPeriod | String | Project accounting period of the commitment transaction in the project accounting calendar of the receiver organization. The receiver is the organization that owns the project that incurred the commitment cost. |
| NeedByDate | Date | Date by which the materials must be delivered. |
| PromisedDate | Date | Date by which the supplier has committed to deliver the materials. |
| CapitalizableFlag | Bool | Specifies whether the commitment transaction is capitalizable. A value of true means that the project commitment transaction is capitalizable and a value of false means that the project commitment transaction is not capitalizable. |
| BillableFlag | Bool | Specifies whether the commitment transaction is billable. A value of true means that the project commitment transaction is billable and a value of false means that the project commitment transaction is not billable. |
| InventoryItemId | Long | Identifier of the inventory item for the commitment cost. You must enter at least one from among this attribute, Inventory Item, and Inventory Item Number while creating a project inventory commitment. |
| InventoryItemNumber | String | Number of the inventory item for the commitment cost. You must enter at least one from among this attribute, Inventory Item, and Inventory Item ID while creating a project inventory commitment. |
| UnitOfMeasureCode | String | Code identifying the unit of measure of the item that is requested, ordered, or supplied. You must enter at least one from among this attribute or Unit of Measure while creating a project commitment that is not externally costed. |
| UnitOfMeasure | String | Name of the unit of measure for the item that is requested, ordered, or supplied. You must enter at least one from among this attribute and Unit of Measure Code while creating a project commitment that is not externally costed. |
| UnitPrice | Decimal | Price per unit of the item that is requested, ordered, or supplied. You cannot enter a value less than zero. |
| SupplierId | Long | Identifier of the supplier who sent the invoice. You can enter either this attribute or Supplier or both while creating a project commitment. The supplier must be active as of the expenditure item date. |
| Supplier | String | Name of the supplier who sent the invoice. You can enter either this attribute or Supplier ID or both while creating a project commitment. The supplier must be active as of the expenditure item date. |
| Requester | String | Name of the person who created the purchase requisition. |
| Buyer | String | Name of the buyer mentioned on the purchase order. |
| WorkTypeId | Long | Identifier of the work type for the commitment transaction. You can enter either this attribute or Work Type or both while creating a project commitment. The work type must be active as of the expenditure item date. |
| WorkType | String | Name of the work type for the commitment transaction. You can enter either this attribute or Work Type ID or both while creating a project commitment. The work type must be active as of the expenditure item date. |
| ContractId | Long | Identifier of the contract for the commitment transaction of a sponsored project. If the sponsored project is associated to multiple contracts then you must enter at least one from among this attribute, Contract Name, and Contract Number while creating a project commitment. If the sponsored project is associated to a single contract, then the default value is the identifier of the associated contract. The contract must be in one of the following statuses: Draft, Active, Under amendment, or Expired. |
| ContractName | String | Name of the contract for the commitment transaction of a sponsored project. If the sponsored project is associated to multiple contracts then you must enter at least one from among this attribute, Contract ID, and Contract Number while creating a project commitment. If the sponsored project is associated to a single contract, then the default value is the name of the associated contract. The contract must be in one of the following statuses: Draft, Active, Under amendment, or Expired. |
| ContractNumber | String | Number of the contract for the commitment transaction of a sponsored project. If the sponsored project is associated to multiple contracts then you must enter at least one from among this attribute, Contract ID, and Contract Name while creating a project commitment. If the sponsored project is associated to a single contract, then the default value is the number of the associated contract. The contract must be in one of the following statuses: Draft, Active, Under amendment, or Expired. |
| FundingSourceId | String | Identifier of the funding source of a project commitment that is processed for sponsored project costing. If the sponsored project is associated to multiple contracts or a single contract with multiple funding sources then you must enter at least one from among this attribute and Funding Source while creating a project commitment. If the sponsored project is associated to a single contract and a single funding source, then the default value is the identifier of the associated funding source. |
| FundingSource | String | Funding source of a project commitment that is processed for sponsored project costing. If the sponsored project is associated to multiple contracts or a single contract with multiple funding sources then you must enter at least one from among this attribute and Funding Source ID while creating a project commitment. If the sponsored project is associated to a single contract and a single funding source, then the default value is the name of the associated funding source. |
| AwardBudgetPeriod | String | Interval of time (usually twelve months) into which the duration of an award project is divided for budgetary and funding purposes. The award budget period must lie within the project and award start and finish dates. |
| Finder | String | finder |
| SysEffectiveDate | String | syseffectivedate |
The Project Costs resource is used to view project costs. Project costs are the smallest logical units of expenditure that you can charge to a project or task. For example, a time card item or an expense report item.
| Name | Type | Description |
| TransactionNumber [KEY] | Long | Identifier of the project cost. |
| BurdenedCostInProviderLedgerCurrency | Decimal | Total project cost in the provider ledger currency that includes the burden cost. |
| ProviderLedgerCurrencyCode | String | Code of the currency of the ledger that owns the resource that is incurring the project cost. This currency is used for accounting and reporting in the provider ledger. |
| ProviderLedgerCurrencyConversionRate | Decimal | The ratio at which the principal unit of transaction currency is converted to provider ledger currency. |
| ProviderLedgerCurrencyConversionDate | Date | The date for which to obtain currency conversion rate that is used to convert amounts in transaction currency to provider ledger currency. |
| ProviderLedgerCurrencyConversionRateType | String | The source of a currency conversion rate that determines how to convert amounts in transaction currency to provider ledger currency. |
| RawCostInProviderLedgerCurrency | Decimal | Project cost in the provider ledger currency that is directly attributable to the work performed. |
| BillableFlag | Bool | Specifies if the project cost is billable. A value of true means that the project cost is billable and a value of false means that the project cost is not billable. |
| FundsStatus | String | Status of funds check or funds reservation validation result. A list of valid values - Failed, Passed, and Warning - is defined in the lookup type PJC_XCC_STATUS. |
| CapitalizableFlag | Bool | Specifies if the project cost is capitalizable. A value of true means that the project cost is capitalizable and a value of false means that the project cost is not capitalizable. |
| ContractId | Long | Identifier of the contract for the project cost of a sponsored project. |
| ConvertedFlag | Bool | Indicates if the project cost was converted from a legacy system. A value of true means that the project cost is converted from a legacy system and a value of false means that the project cost is not converted from a legacy system. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| BurdenedCostInTransactionCurrency | Decimal | Total project cost in the transaction currency for a project that is enabled for burdening, including the burden cost. |
| RawCostInTransactionCurrency | Decimal | Project cost in the transaction currency that is directly attributable to the work performed |
| DocumentEntryId | Long | Identifier of the document entry used to capture the project cost. |
| DocumentId | Long | Identifier of the document used to capture the project cost. |
| ExpenditureItemDate | Date | Date on which the project cost was incurred. |
| ExpenditureOrganizationId | Long | Identifier of the expenditure organization to which the project cost is charged. |
| ExpenditureTypeId | Long | Identifier of the expenditure type. |
| AssignmentId | Long | Identifier of the human resources assignment of the person that incurred the cost that was charged to the project. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| NonlaborResourceId | Long | Identifier of a resource other than human labor through which the project cost is incurred. For example, use of company-owned equipment or internal telecommunications services. |
| NonlaborResourceOrganizationId | Long | Identifier of the organization that owns the nonlabor resource incurring the project cost. |
| OriginalTransactionReference | String | Original transaction reference of a third-party project cost. If duplicate references aren't allowed by the document, then multiple project costs can't refer to the same original transaction. |
| AccrualItemFlag | Bool | Indicates if the project cost belongs to an expenditure batch that will accrue cost in a period and automatically reverse them in the next period. A value of true means that the project cost is an accrual item and a value of false means that the project cost is not an accrual item. |
| PersonType | String | The type used to classify the person in human resources. A list of valid values - Employee and Contingent worker - is defined in the lookup type PJF_PERSON_TYPE. |
| BurdenedCostInProjectCurrency | Decimal | Total project cost in the currency of the project that is incurring the unprocessed cost, including the burden cost. |
| ProjectId | Long | Identifier of the project to which the cost is charged. |
| RawCostInProjectCurrency | Decimal | Project cost that is directly attributable to the work performed in the currency of the project that is incurring the cost. |
| Quantity | Decimal | Quantity entered on the project cost. |
| RawCostRateInTransactionCurrency | Decimal | Project cost in the transaction currency that is directly attributable to the work performed. |
| FundingSourceId | String | Identifier of the funding source of a sponsored project cost. |
| TaskId | Long | Identifier of the task to which the project cost is charged. |
| TransactionSourceId | Long | Identifier of the application in which the project cost was originally created. |
| UnitOfMeasureCode | String | Code that identifies the unit of measure for the item that is requested, ordered, or supplied. |
| WorkTypeId | Long | Identifier of the work type for the project cost. |
| ExpenditureBusinessUnitId | Long | Identifier of the expenditure business unit that incurred the project cost. |
| ExpenditureBusinessUnit | String | Name of the expenditure business unit that incurred the project cost. |
| Document | String | Name of the document used to capture the project cost. |
| DocumentEntry | String | Name of the document entry used to capture the project cost. |
| ProjectName | String | Name of the project to which the cost is charged. |
| ProjectNumber | String | Number of the project to which the cost is charged. |
| TaskName | String | Name of the task to which the project cost is charged. |
| TaskNumber | String | Number of the task to which the project cost is charged. |
| ExpenditureType | String | A classification of cost that is assigned to each project cost. Expenditure types are grouped into cost groups (expenditure categories) and revenue groups (revenue categories). |
| ExpenditureCategory | String | The cost group associated with a project cost. The expenditure category is derived based on the expenditure type and it is a method of grouping expenditure types by the type of cost. |
| ContractName | String | Name of the contract for the project cost of a sponsored project. |
| ContractNumber | String | Number of the contract for the project cost of a sponsored project. |
| FundingSourceName | String | Name of the funding source of a sponsored project cost. |
| FundingSourceNumber | String | Number of the funding source of a sponsored project cost. |
| WorkType | String | Name of the work type for the project cost. |
| PersonName | String | Name of an individual human team member through whom the project cost is incurred. A person must be associated with all time card and expense report transactions and is optional for other types of transactions. |
| PersonNumber | String | Number that uniquely identifies the person who is associated with the project cost. A person must be associated with all time card and expense report transactions and is optional for other types of transactions. It does not have any relation to any national identifier component. |
| PersonId | Long | Identifier of the person through whom the project cost is incurred. A person must be associated with all time card and expense report transactions and is optional for other types of transactions. |
| String | Email address of the person through whom the project cost is incurred. A person must be associated with all time card and expense report transactions and is optional for other types of transactions. | |
| AssignmentName | String | Name of the human resources assignment of the person that incurred the cost that was charged to the project. |
| AssignmentNumber | String | Number of the human resources assignment of the person that incurred the cost that was charged to the project. |
| Job | String | Name of the job that is being performed by the person that incurred the project cost that was charged to the task. |
| JobId | Long | Identifier of the job that is being performed by the person that incurred the project cost that was charged to the task. |
| UnitOfMeasure | String | Name of the unit of measure for the item that is requested, ordered, or supplied. |
| UserExpenditureBatch | String | The name of the expenditure group batch that you provide while creating project costs. |
| NonlaborResourceOrganization | String | Name of the organization that owns the nonlabor resource incurring the project cost. |
| Comment | String | Comment entered for the project cost. |
| ExternalBillRate | Decimal | The unit rate at which a project cost is billed on external contracts. |
| ExternalBillRateCurrency | String | The currency in which a project cost is billed on external contracts. |
| ExternalBillRateSourceName | String | Name of the external source application from where the external bill rate originates. |
| ExternalBillRateSourceReference | String | Identifier of the external bill rate in the external source application. |
| IntercompanyBillRate | Decimal | The unit rate at which a project cost is billed on intercompany contracts. |
| IntercompanyBillRateCurrency | String | The currency in which a project cost is billed on intercompany contracts. |
| IntercompanyBillRateSourceName | String | The name of the external source application from where the intercompany bill rate originates. |
| IntercompanyBillRateSourceReference | String | Identifier of the intercompany bill rate in the external source application. |
| TransactionCurrency | String | The currency in which the project cost was incurred. |
| TransferredFromTransactionNumber | Long | The transaction number of the original project cost which was transferred from a different project, task, contract, or funding source resulting in the creation of the project cost. |
| AdjustingItem | Long | Indicates that the project cost transaction was created as a result of adjusting another project cost. A value of true means that the project cost was created due to the adjustment of another project cost and a value of false or null means that the project cost wasn't created due to the adjustment of another project cost. |
| AllowAdjustments | String | Indicates if the project cost is eligible to be adjusted. A value of true means that you can perform adjustments on the project cost and a value of false means that you can't perform adjustments on the project cost. You can perform adjustments on the project cost if adjustment is allowed at the document entry level, the project cost is not already under adjustment, and if the project cost is not an accrual item. |
| RevenueCategoryCode | String | Code that identifies the grouping of expenditure types or events by type of revenue. For example, a revenue category with a name of Labor refers to labor revenue. |
| CapitalEventNumber | Long | Identifying number of the capital event associated with the project cost. |
| NetZeroItemFlag | Bool | Indicates that the project cost has either been reversed or is reversing another project cost, resulting in a sum of zero for the two costs together. A value of true means that the project cost has a matching reversal cost and a value of false means that the project cost doesn't have a matching reversal cost. |
| ExpenditureTypeClass | String | Additional classification of the project cost that drives the expenditure processing for the project cost. |
| RawCostInReceiverLedgerCurrency | Decimal | Project cost in the receiver ledger currency that is directly attributable to the work performed. |
| BurdenedCostInReceiverLedgerCurrency | Decimal | Total project cost in the receiver ledger currency that includes the burden cost. |
| InvoicedPercentage | Decimal | The percentage of the project cost that has been included on invoices. |
| IntercompanyInvoicedPercentage | Decimal | The percentage of the project cost that has been included on intercompany invoices. |
| IntercompanyInvoiceStatus | String | Indicates if the project cost has been included on an intercompany invoice. A list of valid values is defined in the lookup type ORA_PJC_TXN_BILLING_STATUS. |
| InvoicedStatus | String | Indicates if the project cost has been included on an invoice. A list of valid values is defined in the lookup type ORA_PJC_TXN_BILLING_STATUS. |
| HoldRevenueFlag | Bool | Indicates that the project cost is being held from recognizing revenue. A value of true means that the project cost is being held from recognizing revenue and a value of false means that the project cost is not being held from recognizing revenue. |
| HoldIntercompanyRevenueFlag | Bool | Indicates that the project cost is being held from recognizing intercompany revenue. A value of true means that the project cost is being held from recognizing intercompany revenue and a value of false means that the project cost is not being held from recognizing intercompany revenue. |
| IntercompanyInvoiceAmountInProviderLedgerCurrency | Decimal | The intercompany invoice amount of the project cost, denoted in provider ledger currency. |
| IntercompanyRevenueInProviderLedgerCurrency | Decimal | The intercompany revenue amount of the project cost, denoted in provider ledger currency. |
| InvoiceAmountInReceiverLedgerCurrency | Decimal | The invoice amount of the project cost, denoted in receiver ledger currency. |
| RevenueInReceiverLedgerCurrency | Decimal | The revenue amount of the project cost, denoted in receiver ledger currency. |
| RecognizedRevenuePercentage | Decimal | The percentage of the project cost that has been revenue recognized. |
| IntercompanyRecognizedRevenuePercentage | Decimal | The percentage of the project cost that has been recognized for intercompany revenue. |
| TransferPriceInProviderLedgerCurrency | Decimal | The transfer price of the project cost denoted in provider ledger currency. |
| TransferPriceInTransactionCurrency | Decimal | The transfer price of the project cost denoted in transaction currency. |
| TransferPriceInProjectCurrency | Decimal | The transfer price of the project cost denoted in project currency. |
| TransferPriceInReceiverLedgerCurrency | Decimal | The transfer price of the project cost denoted in receiver ledger currency. |
| HoldInvoiceFlag | Bool | Indicates if the project cost is being held from inclusion on an invoice. A value of true means that the project cost is being held from inclusion on an invoice and a value of false means that the project cost is not being held from inclusion on an invoice. |
| HoldIntercompanyInvoiceFlag | Bool | Indicates if the project cost is being held from inclusion on an intercompany invoice. A value of true means that the project cost is being held from inclusion on an intercompany invoice and a value of false means that the project cost is not being held from inclusion on an intercompany invoice. |
| IntercompanyRevenueStatus | String | Indicates if the project cost has been recognized for intercompany revenue. A list of valid values is defined in the lookup type PJB_EVT_REVENUE_RECOGNZD. |
| RevenueStatus | String | Indicates if the project cost has been recognized for revenue. A list of valid values is defined in the lookup type PJB_EVT_REVENUE_RECOGNZD. |
| ExpenditureTypeClassCode | String | Code that identifies the additional classification of the project cost that drives the expenditure processing for the project cost. |
| AdjustmentStatus | String | Indicates the status of an adjustment made to the project cost. A list of valid values - Pending and Rejected - is defined in the lookup type PJC_ADJ_STATUS. |
| ProviderOrganizationId | Long | Identifier of the provider organization of the project cost. |
| ReceiverOrganizationId | Long | Identifier of the receiver organization of the project cost. |
| ProviderBusinessUnitId | Long | Identifier of the business unit that owns the resource that incurred the actual cost. |
| ReceiverBusinessUnitId | Long | Identifier of the business unit that owns the project for which cost was incurred. |
| ProviderLedgerCurrency | String | Currency of the ledger that owns the resource that is incurring the project cost. This currency is used for accounting and reporting in the provider ledger. |
| NonlaborResource | String | A resource other than human labor through which the project cost is incurred. For example, use of company-owned equipment or internal telecommunications services. |
| AccountingDate | Date | The date used to determine the accounting period for a project cost. |
| AccountingPeriod | String | The accounting period of the cost distribution in the provider organization's accounting calendar. The provider is the organization that owns the labor or nonlabor resource that incurred the project cost. |
| BurdenCostCreditAccountCombinationId | Long | Code combination identifier of the burden cost credit account. |
| BurdenCostDebitAccountCombinationId | Long | Code combination identifier of the burden cost debit account. |
| BurdenedCostCreditAccountCombinationId | Long | Code combination identifier of the burdened cost credit account. |
| BurdenedCostDebitAccountCombinationId | Long | Code combination identifier of the burdened cost debit account. |
| RawCostCreditAccountCombinationId | Long | Code combination identifier of the raw cost credit account. |
| RawCostDebitAccountCombinationId | Long | Code combination identifier of the raw cost debit account. |
| RawCostCreditAccount | String | The ledger account that receives the credit amount for the raw cost associated with a project cost. |
| BurdenCostCreditAccount | String | The ledger account that receives the credit amount for the burden cost associated with a project cost. |
| BurdenCostDebitAccount | String | The ledger account that receives the debit amount for the burden cost associated with a project cost. |
| BurdenedCostCreditAccount | String | The ledger account that receives the credit amount for the burdened cost associated with a project cost. The burdened cost includes the sum of the raw and burden cost. |
| BurdenedCostDebitAccount | String | The ledger account that receives the debit amount for the burdened cost associated with a project cost. The burdened cost includes the sum of the raw and burden cost. |
| RawCostDebitAccount | String | The ledger account that receives the debit amount for the raw cost associated with a project cost. |
| ExpenditureOrganization | String | Name of the expenditure organization to which the project cost is charged. |
| ProviderBusinessUnit | String | Name of the business unit that owns the resource that incurred the actual cost. |
| ReceiverBusinessUnit | String | Name of the business unit that owns the project for which cost was incurred. |
| ProviderOrganization | String | Name of the organization that provided the resource that incurred the cost on the project or cost distribution line. |
| ReceiverOrganization | String | Name of the organization that owns the project in which the actual cost was incurred. |
| BorrowedAndLentDistributed | String | Indicates if borrowed and lent transactions have been created for the project cost. A list of valid values is defined in the lookup PJC_CC_PROCESSED_CODE. |
| CrossChargeType | String | Name of the type of cross-charge processing to be performed on the project cost. A list of valid values is defined in the lookup type PJC_CC_CROSS_CHARGE_CODE. |
| BorrowedAndLentDistributedCode | String | Code that indicates if borrowed and lent transactions have been created for the project cost. A list of valid values is defined in the lookup PJC_CC_PROCESSED_CODE. |
| CrossChargeTypeCode | String | Code of the type of cross-charge processing to be performed on the project cost. A list of valid values is defined in the lookup type PJC_CC_CROSS_CHARGE_CODE. |
| TransactionSource | String | Name of the application in which the project cost was originally created. |
| LaborDistributionOriginalTransactionReference | String | Original reference that identifies a labor distribution transaction. |
| InventoryItemNumber | String | Number of the inventory item associated with the project cost. |
| InventoryItem | String | Name of the inventory item associated with the project cost. |
| InventoryItemId | Long | Identifier of the inventory item associated with the project cost. |
| SalesOrderNumber | String | Reference to the sales order in the originating source system that's associated with the project cost. |
| ShipmentNumber | String | Reference to the shipment details in the originating source system that's associated with the project cost. |
| TransferOrderNumber | String | Reference to the transfer order in the originating source system that's associated with the project cost. |
| WorkOrderNumber | String | Reference to the work order in the originating source system that's associated with the project cost. |
| InventoryTransactionNumber | String | Reference to the inventory transaction in the originating source system that's associated with the project cost. |
| ResourceTransactionNumber | String | Reference to the resource transaction in the originating source system that's associated with the project cost. |
| ResourceName | String | Reference to the resource name in the originating source system that's associated with the project cost. |
| CostElement | String | Reference to the cost element details in the originating source system that's associated with the project cost. |
| ResourceInstance | String | Reference to the resource instance in the originating source system that's associated with the project cost. |
| SupplyChainTransactionActionId | Long | Identifier of the transaction action captured in the Supply Chain Management application. |
| SupplyChainTransactionTypeId | Long | Identifier of the transaction type captured in the Supply Chain Management application. |
| SupplyChainTransactionSourceTypeId | Long | Identifier of the transaction source type captured in the Supply Chain Management application. |
| SourceTransactionQuantity | Decimal | The quantity of the project cost transaction as captured in the originating supply chain cost transaction. |
| SourceTransactionType | String | The name of the transaction type associated with a project cost transaction as captured in the originating Supply Chain Management application. |
| SourceDistributionLayerReference | Long | The distribution layer identifier of the supply chain cost transaction associated with a project cost transaction. |
| ProjectRoleId | Long | Identifier of the project role associated with the project cost. |
| ProjectRoleName | String | A classification of the relationship between a person and the project associated with the project cost, such as Consultant or Technical Lead. |
| CostId | Long | The unique identifier of the payroll cost. |
| CostAllocationKeyflexId | Long | The unique identifier of the payroll cost allocation key flexfield. |
| PayrollName | String | The name of the payroll associated with this cost. |
| CostActionType | String | The unique payroll action identifier of the cost. This identifier is used to gather accounting information associated with the cost. |
| CostActionId | Long | The payroll costing unique identifier for the pay action. |
| PayrollId | Long | The unique identifier of the payroll associated with this cost. |
| RunId | Long | The unique identifier of the payroll run associated with the cost. |
| RunActionId | Long | The unique identifier of the payroll run action used to get accounting information associated with the cost. |
| Finder | String | finder |
The Adjustments resource is used to view the adjustments performed on project costs.
| Name | Type | Description |
| ProjectCostsTransactionNumber [KEY] | Long | ProjectCostsTransactionNumber |
| ExpenditureItemId [KEY] | Long | Identifier of the project cost. |
| AdjustedOn | Datetime | Date on which the project cost was adjusted. |
| AdjustedBy | String | Name of the person who initiated the project cost adjustment. |
| AdjustmentTypeCode | String | Code that identifies the type of adjustment that was performed on the project cost. A list of valid values is defined in the lookup type PJC_ADJUSTMENT_TYPE. |
| AdjustmentStatusCode | String | Code that identifies the status of the adjustment that was performed on the project cost. A list of valid values is defined in the lookup type PJC_ADJUST_HISTORY_REC_STATUS. |
| AdjustmentSourceCode | String | Code that identifies the source of the project cost adjustment. A list of valid values is defined in the lookup type PJC_ADJ_SOURCE. |
| RejectionReasonCode | String | Code that identifies the reason why the project cost adjustment wasn't processed successfully. |
| AdjustmentType | String | Type of adjustment that was performed on the project cost. A list of valid values is defined in the lookup type PJC_ADJUSTMENT_TYPE. |
| AdjustmentStatus | String | Status of the adjustment that was performed on the project cost. A list of valid values is defined in the lookup type PJC_ADJUST_HISTORY_REC_STATUS. |
| RejectionReason | String | Reason why the project cost adjustment wasn't processed successfully. |
| AdjustmentSource | String | Source of the project cost adjustment. A list of valid values is defined in the lookup type PJC_ADJ_SOURCE. |
| Finder | String | finder |
| TransactionNumber | Long | transactionnumber |
The Project Costs Descriptive Flexfields resource is used to view and update additional information for project costs.
| Name | Type | Description |
| ProjectCostsTransactionNumber [KEY] | Long | ProjectCostsTransactionNumber |
| ExpenditureItemId [KEY] | Long | The identifier of the project cost transaction. |
| _FLEX_Context | String | Code that identifies the context for the segments of the project expenditure items. |
| _FLEX_Context_DisplayValue | String | Name of the context for the segments of the project expenditure items. |
| Finder | String | finder |
| TransactionNumber | Long | transactionnumber |
The Project Standard Cost Collection Flexfields resource is used to capture, view, and update standard cost collection information for project costs.
| Name | Type | Description |
| ProjectCostsTransactionNumber [KEY] | Long | ProjectCostsTransactionNumber |
| ExpenditureItemId [KEY] | Long | The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId= |
| _FLEX_Context | String | __FLEX_Context |
| _FLEX_Context_DisplayValue | String | __FLEX_Context_DisplayValue |
| Finder | String | finder |
| TransactionNumber | Long | transactionnumber |
The Project Enterprise Expense resource is used to view project enterprise expense resources.
| Name | Type | Description |
| ResourceId [KEY] | Long | Identifier of the project enterprise resource. |
| ExpenditureTypeId | Long | Name of the expenditure type of the expense resource. Mandatory for POST operation if the resource is created from an expenditure type. |
| ExpenditureTypeName | String | Name of the expenditure type from which the expense resource was created. |
| ResourceName | String | Name of the expense resource. Mandatory for POST operation if the Expenditure Type ID is not provided. |
| UnitOfMeasure | String | Unit of measurement of the expenditure of the expense resource. |
| Description | String | Additional details about the expense resource. |
| ExternalId | String | Identifier of the expense resource in the external application. |
| Finder | String | finder |
The Project Enterprise Labor resource is used to view project enterprise labor resources.
| Name | Type | Description |
| ResourceId [KEY] | Long | Identifier of the project enterprise resource. |
| PersonId | Long | Identifier of the HCM person associated with the project enterprise resource. You can provide the Person ID or the Person Number in the POST operation to create a resource from an existing HCM person. Person ID takes precedence over Person Number. |
| PersonNumber | String | Unique number of the person associated with the project enterprise resource. You can provide the Person ID or the Person Number in the POST operation to create a resource from an existing HCM person. Person ID takes precedence over Person Number. |
| HCMPersonName | String | Name of the person in HCM for the project enterprise resource. |
| FirstName | String | First name of the project enterprise resource. In POST operation, if the resource isn't created from an existing HCM person, then either pass First Name and Last Name or the Resource Name. |
| LastName | String | Last name of the project enterprise resource. In POST operation, if the resource isn't created from an existing HCM person, then either pass First Name and Last Name or the Resource Name. |
| ResourceName | String | Name of the project enterprise resource. Mandatory for POST operation if the resource isn't created from an existing HCM person and if First Name and Last Name aren't populated. |
| String | Email address of the project enterprise resource. Mandatory for POST operation if the resource isn't created from an existing HCM person. | |
| FromDate | Date | The date from which you can assign the project enterprise resource to a project. |
| ToDate | Date | The last date that you can assign the project enterprise resource to a project. |
| PhoneNumber | String | The phone number of the project enterprise resource. |
| ManagerId | Long | Identifier of the person who's the manager of the project enterprise resource. |
| ManagerName | String | Name of the person who's the manager of the project enterprise resource. |
| ManagerEmail | String | Email address of the person who's the manager of the project enterprise resource. |
| CalendarId | Long | Identifier of the calendar that establishes the normal working days, hours, and exceptions for a project enterprise resource. If no value is passed, the default value is set to the Resource Calendar field value from the Project Management Implementation Options setup page. |
| CalendarName | String | Name of the calendar that establishes the normal working days, hours, and exceptions for a project enterprise resource. |
| PrimaryProjectRoleId | Long | Identifier of the primary role for the project enterprise resource. |
| PrimaryProjectRoleName | String | Name of the primary role for the project enterprise resource. |
| BillRate | Decimal | The amount paid to a business by its customer for a unit of work completed by the project enterprise resource. |
| BillRateCurrencyCode | String | Code of the currency used to define the bill rate of the project enterprise resource. If no value is passed, the default value is set to the Default Currency field value from the Project Management Implementation Options setup page. |
| CostRate | Decimal | The cost of a unit of work by the project enterprise resource. |
| CostRateCurrencyCode | String | Code of the currency used to define the cost rate of the project enterprise resource. If no value is passed, the default value is set to the Default Currency field value from the Project Management Implementation Options setup page. |
| ManageResourceStaffingFlag | Bool | Indicates whether the project enterprise resource is eligible for staffing. The valid values are Y and N. |
| ResourcePoolId | Long | Identifier of the resource pool for the resource pool membership. You can pass a value only if ManageResourceScheduleFlag is passed as Y. The default value is set to Resources with No Pool Membership if no resource pool ID is passed. |
| ResourcePoolName | String | Name of the resource pool for the resource pool membership. |
| PoolMembershipFromDate | Date | Start date of the resource pool membership for the project enterprise resource. You can pass a value only if ManageResourceScheduleFlag is passed as Y. The default value is set to system date if no value is passed. |
| ProjectId | Long | Identifier of the project associated to the project enterprise resource. |
| ProjectName | String | Name of the project associated to the project enterprise resource. |
| ExternalId | String | Identifier of the project enterprise resource in the external application. |
| HCMPersonNumber | String | Number of the HCM person associated with the project enterprise resource. |
| PoolName | String | Name of the resource pool associated to the project enterprise resource. |
| Finder | String | finder |
The attachments resource is used to view attachments.
| Name | Type | Description |
| ProjectEnterpriseLaborResourcesResourceId [KEY] | Long | Identifier of the project enterprise resource. |
| AttachedDocumentId [KEY] | Long | The unique identifier of the attached document. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| DatatypeCode | String | A value that indicates the data type. |
| FileName | String | The file name of the attachment. |
| DmFolderPath | String | The folder path from which the attachment is created. |
| DmDocumentId | String | The document ID from which the attachment is created. |
| DmVersionNumber | String | The document version number from which the attachment is created. |
| Url | String | The URL of a web page type attachment. |
| CategoryName | String | The category of the attachment. |
| UserName | String | The login credentials of the user who created the attachment. |
| Uri | String | The URI of a Topology Manager type attachment. |
| FileUrl | String | The URI of the file. |
| UploadedText | String | The text content for a new text attachment. |
| UploadedFileContentType | String | The content type of the attachment. |
| UploadedFileLength | Long | The size of the attachment file. |
| UploadedFileName | String | The name to assign to a new attachment file. |
| ContentRepositoryFileShared | Bool | Indicates whether the attachment is shared |
| Title | String | The title of the attachment. |
| Description | String | The description of the attachment. |
| ErrorStatusCode | String | The error code, if any, for the attachment. |
| ErrorStatusMessage | String | The error message, if any, for the attachment. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| FileContents | String | The contents of the attachment. |
| ExpirationDate | Datetime | The expiration date of the contents in the attachment. |
| LastUpdatedByUserName | String | The user name who last updated the record. |
| CreatedByUserName | String | The user name who created the record. |
| AsyncTrackerId | String | Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. |
| FileWebImage | String | The base64 encoded image of the file displayed in .png format if the source is a convertible image. |
| DownloadInfo | String | JSON object represented as a string containing information used to programmatically retrieve a file attachment. |
| PostProcessingAction | String | The name of the action that can be performed after an attachment is uploaded. |
| Finder | String | finder |
| ResourceId | Long | resourceid |
The Project Enterprise Resource HCM Assignment Details resource is used to view primary HCM assignment details such as business unit, organization, job, or manager related to the enterprise labor resource.
| Name | Type | Description |
| ProjectEnterpriseLaborResourcesResourceId [KEY] | Long | Identifier of the project enterprise resource. |
| AssignmentId [KEY] | Long | Unique identifier for the HCM person assignment. |
| EffectiveStartDate [KEY] | Date | Start date of the period within which the HCM resource assignment is effective. |
| EffectiveEndDate [KEY] | Date | End date of the period within which the HCM resource assignment is effective. |
| AssignmentNumber | String | Number identifying the person assignment. |
| AssignmentName | String | Translated name of the HCM person assignment. |
| AssignmentType | String | Assignment type. The valid values are E for employee and C for contingent worker. |
| AssignmentStatusType | String | HR status of the HCM person assignment, such as Active, Inactive, and Suspended. |
| OrganizationId | Long | Unique identifier of the department. |
| DepartmentName | String | Translated name of the department. |
| JobId | Long | Unique identifier of the job. |
| JobName | String | Name of the job. |
| BusinessUnitName | String | Translated name of the business unit. |
| BusinessUnitId | Long | Unique identifier for the business unit. |
| UserPersonType | String | Unique identifier of the employment type. The valid values are E for employees and C for the contingent workers. |
| LocationId | Long | Unique identifier for location |
| LocationName | String | Name of location |
| LineManagerPersonId | Long | Identifier of the person who is the line manager of the project enterprise resource. |
| LineManagerName | String | Name of the person who is the line manager of the project enterprise resource. |
| Finder | String | finder |
| ResourceId | Long | resourceid |
The Project Enterprise Resource Image is used to view project enterprise resource image.
| Name | Type | Description |
| ProjectEnterpriseLaborResourcesResourceId [KEY] | Long | Identifier of the project enterprise resource. |
| Image | String | Image of the project enterprise resource. |
| ImageId [KEY] | Long | Identifier of the project enterprise resource image. |
| ResourceId | Long | Identifier of the project enterprise resource. |
| Finder | String | finder |
The Project Enterprise Resource Calendars resource is used to view calendars of a Project Enterprise Resource which are single workday pattern and single shift. A calendar is used when scheduling or staffing a Project Enterprise Resource.
| Name | Type | Description |
| ProjectEnterpriseLaborResourcesResourceId [KEY] | Long | Identifier of the project enterprise resource. |
| CalendarId [KEY] | Long | Unique identifier of the calendar. |
| Name | String | Name of the calendar. |
| Description | String | Description of the calendar. |
| EffectiveFromDate | Date | The date from which the calendar is effective. |
| EffectiveToDate | Date | The inclusive last date of the effectivity of the calendar. |
| CategoryCode | String | The category used for the calendar. |
| QuaterlyTypeCode | String | Indicates the quarter type of the calendar. |
| FirstDayOfWeek | Int | The index of the first day in the week: 1 for Sunday, 2 for Monday, 3 for Tuesday, and so on. The default value is 2. |
| HoursPerDay | Decimal | Number of working hours in a day. Value depends on the number of hours in the shift. |
| SundayWorkFlag | Bool | Indicates if Sundays are workable. True if it's workable, False if it's not. |
| MondayWorkFlag | Bool | Indicates if Mondays are workable. True if it's workable, False if it's not. |
| TuesdayWorkFlag | Bool | Indicates if Tuesdays are workable. True if it's workable, False if it's not. |
| WednesdayWorkFlag | Bool | Indicates if Wednesdays are workable. True if it's workable, False if it's not. |
| ThursdayWorkFlag | Bool | Indicates if Thursdays are workable. True if it's workable, False if it's not. |
| FridayWorkFlag | Bool | Indicates if Fridays are workable. True if it's workable, False if it's not. |
| SaturdayWorkFlag | Bool | Indicates if Saturdays are workable. True if it's workable, False if it's not. |
| ActiveFlag | Bool | Indicates if the calendar is active. |
| Finder | String | finder |
| ResourceId | Long | resourceid |
The Project Enterprise Resource Calendar Exceptions resource is used to view exceptions on a calendar. A calendar exception is used to define holidays or exceptional working days on a weekend. A calendar could have many exceptions.
| Name | Type | Description |
| ProjectEnterpriseLaborResourcesResourceId [KEY] | Long | Identifier of the project enterprise resource. |
| ResourcecalendarsCalendarId [KEY] | Long | Unique identifier of the calendar. |
| ExceptionId [KEY] | Long | Unique identifier of the exception in the calendar. |
| Name | String | Name of the exception. |
| Description | String | Description of the exception. |
| Code | String | Code to identify the exception. |
| PeriodType | String | Indicates if the calendar exception is a workable period or not. Valid values are OFF_PERIOD and WORK_PERIOD. |
| StartDate | Datetime | The date on which the calendar exception begins. Value contains a time component if the exception isn't for all day long. |
| EndDate | Datetime | The inclusive end date of the calendar exception. Value contains a time component if the exception isn't for all day long. |
| CategoryCode | String | Category code in which the exception falls. |
| AllDayFlag | Bool | Indicates if the calendar exception is for the whole day. |
| Finder | String | finder |
| ResourceId | Long | resourceid |
The Project Enterprise Resource Pool Membership resource is used to view resource pools where the Project Enterprise Resource has present, past, or future memberships.
| Name | Type | Description |
| ProjectEnterpriseLaborResourcesResourceId [KEY] | Long | Identifier of the project enterprise resource. |
| ResourcePoolId | Long | Unique identifier of the project resource pool. |
| ResourcePoolMembershipId [KEY] | Long | Unique identifier of the project resource pool membership. |
| PoolMembershipFromDate | Date | Start date of the resource pool membership. |
| PoolMembershipToDate | Date | Last date of the resource pool membership. |
| ResourcePoolName | String | Name of the project resource pool. |
| PoolOwnerResourceId | Long | Identifier of the project enterprise resource, who's the project resource pool owner. |
| Finder | String | finder |
| ResourceId | Long | resourceid |
The project enterprise resource is used to store values while creating or updating project enterprise resources. A project enterprise resource can be a labor resource or an expense resource and can be assigned to a project to complete the project work.
| Name | Type | Description |
| ResourceEmail | String | E-mail address of the projects enterprise resource |
| ResourceId [KEY] | Long | Unique identifier of the project enterprise resource |
| ResourceDisplayName | String | Name of the project enterprise resource |
| ResourceType | String | Resource type of the project enterprise resource |
| ResourceProjectPrimaryRole | String | Primary project role of the project enterprise resource |
| Image | String | URL for the image of the project enterprise resource |
| Finder | String | finder |
The smallest logical unit of an expenditure that you can charge to a project or task. For example, a time card item or an expense report item.
| Name | Type | Description |
| ExternalBillRate | Decimal | The unit rate at which an expenditure item is billed on external contracts. |
| ExternalBillRateCurrency | String | The currency in which an expenditure item is billed on external contracts. |
| ExternalBillRateSourceName | String | The name of the external source from where the external bill rate originates. |
| ExternalBillRateSourceReference | String | The unique identifier of the external bill rate in the external source. |
| ExpenditureItemId [KEY] | Long | The identifier of the expenditure item. |
| IntercompanyBillRate | Decimal | The unit rate at which an expenditure item is billed on intercompany contracts. |
| IntercompanyBillRateCurrency | String | The currency in which an expenditure item is billed on intercompany contracts. |
| IntercompanyBillRateSourceName | String | The name of the external source from where the intercompany bill rate originates. |
| IntercompanyBillRateSourceReference | String | The unique identifier of the intercompany bill rate in the external source. |
| Finder | String | finder |
The Project Expenditure Items Descriptive Flexfields resource is used to view and update additional information for project costs.
| Name | Type | Description |
| ProjectExpenditureItemsExpenditureItemId [KEY] | Long | The identifier of the expenditure item. |
| ExpenditureItemId [KEY] | Long | The identifier of the expenditure item. |
| _FLEX_Context | String | Code that identifies the context for the segments of the project expenditure items. |
| _FLEX_Context_DisplayValue | String | Name of the context for the segments of the project expenditure items. |
| Finder | String | finder |
The Financial Task resource is used to list financial tasks. Tasks are units of project work assigned or performed as part of the duties of a resource. Tasks can be a portion of project work to be performed within a defined period by a specific resource or multiple resources.
| Name | Type | Description |
| ProjectId [KEY] | Long | Unique identifier of a project. |
| ResourceAssignmentPlanningEndDate | Date | The date when the resource is planned to complete an assignment. |
| PlanningElementId [KEY] | Long | Unique identifier of a planning element. |
| PersonId | Long | Unique identifier of a person assigned to the task. |
| ResourceAssignmentPlanningStartDate | Date | The date when the resource is planned to complete an assignment. |
| TaskId | Long | Unique identifier of a financial task. |
| TaskName | String | Name of a financial task. |
| ProjectName | String | Name of a project. |
| DefaultExpenditureTypeName | String | Unique identifier of the default expenditure type for the project unit set for a resource class. |
| DefaultExpenditureTypeId | Long | Unique identifier of the default expenditure type set for a resource class in a project unit. |
| TaskOrganizationName | String | The organization that owns the task. |
| TaskManagerName | String | The resource who manages the task. |
| TaskNumber | String | Number of the task. |
| TaskManagerPersonId | Long | Unique identifier of the person who leads the project task and who has the authority and responsibility for meeting the task objectives. |
| TaskOrganizationId | Long | Unique identifier of the organization that owns the task. Organizations are departments, sections, divisions, companies, or other units. |
| ChargeableFlag | Bool | Indicates whether you can charge an object to the task. |
| ProjectUnitId | Long | Unique identifer for project unit. |
| ProjectNumber | String | Project Number |
| Finder | String | finder |
The Project Forecasts resource is used to view project forecasts.
| Name | Type | Description |
| PlanVersionId [KEY] | Long | Identifier of the forecast version. |
| PlanVersionNumber | Long | The number of the version of the forecast. |
| PlanVersionName | String | Name of the forecast version. |
| PlanVersionDescription | String | Description of the forecast version. |
| PlanVersionStatus | String | The status of the forecast version. A list of valid values is defined in the lookup type PJO_PLAN_STATUS. |
| ForecastCreationMethod | String | Determines whether the forecast version is generated from another plan or copied from another forecast version. A list of valid values - Copy from another source and Generate from another source - is defined in the lookup type PJO_FORECAST_CREATION_METHOD. There is no default value while creating a forecast version. You must enter either this attribute or Forecast Creation Method Code but not both while creating a forecast version. |
| ForecastCreationMethodCode | String | Determines whether the forecast version is generated from another plan or copied from another forecast version. A list of valid values - COPY and GENERATE - is defined in the lookup type PJO_FORECAST_CREATION_METHOD. There is no default value while creating a forecast version. You must enter either this attribute or Forecast Creation Method but not both while creating a forecast version. |
| ForecastGenerationSource | String | Determines whether the forecast version is generated from an existing forecast version based on a financial plan type or from the project plan. A list of valid values - Financial plan type and Project plan type - is defined in the lookup type PJO_PLAN_TYPE_CODE. There is no default value while creating a forecast version. You must enter either this attribute or Forecast Generation Source Code but not both while creating a forecast version. |
| ForecastGenerationSourceCode | String | Determines whether the forecast version is generated from an existing forecast version based on a financial plan type or from the project plan. A list of valid values - FINANCIAL_PLAN and PROJECT_PLAN - is defined in the lookup type PJO_PLAN_TYPE_CODE. There is no default value while creating a forecast version. You must enter either this attribute or Forecast Generation Source but not both while creating a forecast version. |
| SourcePlanVersionId | Long | Identifier of the version of the project plan, budget, or forecast used as the source for creating the forecast version. |
| SourcePlanType | String | Indicates the financial plan type or the project plan from which the forecast version is created. If the forecast generation source is entered as Project plan type, then this attribute is defaulted as project plan by the application. If the forecast generation source is entered as Financial plan type, then you must enter a value for this attribute. |
| SourcePlanVersionNumber | Long | The number of the version of the project plan, budget, or forecast used as the source for creating the forecast version. |
| SourcePlanVersionName | String | The name of the version of the project plan, budget, or forecast used as the source for creating the forecast version. |
| SourcePlanVersionStatus | String | The status of the source plan version from which the forecast version is created. A list of valid values is defined in the lookup type PJO_PLAN_STATUS. |
| ProjectId | Long | Identifier of the project for which the forecast version is created. You must enter a value for only one from among this attribute, Project Number, and Project Name but not for all three or a combination of them while creating a forecast version. |
| ProjectNumber | String | Number of the project for which the forecast version is created. You must enter a value for only one from among this attribute, Project ID, and Project Name but not for all three or a combination of them while creating a forecast version. |
| ProjectName | String | Name of the project for which the forecast version is created. You must enter a value for only one from among this attribute, Project ID, and Project Number but not for all three or a combination of them while creating a forecast version. |
| FinancialPlanType | String | Name of the financial plan type used to create the forecast version. |
| DeferFinancialPlanCreation | String | Indicates that the forecast version will be created in a deferred mode. The default value is Y. A value of Y means that the forecast version will be created in a deferred mode by the Process Financial Plan Versions process. A value of N means that the forecast version will be created in real time and will be included in the response of the POST operation. |
| AdministrativeCode | String | Identifies the action that an administrator can perform on the forecast version based on specific requirements. Not to be used in typical implementations. |
| LockedFlag | Bool | Indicates if the project forecast version is locked. |
| LockedBy | String | Name of the user who has locked the project forecast version. |
| PlanningAmounts | String | Indicates whether a forecast version includes cost amounts, revenue amounts, or both. A list of valid values - Cost, Revenue, and Cost and revenue - is defined in the lookup type PJO_PLANNED_FOR_CODE. There is no default value while creating a forecast version. You must enter either this attribute or Forecast Generation Source but not both while creating a forecast version. |
| AdjustmentPercentage | Decimal | Percentage by which to adjust the forecast version amounts when copying amounts from another source. |
| RawCostInProjectCurrency | Decimal | The estimated raw cost for the project at the completion of the project in the project currency. |
| BurdenedCostInProjectCurrency | Decimal | The estimated burdened cost for the project at the completion of the project in the project currency. |
| RevenueInProjectCurrency | Decimal | The estimated revenue for the project at the completion of the project in the project currency. |
| ActualRawCostInProjectCurrency | Decimal | The actual raw cost incurred by the project in the project currency. |
| ActualBurdenedCostInProjectCurrency | Decimal | The actual burdened cost incurred by the project in the project currency. |
| ActualRevenueInProjectCurrency | Decimal | The actual revenue generated by the project in the project currency. |
| TotalCommitmentsInProjectCurrency | Decimal | The total commitments incurred by the project in the project currency. |
| ETCStartDate | Date | Date when the estimate to complete is intended to begin as planned on the forecast line. |
| ETCRawCostInProjectCurrency | Decimal | The estimated raw cost required to complete the project in the project currency. |
| ETCBurdenedCostInProjectCurrency | Decimal | The estimated burdened cost required to complete the project in the project currency. |
| RawCostInProjectLedgerCurrency | Decimal | The estimated raw cost for the project at the completion of the project in the project ledger currency. |
| BurdenedCostInProjectLedgerCurrency | Decimal | The estimated burdened cost for the project at the completion of the project in the project ledger currency. |
| RevenueInProjectLedgerCurrency | Decimal | The estimated revenue for the project at the completion of the project in the project currency. |
| EACLaborEffort | Decimal | Estimated labor effort for the project at the completion of the project. EAC labor effort includes both billable and nonbillable estimated labor effort at the completion of the project. |
| EACEquipmentEffort | Decimal | Estimated equipment effort for the project at the completion of the project. EAC equipment effort includes both billable and nonbillable estimated equipment effort at the completion of the project. |
| CurrentBaselineBudgetMarginVariance | Decimal | Variance between the margins of the forecast version and the current baseline budget version. |
| CurrentBaselineBudgetMarginVariancePercentage | Decimal | Variance between the margins of the forecast version and the current baseline budget version, expressed as a percentage. |
| OriginalBaselineBudgetMarginVariance | Decimal | Variance between the margins of the forecast version and the original baseline budget version. |
| OriginalBaselineBudgetMarginVariancePercentage | Decimal | Variance between the margins of the forecast version and the original baseline budget version, expressed as a percentage. |
| CurrentForecastMarginVariance | Decimal | Variance between the margins of the forecast version and the current forecast version. |
| CurrentForecastMarginVariancePercentage | Decimal | Variance between the margins of the forecast version and the current forecast version, expressed as a percentage. |
| PreviousForecastMarginVariance | Decimal | Variance between the margins of the forecast version and the previous forecast version. |
| PreviousForecastMarginVariancePercentage | Decimal | Variance between the margins of the forecast version and the previous forecast version, expressed as a percentage. |
| Margin | Decimal | The difference between project-related costs and revenue amounts. |
| MarginPercentage | Decimal | The difference between project-related costs and revenue amounts, expressed as a percentage. |
| PlanningOptionId | Long | Identifier of the planning option setup for the project forecast version. |
| ProjectResourcesStatus | String | Status of the project resources to be used for generation. Valid values are: All and Confirmed. |
| RbsVersionId | Long | RbsVersionId |
| Finder | String | finder |
The attachments resource is used to view attachments for project forecasts.
| Name | Type | Description |
| ProjectForecastsPlanVersionId [KEY] | Long | Identifier of the forecast version. |
| AttachedDocumentId [KEY] | Long | The unique identifier of the attached document. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| DatatypeCode | String | A value that indicates the data type. |
| FileName | String | The file name of the attachment. |
| DmFolderPath | String | The folder path from which the attachment is created. |
| DmDocumentId | String | The document ID from which the attachment is created. |
| DmVersionNumber | String | The document version number from which the attachment is created. |
| Url | String | The URL of a web page type attachment. |
| CategoryName | String | The category of the attachment. |
| UserName | String | The login credentials of the user who created the attachment. |
| Uri | String | The URI of a Topology Manager type attachment. |
| FileUrl | String | The URI of the file. |
| UploadedText | String | The text content for a new text attachment. |
| UploadedFileContentType | String | The content type of the attachment. |
| UploadedFileLength | Long | The size of the attachment file. |
| UploadedFileName | String | The name to assign to a new attachment file. |
| ContentRepositoryFileShared | Bool | Indicates whether the attachment is shared |
| Title | String | The title of the attachment. |
| Description | String | The description of the attachment. |
| ErrorStatusCode | String | The error code, if any, for the attachment. |
| ErrorStatusMessage | String | The error message, if any, for the attachment. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| FileContents | String | The contents of the attachment. |
| ExpirationDate | Datetime | The expiration date of the contents in the attachment. |
| LastUpdatedByUserName | String | The user name who last updated the record. |
| CreatedByUserName | String | The user name who created the record. |
| AsyncTrackerId | String | Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. |
| FileWebImage | String | The base64 encoded image of the file displayed in .png format if the source is a convertible image. |
| DownloadInfo | String | JSON object represented as a string containing information used to programmatically retrieve a file attachment. |
| PostProcessingAction | String | The name of the action that can be performed after an attachment is uploaded. |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | String | projectid |
The Planning Options resource is used to view the planning options configured for the project forecast version.
| Name | Type | Description |
| ProjectForecastsPlanVersionId [KEY] | Long | Identifier of the forecast version. |
| PlanningOptionId [KEY] | Long | Identifier of the summary level planning option in the project forecast version. |
| PlanningResourceBreakdownStructure | String | Planning resource breakdown structure associated with the project. |
| PlanningLevel | String | Level of the forecast at which amounts can be entered. |
| CalendarType | String | The type of calendar, such as accounting calendar or project accounting calendar, used for entering and displaying periodic financial information. |
| PeriodProfile | String | Defines how time periods are grouped and displayed when editing forecast versions. |
| RateDerivationDateType | String | The date type, for example, the system date or a fixed date that's used as the basis for deriving rates for calculating amounts on a None time phased forecast version. |
| RateDerivationDate | Datetime | The date that's used as the basis for deriving rates for calculating amounts on a None time phased forecast version. |
| CostRateDerivationDateType | String | The date type, for example, the system date or a fixed date that is used as the basis for deriving rates for calculating cost amounts. |
| CostRateDerivationDate | Datetime | The date that is used as the basis for deriving rates for calculating cost amounts. |
| BillRateDerivationDateType | String | The date type, for example, the system date or a fixed date that is used as the basis for deriving rates for calculating revenue amounts. |
| BillRateDerivationDate | Datetime | The date that is used as the basis for deriving rates for calculating revenue amounts. |
| DesignateAsPrimaryCostForecastFlag | Bool | Indicates whether the financial plan type is the primary cost forecast. |
| DesignateAsPrimaryRevenueForecastFlag | Bool | Indicates whether the financial plan type is the primary revenue forecast. |
| MultipleTransactionCurrencies | String | Indicates that the plan can use multiple transaction currencies. A value of Y indicates that the attribute is selected. A value of N means that the attribute is not selected. |
| CurrentPlanningPeriod | String | Current planning period that drives the display of the periodic information. It can be the project accounting period or accounting period depending on the selected calendar type. This value is not applicable when the calendar type is set to NONE. |
| MaintainManualSpreadOnDateChanges | String | Indicates whether the periodic planning is retained in the plan version on plan line date modifications. A value of Y indicates that the attribute is selected. A value of N means that the attribute is not selected. |
| AssignTaskResourceInSingleCurrencyFlag | Bool | Indicates whether a forecast line is enabled for assigning resources in a single currency for a task. |
| ProjectCurrency | String | Currency for the project. |
| ProjectLedgerCurrency | String | Project ledger currency for the project. |
| UseSameConversionAttributeForAllCurrencyConversionsFlag | Bool | Indicates whether you can use the same currency conversion attribute for all currencies. |
| CostRateTypeForConversionInPC | String | Cost rate type that is used as a cost conversion attribute for project currency. |
| CostDateTypeForConversionInPC | String | Date type that is used as a cost conversion attribute for project currency. |
| CostFixedDateForConversionInPC | Datetime | Date that's used as a cost conversion attribute for project currency. |
| CostRateTypeForConversionInPLC | String | Cost rate type that is used as a cost conversion attribute for project ledger currency. |
| CostDateTypeForConversionInPLC | String | Date type that is used as a cost conversion attribute for project ledger currency. |
| CostFixedDateForConversionInPLC | Datetime | Date that's used as a cost conversion attribute for project ledger currency. |
| RateTypeForCostConversion | String | Cost rate type that is used as a cost conversion attribute for planning currencies. |
| DateTypeForCostConversion | String | Date type that is used as a cost conversion attribute for planning currencies. |
| FixedDateForCostConversion | Datetime | The date that is used to derive rates for calculating planned costs for planning currencies. |
| RevenueRateTypeForConversionInPC | String | Revenue rate type that is used as a revenue conversion attribute for project currency. |
| RevenueDateTypeForConversionInPC | String | Date type that is used as a revenue conversion attribute for project currency. |
| RevenueFixedDateForConversionInPC | Datetime | Date that's used as a revenue conversion attribute for project currency. |
| RevenueRateTypeForConversionInPLC | String | Revenue rate type that is used as a revenue conversion attribute for project ledger currency. |
| RevenueDateTypeForConversionInPLC | String | Date type that is used as a revenue conversion attribute for project ledger currency. |
| RevenueFixedDateForConversionInPLC | Datetime | Date that's used as a revenue conversion attribute for project ledger currency. |
| RateTypeForRevenueConversion | String | Revenue rate type that is used as a revenue conversion attribute for planning currencies. |
| DateTypeForRevenueConversion | String | Date type that is used as a revenue conversion attribute for planning currencies. |
| FixedDateForRevenueConversion | Datetime | The date that is used to derive rates for calculating planned revenue for planning currencies. |
| UsePlanningRatesFlag | Bool | Enables utilization of planning rates for resources and resource classes when calculating forecast amounts. |
| BurdenScheduleCostOptions | String | A set of burden multipliers that is maintained for use across projects. Also referred to as a standard burden schedule. |
| PersonCostOptions | String | Rate schedule used for the calculation of cost amounts for named persons. |
| JobCostOptions | String | Rate schedule used for the calculation of cost amounts for jobs. |
| NonlaborResourceCostOptions | String | Rate schedule used for the calculation of cost amounts for non-labor resources. |
| ResourceClassCostOptions | String | Rate schedule used for the calculation of cost amounts for resource classes. This is used for cost calculation when rates are unavailable in rate schedules for named persons, jobs, or non-labor resources. |
| PersonRevenueOptions | String | Rate schedule used for the calculation of revenue amounts for named persons. |
| JobRevenueOptions | String | Rate schedule used for the calculation of revenue amounts for jobs. |
| NonlaborResourceRevenueOptions | String | Rate schedule used for the calculation of revenue amounts for non-labor resources. |
| ResourceClassRevenueOptions | String | Rate schedule used for the calculation of revenue amounts for resource classes. This is used for revenue calculation when rates are unavailable in rate schedules for named persons, jobs, or non-labor resources. |
| RevenueGenerationMethod | String | Determines whether forecast revenue is calculated based on quantity and rates, event amounts, or the spread ratio specified for tasks. |
| ForecastETCMethod | String | Method used to calculate estimate-to-complete values in project forecast. |
| CarryForwardUnusedAmountsFromPastPeriodsFlag | Bool | Indicates whether unused forecast amounts can be carried over from the current or closed periods to the next open period. |
| ActualAmountsThroughPeriod | String | The period (current, prior, or last closed) through which actual amounts are used when generating forecast amounts. |
| ETCGenerationSource | String | Specifies whether the estimate-to-complete source for generating a forecast version is the financial project plan, another financial plan, or project resources. |
| AllowNegativeETCCalculationFlag | Bool | Indicates whether negative estimate-to-complete quantity can be calculated in progress. If the check box isn't enabled, and the calculated value is negative, then the estimate-to-complete quantity is set to zero. |
| OpenCommitments | String | Indicates whether project costs from commitments are included when generating budgets or forecasts. |
| RetainOverrideRatesFromSourceFlag | Bool | Indicates whether user specified cost and revenue rates from the source must be retained when generating the target budget or forecast version. |
| RetainSpreadFromSourceFlag | Bool | RetainSpreadFromSourceFlag |
| DefaultReportingOption | String | Indicates whether cost or revenue quantity is used for reporting quantity when planning for cost and revenue in a separate forecast version. By default, it is set to Cost when planning amounts are cost only or cost and revenue together. When the planning amounts are revenue only, it is set to Revenue. |
| ReportCost | String | Determines the cost amount types that are used to calculate and report margins on forecasts. |
| AmountScale | String | The scale on which amounts are displayed on the user interface. For example, if you select to view amounts in 1000s, the $100,000,000 amount is displayed as 100,000. |
| CurrencyType | String | Indicates whether the project currency or the project ledger currency is used for displaying amounts when reviewing forecast amounts. |
| RetainManuallyAddedForecastLinesFlag | Bool | Indicates whether manually added plans lines are retained when the forecast version is regenerated. |
| AssociateProjectCostsOrRevenueToSummaryTasksFlag | Bool | AssociateProjectCostsOrRevenueToSummaryTasksFlag |
| ProjectRoleCostOptions | String | Rate schedule used for the calculation of cost amounts for project role. This is used for cost calculation when rates are unavailable in rate schedules for named persons. |
| ProjectRoleRevenueOptions | String | Rate schedule used for the calculation of revenue amounts for project role. This is used for revenue calculation when rates are unavailable in rate schedules for named persons. |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | String | projectid |
The Amount Type resource is used to select the cost and revenue items to include in a financial plan type.
| Name | Type | Description |
| ProjectForecastsPlanVersionId [KEY] | Long | Identifier of the forecast version. |
| PlanningoptionsPlanningOptionId [KEY] | Long | Identifier of the summary level planning option in the project forecast version. |
| AmountTypeId [KEY] | Long | Identifier of the project forecast version amount types. |
| RawCostFlag | Bool | Indicates whether the raw cost amounts for a forecast version are editable. |
| BurdenedCostFlag | Bool | Indicates whether the burdened cost amounts for a forecast version are editable. |
| RevenueFlag | Bool | Indicates whether the revenue for a forecast version is editable. |
| RawCostRateFlag | Bool | Indicates whether the raw cost rate is editable. |
| BurdenedCostRateFlag | Bool | Indicates whether the burdened cost rate is editable. |
| BillRateFlag | Bool | Indicates whether the revenue rate is editable. |
| QuantityFlag | Bool | Indicates whether the quantity is editable on a budget or forecast version. |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | String | projectid |
The Export Option resource is used to select the planning options attributes to export.
| Name | Type | Description |
| ProjectForecastsPlanVersionId [KEY] | Long | Identifier of the forecast version. |
| PlanningoptionsPlanningOptionId [KEY] | Long | Identifier of the summary level planning option in the project forecast version. |
| ExportOptionId [KEY] | Long | Identifier of the project forecast version export options. |
| DisplayRatesAndAmountsInMultipleTransactionCurrenciesFlag | Bool | Indicates whether to display the currency conversion attributes and amounts in multiple transaction currencies if the plan type allows planning in multiple transaction currencies. |
| DisplayCommitmentsFlag | Bool | Indicates whether to display the external commitments present in the budget or forecast plan lines. |
| PlanningCurrency | String | Currency used for planning in the forecast line. This value is always set to true and the attribute is exported. |
| PlanningResource | String | Resource used for financial planning in the forecast line. This value is always set to true and the attribute is exported. |
| ResourceClass | String | Resource class associated with the forecast line. This value is always set to true and the attribute is exported. |
| SpreadCurve | String | Spread curve associated with the forecast line. This value is always set to true and the attribute is exported. |
| TaskName | String | Name assigned to a task. This value is always set to true and the attribute is exported. |
| TaskNumber | String | Number of the task. This value is always set to true and the attribute is exported. |
| BurdenedCostStandardMultiplier | String | Standard multiplier derived from the burden schedule for calculating burdened cost. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| BurdenedCostStandardRate | String | Standard rate derived from the rate schedule for calculating the burdened cost. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| StandardRawCostRate | String | Rate derived from the rate schedule for calculating raw cost. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ProjectCurrencyConversionCostRate | String | Cost rate used when converting the amounts to project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ProjectCurrencyConversionCostDate | String | Date that's used as a cost conversion attribute for project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ProjectCurrencyConversionCostDateType | String | Date type that's used as a cost conversion attribute for project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ProjectCurrencyConversionCostRateType | String | The type of currency conversion rate for the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ProjectLedgerCurrencyConversionCostRate | String | Cost rate used when converting the amounts to project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ProjectLedgerCurrencyConversionCostDate | String | Date that's used as a cost conversion attribute for project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ProjectLedgerCurrencyConversionCostDateType | String | Date type that's used as a cost conversion attribute for project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ProjectLedgerCurrencyConversionCostRateType | String | The type of currency conversion rate for the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ProjectCurrencyConversionRevenueRate | String | Revenue rate used when converting the amounts to project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ProjectCurrencyConversionRevenueDate | String | Date that's used as a revenue conversion attribute for project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ProjectCurrencyConversionRevenueDateType | String | Date type that's used as a revenue conversion attribute for project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ProjectCurrencyConversionRevenueRateType | String | The type of currency conversion rate for the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ProjectLedgerCurrencyConversionRevenueRate | String | Revenue rate used when converting the amounts to project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ProjectLedgerCurrencyConversionRevenueDate | String | Date that's used as a revenue conversion attribute for project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ProjectLedgerCurrencyConversionRevenueDateType | String | Date type that's used as a revenue conversion attribute for project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ProjectLedgerCurrencyConversionRevenueRateType | String | The type of currency conversion rate for the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| StandardRevenueRate | String | Rate derived from the rate schedule for calculating revenue. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| EffectiveBurdenedCostRate | String | User entered rate for calculating the burdened cost. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| EffectiveRawCostRate | String | User entered rate for calculating the raw cost. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| EffectiveRevenueRate | String | User entered rate for calculating revenue. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ToDate | String | End date of the forecast line. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| BurdenedCostEffectiveMultiplier | String | Multiplier used to calculate the burdened costs. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| FromDate | String | From date of the forecast line. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| UnitOfMeasure | String | Unit of measure for a resource. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ActualBurdenedCostAmounts | String | Actual burdened cost amounts incurred on the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ActualQuantity | String | Actual quantity of resource effort spent on a task or project, including labor and equipment. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ActualRawCostAmounts | String | Actual cost amounts incurred on the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| BurdenedCostPOCommitmentsInPC | String | Burdened costs for purchase orders against the project, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| BurdenedCostPRCommitmentsInPC | String | Burdened costs for outstanding purchase requisitions against the project, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| BurdenedCostInvoiceCommitmentsInPC | String | Burdened costs for supplier invoices billed against the project, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| BurdenedCostPOCommitmentsInPLC | String | Burdened costs for purchase orders against the project, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| BurdenedCostPRInCommitmentsPLC | String | Burdened costs for outstanding purchase requisitions against the project, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| BurdenedCostInvoiceCommitmentsInPLC | String | Burdened costs for supplier invoices billed against the project, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| BurdenedCostPOCommitments | String | Burdened costs for purchase orders against the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| BurdenedCostPRCommitments | String | Burdened costs for outstanding purchase requisitions against the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| BurdenedCostInvoiceCommitments | String | Costs for supplier invoices billed against the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ActualBurdenedCostInPC | String | Actual burdened costs incurred on the project, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| EACBurdenedCostInPC | String | Estimate of burdened costs incurred on the project at completion, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ETCBurdenedCostInPC | String | Estimate of burdened costs to be incurred to complete the project, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| TotalBurdenedCostCommitmentsInPC | String | Total burdened costs for all commitments such as purchase order, supplier invoices, and requisitions, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ActualBurdenedCostInPLC | String | Actual burdened costs incurred on the project, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| EACBurdenedCostInPLC | String | Estimate of burdened costs incurred on the project at completion, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ETCBurdenedCostInPLC | String | Estimate of burdened costs to be incurred to complete the project, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| TotalBurdenedCostCommitmentsInPLC | String | Total burdened costs for all commitments such as purchase order, supplier invoices, and requisitions, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| EACBurdenedCost | String | Estimate of burdened cost amounts incurred on the project at completion. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| EACQuantity | String | Estimate-at-completion quantity of resource effort spent on a task or project, including labor and equipment. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| EACRawCost | String | Estimate of cost amounts incurred on the project at completion. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ETCBurdenedCost | String | Estimate of burdened cost amounts to be incurred to complete the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ETCQuantity | String | Estimate-to-complete quantity of resource effort spent on a task or project, including labor and equipment. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ETCRawCost | String | Estimate of cost amounts to be incurred to complete the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ActualMargin | String | Difference between actual project-related costs and actual revenue amounts. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| EACMargin | String | Estimated difference between actual project-related costs and actual revenue amounts at the completion of the task or project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ETCMargin | String | Estimated difference between actual project-related costs and actual revenue amounts to complete the task or project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ActualMarginInPC | String | Difference between actual project-related costs and actual revenue amounts calculated using project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| EACMarginInPC | String | Estimated difference between project-related costs and revenue amounts at the completion of the task or project, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ETCMarginInPC | String | Estimated difference between actual project-related costs and actual revenue amounts to complete the task or project, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| EACMarginPercentage | String | Estimated difference between actual project-related costs and actual revenue amounts at the completion of the task or project, denoted as a percentage. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ETCMarginPercentage | String | Estimated difference between actual project-related costs and actual revenue amounts to complete the task or project, denoted as a percentage. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ActualMarginInPLC | String | Difference between actual project-related costs and actual revenue amounts calculated using project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| EACMarginInPLC | String | Estimated difference between project-related costs and revenue amounts at the completion of the task or project, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ETCMarginInPLC | String | Estimated difference between actual project-related costs and actual revenue amounts to complete the task or project, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ActualRevenueInPC | String | Actual revenue that's associated with the accounting period or a financial plan line in the forecast, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ActualRevenueInPLC | String | Actual revenue that's associated with the accounting period or a financial plan line in the forecast, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| QuantityPOCommitments | String | Planned quantity of purchase order commitments required to complete a project or task. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| QuantityPRCommitments | String | Planned quantity of purchase requisition commitments required to complete a project or task. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| QuantityInvoiceCommitments | String | Planned quantity of supplier invoice commitments required to complete a project or task. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| RawCostPOCommitmentsInPC | String | Purchase order costs that are directly attributable to work performed, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| RawCostPRCommitmentsInPC | String | Purchase requisition costs that are directly attributable to work performed, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| RawCostInvoiceCommitmentsInPC | String | Costs from supplier invoices that are directly attributable to work performed, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| RawCostPOCommitmentsInPLC | String | Purchase order costs that are directly attributable to work performed, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| RawCostPRCommitmentsInPLC | String | Purchase requisition costs that are directly attributable to work performed, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| RawCostInvoiceCommitmentsInPLC | String | Costs from supplier invoices that are directly attributable to work performed, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| RawCostPOCommitments | String | Purchase order costs that are directly attributable to work performed. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| RawCostPRCommitments | String | Purchase requisition costs that are directly attributable to work performed. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| RawCostInvoiceCommitments | String | Costs from supplier invoices that are directly attributable to work performed. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ActualRawCostInPC | String | Actual cost amounts incurred on the project, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| EACRawCostInPC | String | Estimate of cost amounts incurred on the project at completion, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ETCRawCostInPC | String | Estimate of cost amounts to be incurred to complete the project, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| TotalRawCostCommitmentsInPC | String | Total commitments incurred by the project in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ActualRawCostInPLC | String | Actual cost amounts incurred on the project, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| EACRawCostInPLC | String | Estimate of cost amounts incurred on the project at completion, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ETCRawCostInPLC | String | Estimate of cost amounts to be incurred to complete the project, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| TotalRawCostCommitmentsInPLC | String | Total commitments incurred by the project in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ActualRevenueAmounts | String | Actual revenue that's associated with the accounting period or a plan line in the forecast. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| EACRevenue | String | Estimate-at-completion revenue that's associated with the accounting period or a plan line in the forecast. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ETCRevenue | String | Estimate-to-complete revenue that's associated with the accounting period or a plan line in the forecast. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| EACRevenueInPC | String | Estimate-at-completion revenue that's associated with the accounting period or a financial plan line in the forecast, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ETCRevenueInPC | String | Estimate-to-complete revenue that's associated with the accounting period or a financial plan line in the forecast, denoted in project currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| EACRevenueInPLC | String | Estimate-at-completion revenue that's associated with the accounting period or a financial plan line in the forecast, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| ETCRevenueInPLC | String | Estimate-to-complete revenue that's associated with the accounting period or a financial plan line in the forecast, denoted in project ledger currency. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| TotalBurdenedCostCommitments | String | Total burdened costs for all commitments such as purchase order, supplier invoices, and requisitions. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| TotalQuantityCommitments | String | Total commitments quantity required to complete a project or task. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| TotalRawCostCommitments | String | Total commitments incurred by the project. A value of Y indicates that the attribute is selected for export. A value of N indicates that the attribute isn't selected for export. |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | String | projectid |
The Planning Currency resource is used to view project and planning currencies.
| Name | Type | Description |
| ProjectForecastsPlanVersionId [KEY] | Long | Identifier of the forecast version. |
| PlanningoptionsPlanningOptionId [KEY] | Long | Identifier of the summary level planning option in the project forecast version. |
| PlanningCurrencyId [KEY] | Long | Identifier of the planning currency. |
| PlanningCurrencyCode | String | Currency code for the planning currency. |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | String | projectid |
The Planning Options Descriptive Flexfields resource is used to view additional information for planning options in project forecast versions.
| Name | Type | Description |
| ProjectForecastsPlanVersionId [KEY] | Long | Identifier of the forecast version. |
| PlanningoptionsPlanningOptionId [KEY] | Long | Identifier of the summary level planning option in the project forecast version. |
| PlanningOptionId [KEY] | Long | Identifier of the summary level planning option in the project forecast version. |
| _FLEX_Context | String | Code that identifies the context for the segments of the planning options flexfields. |
| _FLEX_Context_DisplayValue | String | Name of the context for the segments of the planning options flexfields. |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | String | projectid |
The Planning Resources resource is used to view project forecast resource assignments.
| Name | Type | Description |
| ProjectForecastsPlanVersionId [KEY] | Long | Identifier of the forecast version. |
| PlanningElementId [KEY] | Long | Identifier of the planning resources of the forecast version. |
| TaskId | Long | Identifier of the task for which a financial plan resource assignment is created. You must enter a value for only one from among this attribute, Task Name, and Task Number but not for all three or a combination of them while creating a financial plan resource assignment. |
| TaskNumber | String | Number of the task for which a financial plan resource assignment is created. You must enter a value for only one from among this attribute, Task Name, and Task ID but not for all three or a combination of them while creating a financial plan resource assignment. |
| TaskName | String | Name of the task for which a financial plan resource assignment is created. You must enter a value for only one from among this attribute, Task ID, and Task Number but not for all three or a combination of them while creating a financial plan resource assignment. |
| RbsElementId | Long | Identifier of the resource breakdown structure element used to create the financial plan resource assignment. |
| ResourceName | String | Name or alias of the resource included in the planning resource breakdown structure that is used to create the financial plan resource assignment. |
| UnitOfMeasure | String | Unit of work that measures the quantity of effort for which the resource is planned for on the financial plan resource assignment. |
| ResourceClass | String | Grouping of predefined resource types to which the resource in the financial plan resource assignment belongs. A list of valid values are Labor, Equipment, Material Items, and Financial Resources. |
| PlanningStartDate | Datetime | The date that is planned on the financial plan for a resource to finish their assignment on a project task. |
| PlanningEndDate | Datetime | The date that is planned on the financial plan for a resource to begin their assignment on a project task. |
| MaintainManualSpreadOnDateChanges | String | Indicates whether the periodic planning is retained in the plan version on plan line date modifications. |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | String | projectid |
The Planning Amounts resource is used to view project forecast resource assignment summary amounts.
| Name | Type | Description |
| ProjectForecastsPlanVersionId [KEY] | Long | Identifier of the forecast version. |
| PlanningresourcesPlanningElementId [KEY] | Long | Identifier of the planning resources of the forecast version. |
| PlanLineId [KEY] | Long | Identifier of the summary level planning amounts for a plan line in the project forecast. |
| TotalCommittedQuantity | Decimal | Committed effort for the forecast version resource assignment. |
| ActualQuantity | Decimal | Actual effort for the forecast version resource assignment from the start of the project till the current date. |
| ETCQuantity | Decimal | Estimated remaining effort by the  forecast version resource assignment for completion. |
| EACQuantity | Decimal | Measure of the effort planned for in the forecast version resource assignment. |
| Currency | String | Code that identifies the planning currency on the forecast version resource assignment. |
| TotalCommittedRawCost | Decimal | Total committed cost for the forecast version resource assignment in planning currency that is directly attributable to the work performed. |
| ActualRawCost | Decimal | Actual cost incurred for the period in the forecast version resource assignment in planning currency that is directly attributable to the work performed from the start of the project till the current date. |
| ETCRawCost | Decimal | Estimated remaining cost in planning currency required for completion of the task in the period by the forecast version resource assignment that is directly attributable to the work performed. |
| EACRawCost | Decimal | Estimated cost in planning currency at the completion of the task in the period for the forecast version resource assignment that is directly attributable to the work performed. |
| StandardETCRawCostRate | Decimal | Rate derived from the rate schedule for calculating the planned raw cost for the forecast version resource assignment. |
| EffectiveETCRawCostRate | Decimal | Cost rate that is used to calculate amounts for a forecast version resource assignment. Quantity multiplied by the effective raw cost rate gives the raw cost amounts. |
| ActualRawCostRate | Decimal | Rate that is used to calculate the actual cost for the forecast version resource assignment that is directly attributable to the work performed. |
| EACRawCostRate | Decimal | Rate that is used to calculate the estimated cost at the completion of the task for the forecast version resource assignment that is directly attributable to the work performed. |
| TotalCommittedBurdenedCost | Decimal | Total committed cost for the forecast version resource assignment in planning currency that includes both raw and burden costs. |
| ActualBurdenedCost | Decimal | Actual cost incurred for the forecast version resource assignment, including raw and burden costs, in planning currency from the start of the project till the current date. |
| ETCBurdenedCost | Decimal | Estimated remaining cost in planning currency, including raw and burden costs, required for completion of the task by the forecast version resource assignment. |
| EACBurdenedCost | Decimal | Estimated cost in planning currency, including raw and burden costs, at the completion of the task for the forecast version resource assignment. |
| StandardETCBurdenedCostRate | Decimal | Average rate derived from the rate schedule for calculating the planned burdened cost for the forecast version resource assignment. |
| EffectiveETCBurdenedCostRate | Decimal | Cost rate that is used to calculate amounts for a forecast version resource assignment. Quantity multiplied by the effective burdened cost rate gives the burdened cost amounts. |
| ActualBurdenedCostRate | Decimal | Actual burdened cost rate that is used to calculate the actual cost for the forecast version resource assignment that includes both raw and burden costs. |
| EACBurdenedCostRate | Decimal | Rate that is used to calculate the actual cost for the forecast version resource assignment that includes both raw and burden costs. |
| RequisitionCommittedQuantity | Decimal | Effort for the forecast version resource assignment committed through requisitions. |
| PurchaseOrderCommittedQuantity | Decimal | Effort for the forecast version resource assignment committed through purchase orders. |
| SupplierInvoiceCommittedQuantity | Decimal | Effort for the forecast version resource assignment committed through supplier invoices. |
| TransferOrderCommittedQuantity | Decimal | Effort for the forecast version resource assignment committed through transfer orders. |
| RequisitionCommittedRawCost | Decimal | Cost for the forecast version resource assignment committed through requisitions in planning currency that is directly attributable to the work performed. |
| PurchaseOrderCommittedRawCost | Decimal | Cost for the forecast version resource assignment committed through purchase orders in planning currency that is directly attributable to the work performed. |
| SupplierInvoiceCommittedRawCost | Decimal | Cost for the forecast version resource assignment committed through supplier invoices in planning currency that is directly attributable to the work performed. |
| TransferOrderCommittedRawCost | Decimal | Cost for the forecast version resource assignment committed through transfer orders in planning currency that is directly attributable to the work performed. |
| RequisitionCommittedBurdenedCost | Decimal | Cost for the forecast version resource assignment committed through requisitions in planning currency that includes both raw and burden costs. |
| PurchaseOrderCommittedBurdenedCost | Decimal | Cost for the forecast version resource assignment committed through purchase orders in planning currency that includes both raw and burden costs. |
| SupplierInvoiceCommittedBurdenedCost | Decimal | Cost for the forecast version resource assignment committed through supplier invoices in planning currency that includes both raw and burden costs. |
| TransferOrderCommittedBurdenedCost | Decimal | Cost for the forecast version resource assignment committed through transfer orders in planning currency that includes both raw and burden costs. |
| TotalCommittedRawCostInProjectCurrency | Decimal | Total committed cost for the forecast version resource assignment in project currency that is directly attributable to the work performed. |
| ActualRawCostInProjectCurrency | Decimal | Actual cost incurred for the forecast version resource assignment in project currency that is directly attributable to the work performed from the start of the project till the current date. |
| ETCRawCostInProjectCurrency | Decimal | Estimated remaining cost in project currency required for completion of the task by the forecast version resource assignment that is directly attributable to the work performed. |
| EACRawCostInProjectCurrency | Decimal | Estimated cost in project ledger currency at the completion of the task for the forecast version resource assignment that is directly attributable to the work performed. |
| RequisitionCommittedRawCostInProjectCurrency | Decimal | Cost for the forecast version resource assignment committed through requisitions in project currency that is directly attributable to the work performed. |
| PurchaseOrderCommittedRawCostInProjectCurrency | Decimal | Cost for the forecast version resource assignment committed through purchase orders in project currency that is directly attributable to the work performed. |
| SupplierInvoiceCommittedRawCostinProjectCurrency | Decimal | Cost for the forecast version resource assignment committed through supplier invoices in project currency that is directly attributable to the work performed. |
| TransferOrderCommittedRawCostInProjectCurrency | Decimal | Cost for the forecast version resource assignment committed through transfer orders in project currency that is directly attributable to the work performed. |
| TotalCommittedRawCostInProjectLedgerCurrency | Decimal | Total committed cost for the forecast version resource assignment in project ledger currency that is directly attributable to the work performed. |
| ActualRawCostInProjectLedgerCurrency | Decimal | Actual cost incurred for the forecast version resource assignment in project ledger currency that is directly attributable to the work performed from the start of the project till the current date. |
| ETCRawCostInProjectLedgerCurrency | Decimal | Estimated remaining cost in project ledger currency required for completion of the task by the forecast version resource assignment that is directly attributable to the work performed. |
| EACRawCostInProjectLedgerCurrency | Decimal | Estimated cost in project ledger currency at the completion of the task for the forecast version resource assignment that is directly attributable to the work performed. |
| RequisitionCommittedRawCostInProjectLedgerCurrency | Decimal | Cost for the forecast version resource assignment committed through requisitions in project ledger currency that is directly attributable to the work performed. |
| PurchaseOrderCommittedRawCostInProjectLedgerCurrency | Decimal | Cost for the forecast version resource assignment committed through purchase orders in project ledger currency that is directly attributable to the work performed. |
| SupplierInvoiceCommittedRawCostinProjectLedgerCurrency | Decimal | Cost for the forecast version resource assignment committed through supplier invoices in project ledger currency that is directly attributable to the work performed. |
| TransferOrderCommittedRawCostInProjectLedgerCurrency | Decimal | Cost for the forecast version resource assignment committed through transfer orders in project ledger currency that is directly attributable to the work performed. |
| TotalCommittedBurdenedCostInProjectCurrency | Decimal | Total committed cost for the forecast version resource assignment in project currency that includes both raw and burden costs. |
| ActualBurdenedCostInProjectCurrency | Decimal | Actual cost incurred for the forecast version resource assignment, including raw and burden costs, in project currency from the start of the project till the current date. |
| ETCBurdenedCostInProjectCurrency | Decimal | Estimated remaining cost in project currency, including raw and burden costs, required for completion of the task by the forecast version resource assignment. |
| EACBurdenedCostInProjectCurrency | Decimal | Estimated cost in project currency, including raw and burden costs, at the completion of the task for the forecast version resource assignment. |
| RequisitionCommittedBurdenedCostInProjectCurrency | Decimal | Cost for the forecast version resource assignment committed through requisitions in project currency that includes both raw and burden costs. |
| PurchaseOrderCommittedBurdenedCostInProjectCurrency | Decimal | Cost for the forecast version resource assignment committed through purchase orders in project currency that includes both raw and burden costs. |
| SupplierInvoiceCommittedBurdenedCostinProjectCurrency | Decimal | Cost for the forecast version resource assignment committed through supplier invoices in project currency that includes both raw and burden costs. |
| TransferOrderCommittedBurdenedCostInProjectCurrency | Decimal | Cost for the forecast version resource assignment committed through transfer orders in project currency that includes both raw and burden costs. |
| TotalCommittedBurdenedCostInProjectLedgerCurrency | Decimal | Total committed cost for the forecast version resource assignment in project ledger currency that includes both raw and burden costs. |
| ActualBurdenedCostInProjectLedgerCurrency | Decimal | Actual cost incurred for the forecast version resource assignment, including raw and burden costs, in project ledger currency from the start of the project till the current date. |
| ETCBurdenedCostInProjectLedgerCurrency | Decimal | Estimated remaining cost in project ledger currency, including raw and burden costs, required for completion of the task by the forecast version resource assignment. |
| EACBurdenedCostInProjectLedgerCurrency | Decimal | Estimated cost in project ledger currency, including raw and burden costs, at the completion of the task for the forecast version resource assignment. |
| RequisitionCommittedBurdenedCostInProjectLedgerCurrency | Decimal | Cost for the forecast version resource assignment committed through requisitions in project ledger currency that includes both raw and burden costs. |
| PurchaseOrderCommittedBurdenedCostInProjectLedgerCurrency | Decimal | Cost for the forecast version resource assignment committed through purchase orders in project ledger currency that includes both raw and burden costs. |
| SupplierInvoiceCommittedBurdenedCostinProjectLedgerCurrency | Decimal | Cost for the forecast version resource assignment committed through supplier invoices in project ledger currency that includes both raw and burden costs. |
| TransferOrderCommittedBurdenedCostInProjectLedgerCurrency | Decimal | Cost for the forecast version resource assignment committed through transfer orders in project ledger currency that includes both raw and burden costs. |
| ActualRevenue | Decimal | Amount of revenue recognized for the forecast version resource assignment in planning currency from the inception of the project to date. |
| ETCRevenue | Decimal | Estimated remaining revenue amount in planning currency to be recognized for the forecast version resource assignment. |
| EACRevenue | Decimal | Estimated revenue amount in planning currency recognized for the forecast version resource assignment at the completion of the task. |
| StandardETCRevenueRate | Decimal | Rate derived from the rate schedule for calculating the planned revenue for the forecast version resource assignment. |
| EffectiveETCRevenueRate | Decimal | Revenue rate that is used to calculate amounts for a forecast version resource assignment. Quantity multiplied by the effective revenue rate gives the revenue. |
| ActualRevenueRate | Decimal | Rate that is used to calculate the actual revenue for the forecast version resource assignment. |
| EACRevenueRate | Decimal | Rate that is used to calculate the estimated revenue at the completion of the task for the forecast version resource assignment. |
| ActualRevenueInProjectCurrency | Decimal | Amount of revenue recognized for the forecast version resource assignment in project currency from the inception of the project to date. |
| ETCRevenueInProjectCurrency | Decimal | Estimated remaining revenue amount in project currency to be recognized for the forecast version resource assignment. |
| EACRevenueInProjectCurrency | Decimal | Estimated revenue amount in project currency recognized for the forecast version resource assignment at the completion of the task. |
| ActualRevenueInProjectLedgerCurrency | Decimal | Amount of revenue recognized for the forecast version resource assignment in project ledger currency from the inception of the project to date. |
| ETCRevenueInProjectLedgerCurrency | Decimal | Estimated remaining revenue amount in project ledger currency to be recognized for the forecast version resource assignment. |
| EACRevenueInProjectLedgerCurrency | Decimal | Estimated revenue amount in project ledger currency recognized for the forecast version resource assignment at the completion of the task. |
| ManualSpreadFlag | Bool | Indicates if the periodic planning is modified and retained for the plan line on date changes. |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | String | projectid |
The Plan Lines Descriptive Flexfields resource is used to view additional information for planning amounts in project forecasts.
| Name | Type | Description |
| ProjectForecastsPlanVersionId [KEY] | Long | Identifier of the forecast version. |
| PlanningresourcesPlanningElementId [KEY] | Long | Identifier of the planning resources of the forecast version. |
| PlanningamountsPlanLineId [KEY] | Long | Identifier of the summary level planning amounts for a resource assignment in the forecast version. |
| PlanLineId [KEY] | Long | Identifier of the summary level planning amounts for a plan line in the project forecast. |
| _FLEX_Context | String | Code that identifies the context for the segments of the plan lines flexfields. |
| _FLEX_Context_DisplayValue | String | Name of the context for the segments of the plan lines flexfields. |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | String | projectid |
The Planning Amount Details resource is used to view project forecast resource assignment periodic amounts.
| Name | Type | Description |
| ProjectForecastsPlanVersionId [KEY] | Long | Identifier of the forecast version. |
| PlanningresourcesPlanningElementId [KEY] | Long | Identifier of the planning resources of the forecast version. |
| PlanningamountsPlanLineId [KEY] | Long | Identifier of the summary level planning amounts for a resource assignment in the forecast version. |
| PlanLineDetailId [KEY] | Long | Identifier of the periodic level planning amounts for a resource assignment in the forecast version. |
| TotalCommittedQuantity | Decimal | Committed effort for the forecast version resource assignment. |
| ActualQuantity | Decimal | Actual effort for the forecast version resource assignment from the start of the project till the current date. |
| ETCQuantity | Decimal | Estimated remaining effort by the  forecast version resource assignment for completion. |
| EACQuantity | Decimal | Measure of the effort planned for in the forecast version resource assignment. |
| PeriodName | String | Period for which the periodic forecast amount is entered. |
| TotalCommittedRawCost | Decimal | Total committed cost for the forecast version resource assignment in planning currency that is directly attributable to the work performed. |
| ActualRawCost | Decimal | Actual cost incurred for the period in the forecast version resource assignment in planning currency that is directly attributable to the work performed from the start of the project till the current date. |
| ETCRawCost | Decimal | Estimated remaining cost in planning currency required for completion of the task in the period by the forecast version resource assignment that is directly attributable to the work performed. |
| EACRawCost | Decimal | Estimated cost in planning currency at the completion of the task in the period for the forecast version resource assignment that is directly attributable to the work performed. |
| StandardETCRawCostRate | Decimal | Rate derived from the rate schedule for calculating the planned raw cost for the forecast version resource assignment. |
| EffectiveETCRawCostRate | Decimal | Cost rate that is used to calculate amounts for a forecast version resource assignment. Quantity multiplied by the effective raw cost rate gives the raw cost amounts. |
| ActualRawCostRate | Decimal | Rate that is used to calculate the actual cost for the forecast version resource assignment that is directly attributable to the work performed. |
| EACRawCostRate | Decimal | Rate that is used to calculate the estimated cost at the completion of the task for the forecast version resource assignment that is directly attributable to the work performed. |
| TotalCommittedBurdenedCost | Decimal | Total committed cost for the forecast version resource assignment in planning currency that includes both raw and burden costs. |
| ActualBurdenedCost | Decimal | Actual cost incurred for the forecast version resource assignment, including raw and burden costs, in planning currency from the start of the project till the current date. |
| ETCBurdenedCost | Decimal | Estimated remaining cost in planning currency, including raw and burden costs, required for completion of the task by the forecast version resource assignment. |
| EACBurdenedCost | Decimal | Estimated cost in planning currency, including raw and burden costs, at the completion of the task for the forecast version resource assignment. |
| StandardETCBurdenedCostRate | Decimal | Average rate derived from the rate schedule for calculating the planned burdened cost for the forecast version resource assignment. |
| EffectiveETCBurdenedCostRate | Decimal | Cost rate that is used to calculate amounts for a forecast version resource assignment. Quantity multiplied by the effective burdened cost rate gives the burdened cost amounts. |
| ActualBurdenedCostRate | Decimal | Actual burdened cost rate that is used to calculate the actual cost for the forecast version resource assignment that includes both raw and burden costs. |
| EACBurdenedCostRate | Decimal | Rate that is used to calculate the actual cost for the forecast version resource assignment that includes both raw and burden costs. |
| RequisitionCommittedQuantity | Decimal | Effort for the forecast version resource assignment committed through requisitions. |
| PurchaseOrderCommittedQuantity | Decimal | Effort for the forecast version resource assignment committed through purchase orders. |
| SupplierInvoiceCommittedQuantity | Decimal | Effort for the forecast version resource assignment committed through supplier invoices. |
| TransferOrderCommittedQuantity | Decimal | Effort for the forecast version resource assignment committed through transfer orders. |
| RequisitionCommittedRawCost | Decimal | Cost for the forecast version resource assignment committed through requisitions in planning currency that is directly attributable to the work performed. |
| PurchaseOrderCommittedRawCost | Decimal | Cost for the forecast version resource assignment committed through purchase orders in planning currency that is directly attributable to the work performed. |
| SupplierInvoiceCommittedRawCost | Decimal | Cost for the forecast version resource assignment committed through supplier invoices in planning currency that is directly attributable to the work performed. |
| TransferOrderCommittedRawCost | Decimal | Cost for the forecast version resource assignment committed through transfer orders in planning currency that is directly attributable to the work performed. |
| RequisitionCommittedBurdenedCost | Decimal | Cost for the forecast version resource assignment committed through requisitions in planning currency that includes both raw and burden costs. |
| PurchaseOrderCommittedBurdenedCost | Decimal | Cost for the forecast version resource assignment committed through purchase orders in planning currency that includes both raw and burden costs. |
| SupplierInvoiceCommittedBurdenedCost | Decimal | Cost for the forecast version resource assignment committed through supplier invoices in planning currency that includes both raw and burden costs. |
| TransferOrderCommittedBurdenedCost | Decimal | Cost for the forecast version resource assignment committed through transfer orders in planning currency that includes both raw and burden costs. |
| TotalCommittedRawCostInProjectCurrency | Decimal | Total committed cost for the forecast version resource assignment in project currency that is directly attributable to the work performed. |
| ActualRawCostInProjectCurrency | Decimal | Actual cost incurred for the forecast version resource assignment in project currency that is directly attributable to the work performed from the start of the project till the current date. |
| ETCRawCostInProjectCurrency | Decimal | Estimated remaining cost in project currency required for completion of the task by the forecast version resource assignment that is directly attributable to the work performed. |
| EACRawCostInProjectCurrency | Decimal | Estimated cost in project currency at the completion of the task for the forecast version resource assignment that is directly attributable to the work performed. |
| RequisitionCommittedRawCostInProjectCurrency | Decimal | Cost for the forecast version resource assignment committed through requisitions in project currency that is directly attributable to the work performed. |
| PurchaseOrderCommittedRawCostInProjectCurrency | Decimal | Cost for the forecast version resource assignment committed through purchase orders in project currency that is directly attributable to the work performed. |
| SupplierInvoiceCommittedRawCostInProjectCurrency | Decimal | Cost for the forecast version resource assignment committed through supplier invoices in project currency that is directly attributable to the work performed. |
| TransferOrderCommittedRawCostInProjectCurrency | Decimal | Cost for the forecast version resource assignment committed through transfer orders in project currency that is directly attributable to the work performed. |
| TotalCommittedRawCostInProjectLedgerCurrency | Decimal | Total committed cost for the forecast version resource assignment in project ledger currency that is directly attributable to the work performed. |
| ActualRawCostInProjectLedgerCurrency | Decimal | Actual cost incurred for the forecast version resource assignment in project ledger currency that is directly attributable to the work performed from the start of the project till the current date. |
| ETCRawCostInProjectLedgerCurrency | Decimal | Estimated remaining cost in project ledger currency required for completion of the task by the forecast version resource assignment that is directly attributable to the work performed. |
| EACRawCostInProjectLedgerCurrency | Decimal | Estimated cost in project ledger currency at the completion of the task for the forecast version resource assignment that is directly attributable to the work performed. |
| RequisitionCommittedRawCostInProjectLedgerCurrency | Decimal | Cost for the forecast version resource assignment committed through requisitions in project ledger currency that is directly attributable to the work performed. |
| PurchaseOrderCommittedRawCostInProjectLedgerCurrency | Decimal | Cost for the forecast version resource assignment committed through purchase orders in project ledger currency that is directly attributable to the work performed. |
| SupplierInvoiceCommittedRawCostInProjectLedgerCurrency | Decimal | Cost for the forecast version resource assignment committed through supplier invoices in project ledger currency that is directly attributable to the work performed. |
| TransferOrderCommittedRawCostInProjectLedgerCurrency | Decimal | Cost for the forecast version resource assignment committed through transfer orders in project ledger currency that is directly attributable to the work performed. |
| TotalCommittedBurdenedCostInProjectCurrency | Decimal | Total committed cost for the forecast version resource assignment in project currency that includes both raw and burden costs. |
| ActualBurdenedCostInProjectCurrency | Decimal | Actual cost incurred for the forecast version resource assignment, including raw and burden costs, in project currency from the start of the project till the current date. |
| ETCBurdenedCostInProjectCurrency | Decimal | Estimated remaining cost in project currency, including raw and burden costs, required for completion of the task by the forecast version resource assignment. |
| EACBurdenedCostInProjectCurrency | Decimal | Estimated cost in project currency, including raw and burden costs, at the completion of the task for the forecast version resource assignment. |
| RequisitionCommittedBurdenedCostInProjectCurrency | Decimal | Cost for the forecast version resource assignment committed through requisitions in project currency that includes both raw and burden costs. |
| PurchaseOrderCommittedBurdenedCostInProjectCurrency | Decimal | Cost for the forecast version resource assignment committed through purchase orders in project currency that includes both raw and burden costs. |
| SupplierInvoiceCommittedBurdenedCostInProjectCurrency | Decimal | Cost for the forecast version resource assignment committed through supplier invoices in project currency that includes both raw and burden costs. |
| TransferOrderCommittedBurdenedCostInProjectCurrency | Decimal | Cost for the forecast version resource assignment committed through transfer orders in project currency that includes both raw and burden costs. |
| TotalCommittedBurdenedCostInProjectLedgerCurrency | Decimal | Total committed cost for the forecast version resource assignment in project ledger currency that includes both raw and burden costs. |
| ActualBurdenedCostInProjectLedgerCurrency | Decimal | Actual cost incurred for the forecast version resource assignment, including raw and burden costs, in project ledger currency from the start of the project till the current date. |
| ETCBurdenedCostInProjectLedgerCurrency | Decimal | Estimated remaining cost in project ledger currency, including raw and burden costs, required for completion of the task by the forecast version resource assignment. |
| EACBurdenedCostInProjectLedgerCurrency | Decimal | Estimated cost in project ledger currency, including raw and burden costs, at the completion of the task for the forecast version resource assignment. |
| RequisitionCommittedBurdenedCostInProjectLedgerCurrency | Decimal | Cost for the forecast version resource assignment committed through requisitions in project ledger currency that includes both raw and burden costs. |
| PurchaseOrderCommittedBurdenedCostInProjectLedgerCurrency | Decimal | Cost for the forecast version resource assignment committed through purchase orders in project ledger currency that includes both raw and burden costs. |
| SupplierInvoiceCommittedBurdenedCostInProjectLedgerCurrency | Decimal | Cost for the forecast version resource assignment committed through supplier invoices in project ledger currency that includes both raw and burden costs. |
| TransferOrderCommittedBurdenedCostInProjectLedgerCurrency | Decimal | Cost for the forecast version resource assignment committed through transfer orders in project ledger currency that includes both raw and burden costs. |
| ActualRevenue | Decimal | Amount of revenue recognized for the forecast version resource assignment in planning currency from the inception of the project to date. |
| ETCRevenue | Decimal | Estimated remaining revenue amount in planning currency to be recognized for the forecast version resource assignment. |
| EACRevenue | Decimal | Estimated revenue amount in planning currency recognized for the forecast version resource assignment at the completion of the task. |
| StandardETCRevenueRate | Decimal | Rate derived from the rate schedule for calculating the planned revenue for the forecast version resource assignment. |
| EffectiveETCRevenueRate | Decimal | Revenue rate that is used to calculate amounts for a forecast version resource assignment. Quantity multiplied by the effective revenue rate gives the revenue. |
| ActualRevenueRate | Decimal | Rate that is used to calculate the actual revenue for the forecast version resource assignment. |
| EACRevenueRate | Decimal | Rate that is used to calculate the estimated revenue at the completion of the task for the forecast version resource assignment. |
| ActualRevenueInProjectCurrency | Decimal | Amount of revenue recognized for the forecast version resource assignment in project currency from the inception of the project to date. |
| ETCRevenueInProjectCurrency | Decimal | Estimated remaining revenue amount in project currency to be recognized for the forecast version resource assignment. |
| EACRevenueInProjectCurrency | Decimal | Estimated revenue amount in project currency recognized for the forecast version resource assignment at the completion of the task. |
| ActualRevenueInProjectLedgerCurrency | Decimal | Amount of revenue recognized for the forecast version resource assignment in project ledger currency from the inception of the project to date. |
| ETCRevenueInProjectLedgerCurrency | Decimal | Estimated remaining revenue amount in project ledger currency to be recognized for the forecast version resource assignment. |
| EACRevenueInProjectLedgerCurrency | Decimal | Estimated revenue amount in project ledger currency recognized for the forecast version resource assignment at the completion of the task. |
| ManualSpreadFlag | Bool | Indicates if the periodic planning is modified and retained for the plan line on date changes. |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| PlanVersionId | Long | planversionid |
| ProjectId | String | projectid |
The Errors resource is used to view the errors in project forecasts.
| Name | Type | Description |
| ProjectForecastsPlanVersionId [KEY] | Long | Identifier of the forecast version. |
| PlanVersionId | Decimal | Identifier of the project budget version. |
| TaskNumber | String | Number of the task which is used to create a budget line. |
| TaskName | String | Name of the task which is used to create a budget line. |
| ResourceName | String | The name of the resource which is used to create a budget line. |
| TransactionCurrencyCode | String | Currency code for budget line with errors. |
| PeriodName | String | Period for which the periodic budget amount is entered. |
| ErrorType | String | Specifies whether a warning or error. |
| MessageName | String | Message code for the issue encountered. |
| MessageText | String | Error or warning that occurs or information that informs users to know what action to take or to understand what is happening. |
| MessageCause | String | Explanation for the resaon of an error or warning message. |
| MessageUserDetails | String | More detailed explanation of the message text that explains why the message occurred. |
| MessageUserAction | String | States the response that the end users must perform to continue and complete their tasks in response to an error or warning message. |
| FinancialPlanType | String | financialplantype |
| Finder | String | finder |
| ProjectId | String | projectid |
The Project Issues resource is used to view issues associated to the project.
| Name | Type | Description |
| IssueId [KEY] | Long | Unique identifier of the issue. |
| IssueUISummary | String | Summarized description of the issue. |
| IssueNumber | String | The generated number of the issue. |
| IssueOwnerId | Long | Unique identifier of the person resource who owns the issue. |
| ProjectId | Long | Unique identifier of the project associated to the issue. |
| PriorityCode | String | Code representing the priority of the issue. Valid values are HIGH, MEDIUM, and LOW. |
| StatusCode | String | Code representing the status of the issue. Valid values are IN PROGRESS, NOT STARTED, and COMPLETE. |
| IssueTypeId | Long | Unique identifier of the issue type. |
| IssueDescription | String | Detailed description of the issue. |
| NeedByDate | Date | Date by which the issue should be resolved or closed. |
| DateCreated | Date | Date when the issue was created. |
| ClosedDate | Date | Date when the issue is closed. |
| ClosedReasonCode | String | Code representing the reason for closing an issue as CANCELED, DUPLICATE, OBSOLETE, or RESOLVED. |
| Resolution | String | Text summarizing the resolution when closing the issue. |
| ReopenSummary | String | Text describing the reason to reopen the issue. |
| IssueCreatorId | Long | Unique identifier of the person resource who created the issue. |
| IssueUpdatedByName | String | Name of the person who last updated the issue. |
| UpdateDate | Datetime | Date when the issue was last updated. |
| IssueOwnerEmail | String | Email of the person who owns the issue. |
| IssueOwnerName | String | Name of the person who owns the issue. |
| ProjectName | String | Name of the project associated to the issue. |
| ProjectNumber | String | Generated number of the project associated to the issue. |
| IssuePriority | String | Priority of the issue as high, medium, or low. |
| IssueStatus | String | Status of the issue as new, in progress, or closed. |
| IssueCreatorEmail | String | Email of the person who created the issue. |
| IssueCreatorName | String | Name of the person who created the issue. |
| ClosedReason | String | Reason for closing an issue such as resolved or obsolete. |
| IssueType | String | The type used to categorize the issue, such as general. |
| ObjectId | Long | The identifier of the object to which an issue is assigned. |
| ObjectType | String | The identifier of the type of object to which the issue is assigned, such as Program. |
| TaskId | Long | Id of the task for which issue is created. |
| Task | String | Name of the task for which issue is created. |
| Finder | String | finder |
The attachments resource is used to view attachments.
| Name | Type | Description |
| ProjectIssuesIssueId [KEY] | Long | The unique identifier of the issue. |
| AttachedDocumentId [KEY] | Long | The unique identifier of the attached document. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| DatatypeCode | String | A value that indicates the data type. |
| FileName | String | The file name of the attachment. |
| DmFolderPath | String | The folder path from which the attachment is created. |
| DmDocumentId | String | The document ID from which the attachment is created. |
| DmVersionNumber | String | The document version number from which the attachment is created. |
| Url | String | The URL of a web page type attachment. |
| CategoryName | String | The category of the attachment. |
| UserName | String | The login credentials of the user who created the attachment. |
| Uri | String | The URI of a Topology Manager type attachment. |
| FileUrl | String | The URI of the file. |
| UploadedText | String | The text content for a new text attachment. |
| UploadedFileContentType | String | The content type of the attachment. |
| UploadedFileLength | Long | The size of the attachment file. |
| UploadedFileName | String | The name to assign to a new attachment file. |
| ContentRepositoryFileShared | Bool | Indicates whether the attachment is shared |
| Title | String | The title of the attachment. |
| Description | String | The description of the attachment. |
| ErrorStatusCode | String | The error code, if any, for the attachment. |
| ErrorStatusMessage | String | The error message, if any, for the attachment. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| FileContents | String | The contents of the attachment. |
| ExpirationDate | Datetime | The expiration date of the contents in the attachment. |
| LastUpdatedByUserName | String | The user name who last updated the record. |
| CreatedByUserName | String | The user name who created the record. |
| AsyncTrackerId | String | Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. |
| FileWebImage | String | The base64 encoded image of the file displayed in .png format if the source is a convertible image. |
| DownloadInfo | String | JSON object represented as a string containing information used to programmatically retrieve a file attachment. |
| PostProcessingAction | String | The name of the action that can be performed after an attachment is uploaded. |
| Finder | String | finder |
| IssueId | Long | issueid |
The Project Issues Action Items resource is used to view action items. Action items are tasks that are defined for issues that facilitates issue resolution.
| Name | Type | Description |
| ProjectIssuesIssueId [KEY] | Long | The unique identifier of the issue. |
| ActionItemId [KEY] | Long | Unique identifier of the action item associated to the issue. |
| ActionItemOwnerName | String | Name of the person who owns the action item. |
| ActionItemStatus | String | Status of the action item as new, in progress, or closed. |
| ActionItemOwnerEmail | String | Email of the person who owns the action item. |
| ActionItemSummary | String | Summary text describing the action item associated to the issue. |
| NeedByDate | Date | Date by which the action item should be resolved or closed. |
| ActionItemOwnerId | Long | Unique identifier of the person resource who owns the action item. |
| Description | String | Detailed text describing the action item associated to the issue. |
| ActionItemStatusCode | String | Code representing the status of the action item. Valid values are IN PROGRESS, NOT STARTED, and COMPLETE. |
| Finder | String | finder |
| IssueId | Long | issueid |
The Project Numbering Configurations resource is used to specify the source by which project numbering is configured.
| Name | Type | Description |
| ConfigurationId [KEY] | String | Unique identifier of the project numbering configuration. |
| ConfigureByCode | String | Code of the source by which project numbering is set up. Valid values are ORA_PJF_PROJ_UNIT, ORA_PJF_BU_UNIT, ORA_PJF_PROJ_TYPE, and ORA_PJF_NONE. |
| ConfigureBy | String | Name of the source by which project numbering is set up. Valid values are Project Unit, Business Unit, Project Type, and None. |
| LastUpdatedBy | String | The user who last updated the record. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| Finder | String | finder |
The Project Numbering Configuration Details resource is used to specify the details of the project numbering setup. The project numbering setup includes a mandatory default configuration and optional override configuration.
| Name | Type | Description |
| ProjectNumberingConfigurationsConfigurationId [KEY] | String | Unique identifier of the project numbering configuration. |
| ConfigurationDetailId [KEY] | Long | Unique identifier of the project numbering source details. |
| DeterminantId | Long | Unique identifier of the entity for which project numbering is set up. |
| DeterminantName | String | Name of the entity for which project numbering is set up. |
| MethodCode | String | Code of the project numbering method. Valid values are AUTOMATIC and MANUAL. |
| Method | String | Name of the project numbering method. Valid values are Automatic and Manual. |
| TypeCode | String | Code of the manual project numbering type. Valid values are ALPHANUMERIC and NUMERIC. |
| Type | String | Name of the manual project numbering Type. Valid values are Alphanumeric and Numeric. |
| Prefix | String | Prefix for the project numbering. |
| NextAutomaticNumber | Long | Next number to be generated for an automatic project numbering configuration. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| LastUpdatedBy | String | The user who last updated the record. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| ConfigurationId | String | configurationid |
| Finder | String | finder |
The Project Organizations LOV resource is used to view a project organization. This object includes attributes which are used to store values of a project organization.
| Name | Type | Description |
| OrganizationName | String | Name of the project organization. |
| OrganizationId [KEY] | Long | Unique identifier of the project organization. |
| BusinessUnitId [KEY] | Long | Unique identifier of the business unit to which the project organization belongs. |
| FromDate | Date | Effective start date of the project organization. |
| ToDate | Date | Effective end date of the project organization. |
| ActiveStatusFlag | Bool | Indicates if the project organization is active. Valid values are true and false. |
| ProjectOrganizationType [KEY] | String | Type of the project organization. Valid values are PROJECTS and EXPENDITURES. |
| Finder | String | finder |
The Planning Resource Breakdown Structures for Projects resource is used to view planning resource breakdown structure assignments to projects. You can view the header details, project information, and whether the planning resource breakdown structure is marked as primary.
| Name | Type | Description |
| AllowResourceChangesFlag | Bool | Indicates if new resources specific to the project can be added to the planning resource breakdown structure. |
| AssignedToProjectId | Long | Unique identifier of the project to which the resource breakdown structure is associated. |
| AssignedToProjectName | String | Name of the project to which the resource breakdown structure is associated. |
| AssignedToProjectNumber | String | Number of the project to which the resource breakdown structure is associated. |
| Description | String | Description of the resource breakdown structure. |
| JobSetId | Long | Unique identifier of the job set. |
| JobSetName | String | Name of the job set. |
| PlanningUsageFlag | Bool | Indicates if the resource breakdown structure is used for planning purposes. |
| PrimaryPlanningFlag | Bool | Indicates if a resource breakdown structure is the primary planning resource breakdown structure for a project. |
| PrimaryReportingRbsFlag | Bool | Indicates if a resource breakdown structure is the primary reporting resource breakdown structure for a project. |
| ProjectUnitId | Long | Unique identifier of the project unit. |
| ProjectUnitName | String | Name of the project unit. |
| RbsEndDate | Date | End date of the resource breakdown structure. |
| RbsHeaderId | Long | Unique identifier of the resource breakdown structure. |
| RbsName | String | Name of the resource breakdown structure. |
| RbsPrjAssignmentId [KEY] | Long | Unique identifier of the assignment of the resource breakdown structure version to the project. |
| RbsStartDate | Date | Start date of the resource breakdown structure. |
| RbsVersionId | Long | Unique identifier of the resource breakdown structure version. The value is derived based on the specified resource breakdown structure. Any value provided by user is ignored. |
| ReportingUsageFlag | Bool | Indicates if a resource breakdown structure is used for reporting purposes. |
| TemplateFlag | Bool | Indicates if a resource breakdown structure is assigned to a project template. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| AllowChangingPrimaryPrbsFlag | Bool | Indicates if the primary planning resource breakdown structure can be changed even though there are task assignments and draft progress for the project. Valid values are true and false. By default, the value is false. |
| AutoAddResourceFlag | Bool | Indicates whether to automatically add resources on incurring actual amounts. By default, the resources will be copied from setup level resource breakdown structure. |
| Finder | String | finder |
The Elements resource is used to view and create resources in a planning resource breakdown structure.
| Name | Type | Description |
| ProjectPlanningRbsRbsPrjAssignmentId [KEY] | Long | Unique identifier of the assignment of the resource breakdown structure version to the project. |
| DisabledFlag | Bool | Indicates if the resource is disabled for use in planning. |
| EventTypeId | Long | Unique identifier of the event type. If the format has Event Type, then you must enter a value for either this attribute or Event Type but not both while creating a resource element. |
| EventTypeName | String | Name of the event type. If the format has Event Type, then you must enter a value for either this attribute or Event Type ID but not both while creating a resource element. |
| ExpenditureCategoryId | Long | Unique identifier of the expenditure category. If the format has Expenditure Category, then you must enter a value for either this attribute or Expenditure Category but not both while creating a resource element. |
| ExpenditureCategoryName | String | Name of the expenditure category. If the format has Expenditure Category, then you must enter a value for either this attribute or Expenditure Category ID but not both while creating a resource element. |
| ExpenditureTypeId | Long | Unique identifier of the expenditure type. If the format has Expenditure Type, then you must enter a value for either this attribute or Expenditure Type but not both while creating a resource element. |
| ExpenditureTypeName | String | Name of the expenditure type. If the format has Expenditure Type, then you must enter a value for either this attribute or Expenditure Type ID but not both while creating a resource element. |
| FormatId | Long | Unique identifier of the resource format. You must enter a value for either this attribute or Format but not both while creating a resource element. |
| FormatName | String | Name of the resource format. You must enter a value for either this attribute or Format ID but not both while creating a resource element. |
| InventoryItemId | Long | Unique identifier of the inventory item. If the format has Inventory Item, then you must enter a value for either this attribute or Inventory Item Number but not both while creating a resource element. |
| InventoryItemNumber | String | Number assigned to the inventory item. If the format has Inventory Item, then you must enter a value for either this attribute or Inventory Item ID but not both while creating a resource element. |
| ItemCategoryCode | String | Code of the item category. If the format has Item Category, then you must enter a value for only one from among this attribute, Item Category ID, and Item Category but not all three or a combination of them while creating a resource element. |
| ItemCategoryId | Long | Unique identifier of the item category. If the format has Item Category, then you must enter a value for only one from among this attribute, Item Category Code, and Item Category but not all three or a combination of them while creating a resource element. |
| ItemCategoryName | String | Name of the item category. If the format has Item Category, then you must enter a value for only one from among this attribute, Item Category ID, and Item Category Code but not all three or a combination of them while creating a resource element. |
| JobCode | String | Code of the job. If the format has Job, then you must enter a value for only one from among this attribute, Job ID, and Job but not all three or a combination of them while creating a resource element. |
| JobId | Long | Unique identifier of the job. If the format has Job, then you must enter a value for only one from among this attribute, Job Code, and Job but not all three or a combination of them while creating a resource element. |
| JobName | String | Name of the job. If the format has Job, then you must enter a value for only one from among this attribute, Job ID, and Job Code but not all three or a combination of them while creating a resource element. |
| NonlaborResourceId | Long | Unique identifier of the nonlabor resource. If the format has Project Nonlabor Resource, then you must enter a value for either this attribute or Nonlabor Resource but not both while creating a resource element. |
| NonlaborResourceName | String | Name of the nonlabor resource. If the format has Project Nonlabor Resource, then you must enter a value for either this attribute or Nonlabor Resource ID but not both while creating a resource element. |
| OrganizationId | Long | Unique identifier of the organization. If the format has Organization, then you must enter a value for either this attribute or Organization but not both while creating a resource element. |
| OrganizationName | String | Name of the organization. If the format has Organization, then you must enter a value for either this attribute or Organization ID but not both while creating a resource element. |
| PersonEmail | String | Email of the person. If the format has Named Person, then you must enter a value for only one from among this attribute, Person ID, and Person but not all three or a combination of them while creating a resource element. |
| PersonId | Long | Unique identifier of the person. If the format has Named Person, then you must enter a value for only one from among this attribute, Person Email, and Person but not all three or a combination of them while creating a resource element. |
| PersonName | String | Name of the person. If the format has Named Person, then you must enter a value for only one from among this attribute, Person ID, and Person Email but not all three or a combination of them while creating a resource element. |
| PersonType | String | Type of the person. If the format has System Person Type, then you must enter a value for either this attribute or Person Type Code but not both while creating a resource element. |
| PersonTypeCode | String | Code of the person type. If the format has System Person Type, then you must enter a value for either this attribute or Person Type but not both while creating a resource element. |
| ProjectRoleId | Long | Unique identifier of the project role. If the format has Project Role, then you must pass a value for Project Role ID or Project Role Name but not both values while creating a resource element. |
| ProjectRoleName | String | Name of the project role. If the format has Project Role, then you must pass a value for Project Role ID or Project Role Name but not both values while creating a resource element. |
| ResourceClassId | Long | Unique identifier of the resource class. You must enter a value for either this attribute or Resource Class but not both while creating a resource element. |
| ResourceClassName | String | Name of the resource class. You must enter a value for either this attribute or Resource Class ID but not both while creating a resource element. |
| ResourceElementId [KEY] | Long | Unique identifier of the resource breakdown structure element. |
| RevenueCategoryCode | String | Code of the revenue category. If the format has Revenue Category, then you must enter a value for either this attribute or Revenue Category but not both while creating a resource element. |
| RevenueCategoryName | String | Name of the revenue category. If the format has Revenue Category, then you must enter a value for either this attribute or Revenue Category ID but not both while creating a resource element. |
| SpreadCurveId | Long | Unique identifier of the spread curve. If you want to specify the spread curve, then you must enter a value for either this attribute or Spread Curve but not both while creating a resource element. |
| SpreadCurveName | String | Name of the spread curve. If you want to specify the spread curve, then you must enter a value for either this attribute or Spread Curve ID but not both while creating a resource element. |
| SupplierId | Long | Unique identifier of the supplier. If the format has Supplier, then you must enter a value for only one from among this attribute, Supplier Number, and Supplier but not all three or a combination of them while creating a resource element. |
| SupplierName | String | Name of the supplier. If the format has Supplier, then you must enter a value for only one from among this attribute, Supplier ID, and Supplier Number but not all three or a combination of them while creating a resource element. |
| SupplierNumber | String | Number assigned to the supplier. If the format has Supplier, then you must enter a value for only one from among this attribute, Supplier ID, and Supplier but not all three or a combination of them while creating a resource element. |
| UnitOfMeasure | String | Name of the default unit of measure of costing or planning transactions. |
| UnitOfMeasureCode | String | Code of the default unit of measure of costing or planning transactions. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| ResourceName | String | User defined short name for the resource breakdown structure element. |
| Finder | String | finder |
| RbsPrjAssignmentId | Long | rbsprjassignmentid |
The Project Planning Resources LOV is used to view a list of active resources from a planning resource breakdown structure associated with a project.
| Name | Type | Description |
| ResourceName | String | User-defined name of the project planning resource. |
| RbsElementId [KEY] | Long | Unique identifier of a resource within a planning resource breakdown structure version. |
| RbsVersionId [KEY] | Long | Unique identifier of a planning resource breakdown structure version. |
| ProjectId [KEY] | Long | Unique identifier of a project. |
| BindPrbsName | String | bindprbsname |
| BindProjectId | Long | bindprojectid |
| BindProjectName | String | bindprojectname |
| BindProjectNumber | String | bindprojectnumber |
| BindVersionId | Long | bindversionid |
| Finder | String | finder |
The Formats resource is used to view all resource formats supported by a planning resource breakdown structure.
| Name | Type | Description |
| ProjectPlanningRbsRbsPrjAssignmentId [KEY] | Long | Unique identifier of the assignment of the resource breakdown structure version to the project. |
| EquipmentFlag | Bool | Indicates if the resource format supports the Equipment resource class. |
| FinancialResourcesFlag | Bool | Indicates if the resource format supports the Financial Resources resource class. |
| FormatId | Long | Unique identifier of the resource format. |
| FormatName | String | Name of the resource format. |
| LaborFlag | Bool | Indicates if the resource format supports the Labor resource class. |
| MaterialItemsFlag | Bool | Indicates if the resource format supports the Material Items resource class. |
| RbsFormatId [KEY] | Long | Unique identifier of the association of a resource format to the resource breakdown structure. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| Finder | String | finder |
| RbsPrjAssignmentId | Long | rbsprjassignmentid |
The Project Process Configurators resource is used to view project process configurators.
| Name | Type | Description |
| ConfiguratorId [KEY] | Long | Unique identifier for a configurator. |
| ActiveFlag | Bool | Indicates if a project configurator is active. |
| BusinessProcessCode | String | Indicates the code for the business process for which the project configurator is created. |
| CreatedBy | String | The user who created the configurator. |
| CreationDate | Datetime | The date when the record was created. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| Name | String | Name of the configurator entered by the user. |
| UserConfiguration | String | The expression created for the configurator on which the processing is performed. |
| BusinessProcess | String | Indicates the name for the business process for which the project configurator is created. |
| Finder | String | finder |
The Source Assignments resource is used to view a Source for a configurator.
| Name | Type | Description |
| ProjectProcessConfiguratorsConfiguratorId [KEY] | Long | Unique identifier for a configurator. |
| SourceAssignmentId [KEY] | Long | Unique identifier for configurator source assignment. |
| Alias | String | The user provided alias for each configurator source assignment. |
| ConfiguratorId | Long | Unique identifier for a configurator. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| UserFilter | String | The user entered filter for the configurator source assignment. |
| SourceName | String | Indicates the name for the configurator source. |
| Finder | String | finder |
Associations resource is used to manage the association of templates or reports to a business object like a program. A template is associated with a program to generate the corresponding report.
| Name | Type | Description |
| AutoPublish | String | The indicator specifying if a report gets auto-published. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| CurrencyCode | String | The currency code used for monetary amounts in the report. |
| Frequency | String | The frequency for publishing the report for associated objects like daily, weekly, biweekly, monthly, quarterly, or yearly. |
| InactiveFlag | Bool | Indicates the status of the report or a template. Only active templates can generate reports. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdateLogin | String | The login details of user who last updated the record. |
| LastUpdatedBy | String | The user who last updated the record. |
| ScheduleStartDate | Datetime | The start date for publishing a report based on its frequency. |
| AssociationId [KEY] | Long | The unique identifier of an association of template or report to a business object. |
| ReportId | Long | The unique identifier of a template or report. |
| FrequencyCode | String | The frequency code for publishing the report for associated objects. |
| LastGeneratedDate | Datetime | The last generated date of the report. |
| SourceObjectName | String | The name of the business object to which the report belongs, or the template is associated. |
| SourceObjectNumber | String | The unique number identifier of the business object to which the report belongs, or the template is associated. |
| Currency | String | The currency used for monetary amounts in the report. |
| AutoPublishCode | String | The code for the indicator specifying if a report gets auto-published. |
| TemplateFlag | Bool | The indicator specifying if the record is for a template or report. |
| SourceObjectId | Long | The unique identifier of an object to which the report belongs or a template is associated. |
| AssociationDescription | String | Description of the association. |
| AssociationName | String | Name of the association. |
| NextDueDate | Datetime | The next due publishing date of the report. |
| StatusCode | String | The code for the status of the template or report like DRAFT, UNPUBLISHED, or PUBLISHED. |
| Status | String | The status of the template or report like draft, unpublished, or published. |
| OwnerPersonId | Long | Person-ID of the template or report owner. |
| OwnerPersonEmail | String | Email of the template or report owner. |
| OwnerPersonName | String | The template or report owner. |
| AsOfPeriodName | String | The name of the program calendar period. The period with this name is the as-of-period for the measure time dimension. |
| Archived | String | Attribute indicating whether the reports are archived or not. |
| SourceObjectUserAccess | String | The access type that a logged-in user has to the program or template associated with a report. For example, if the report belongs to the North America Implementations program and the logged-in user owns the program, this attribute has the value ORA_PJS_OWNER. |
| SourceObjectPublicFlag | Bool | The public access indicator for the program with which a report or template is associated. For example, if the report is associated with the North America Implementations program, this attribute indicates whether the program can be publicly accessed within the organization. |
| Finder | String | finder |
Project Program Communication Catalogs resource is used to manage the catalog objects to create templates and reports.
| Name | Type | Description |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| ItemDataType | String | The catalog object data type like text, number, amount, or date. |
| ItemListLookupCode | String | The code for list of values that an item of type input-list is based on. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdateLogin | String | The login details of user who last updated the record. |
| LastUpdatedBy | String | The user who last updated the record. |
| ObjectDescription | String | The description of the catalog object. |
| ObjectGroupOwnerPersonId | Long | The identifier of the owner of a user-created group object. |
| ObjectGroupPublicAccessCode | String | The code specifying whether a user-created group is available to others for use. |
| ItemDisplayFlag | Bool | The indicator specifying if an item is displayed on the UI. |
| ObjectIcon | String | The icon of items in a group. |
| ObjectId [KEY] | Long | The unique identifier of a catalog object. |
| ObjectLabelPosition | String | The label alignment of a catalog object like left, center, or right. |
| ObjectLevel | Int | The level in an object hierarchy. |
| ObjectName | String | The title of the catalog object. |
| ObjectGroupNewLine | String | The indicator specifying if an item appears in a new line within a group. |
| ObjectParentId | Long | The parent object identifier of the objects that are part of a group in a catalog. |
| ObjectGroupSequence | Int | The sequence of items in a group. |
| ObjectTypeCode | String | The code of object types in a catalog like a group, item, and table. |
| TableColumnHeaderOne | String | The header for the first column of the table-type items. |
| TableColumnHeaderTwo | String | The header for the second column of the table-type items. |
| TableColumnHeaderThree | String | The header for the third column of the table-type items. |
| TableColumnHeaderFour | String | The header for the fourth column of the table-type items. |
| TableColumnHeaderFive | String | The header for the fifth column of the table-type items. |
| TableColumnHeaderSix | String | The header for the sixth column of the table-type items. |
| TableColumnTypeOne | String | The type, like text, date, number, or amount, for the first column of the table-type items. |
| TableColumnTypeTwo | String | The type, like text, date, number, or amount, for the second column of the table-type items. |
| TableColumnTypeThree | String | The type, like text, date, number, or amount, for the third column of the table-type items. |
| TableColumnTypeFour | String | The type, like text, date, number, or amount, for the fourth column of the table-type items. |
| TableColumnTypeFive | String | The type, like text, date, number, or amount, for the fifth column of the table-type items. |
| TableColumnTypeSix | String | The type, like text, date, number, or amount, for the sixth column of the table-type items. |
| TableDefaultSortColumnNumber | Int | The default column number for sorting table data. |
| TableDefaultSortOrder | String | The default sort order, like ascending or descending, on a table column. |
| TableGraphTypeCode | String | The code for default graph type which is required only for a table-type item. |
| TableGraphType | String | The default graph type, like bar or pie, to be rendered for a table-type item. |
| ObjectType | String | The types of objects in a catalog like a group, item, and table. |
| ObjectGroupPublicAccess | String | The access whether a user-created group is available to others for use. |
| TableDefaultSortColumn | String | The name of default column for sorting table data. |
| ObjectParentName | String | The parent object name of the objects that are part of a group in a catalog. |
| ObjectGroupOwnerPersonName | String | The name of the owner of a user-created group object. |
| ObjectGroupOwnerPersonEmail | String | The email of the owner of a user-created group object. |
| ItemListLookup | String | The list of values that an item of type input-list is based on. |
| ObjectReferenceId | Long | The catalog self-reference of the object for the group. |
| MeasureName | String | Name of the performance measure item in the catalog. |
| Finder | String | finder |
The Project Programs resource is used to manage project programs and the program hierarchical structure. A program is a collection of projects that are managed as a group to coordinate, monitor and implement a corporate strategy.
| Name | Type | Description |
| AssessmentCode | String | The code that represents the program owner's ongoing assessment for the likelihood that the program will meet the program objectives. Examples for assessments are On track and At risk. A list of accepted values is defined in the lookup type ORA_PROJECT_PROGRAM_ASSESSMENT. Review and update the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. |
| AssessmentMeaning | String | The program owner's ongoing assessment for the likelihood that the program will meet the program objectives. Examples for assessments are On track and At risk. A list of accepted values is defined in the lookup type ORA_PROJECT_PROGRAM_ASSESSMENT. Review and update the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| FinishDate | Date | The date when the program is finished. The value is for informational purposes only. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| LineOfBusinessCode | String | The code that represents the line of business name for the set of products and services that are managed by the program. Examples for line of business names are Product development and All lines of business. A list of accepted values is defined in the lookup type ORA_PROJECT_PROGRAM_BUSINESS. Review and update the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. |
| LineOfBusinessMeaning | String | The line of business name for the set of products and services that are managed by the program. Examples for line of business names are Product development and All lines of business. A list of accepted values is defined in the lookup type ORA_PROJECT_PROGRAM_BUSINESS. Review and update the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. |
| ParentProgramId | Long | The unique identifier of the parent program. A program without a parent is the root node in the hierarchy structure. |
| ParentProgramNumber | String | The unique number of the parent program. A program without a parent is the root node in the hierarchy structure. |
| PriorityCode | String | The code that represents the priority for the program. Examples for priority are High, Medium, and Low. A list of accepted values is defined in the lookup type ORA_PROJECT_PROGRAM_PRIORITY. Review and update the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. |
| PriorityMeaning | String | The priority for the program. Examples for priority are High, Medium, and Low. A list of accepted values is defined in the lookup type ORA_PROJECT_PROGRAM_PRIORITY. Review and update the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. |
| ProgramDescription | String | The description of the program. |
| ProjectProgramId [KEY] | Long | The unique identifier of the program. |
| ProgramName | String | The unique name of the program. A value is required to create a program. |
| ProgramNumber | String | The unique number of the program. The default value is the unique identifier of the program. |
| ProgramObjective | String | The objective of the program. |
| ProgramStatusName | String | The status of the program. Examples for status are Draft and Active. A value is required to create a program. Review and update the program status list of values using the Setup and Maintenance work area and the Manage Project Statuses task. |
| ProgramSystemStatusCode | String | The code that represents the system status defined for the program status. Values are DRAFT, SUBMITTED, ACTIVE, PENDING_CLOSE, and CLOSED. Review and update the program status list of values using the Setup and Maintenance work area and the Manage Project Statuses task. |
| PublicFlag | Bool | Indicates whether the program hierarchy can be viewed by all. If true, then programs in the hierarchy can be viewed by all. If false, then only the persons assigned as stakeholders directly or inherited from a parent or grandparent program can view their programs. The value is defined for the root node of the hierarchy. The default value is false. |
| RegionCode | String | The code that represents the geographic or divisional region that's covered by the program. Examples for region names are North America and All regions. A list of accepted values is defined in the lookup type ORA_PROJECT_PROGRAM_REGION. Review and update the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. |
| RegionMeaning | String | The geographic or divisional region that's covered by the program. Examples for region names are North America and All regions. A list of accepted values is defined in the lookup type ORA_PROJECT_PROGRAM_REGION. Review and update the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. |
| StartDate | Date | The date on which the program starts. The value is for informational purposes only. |
| StrategyCode | String | The code that represents the strategic plan of actions and policies that are targeted by the program. An example for strategy is Innovation. A list of accepted values is defined in the lookup type ORA_PROJECT_PROGRAM_STRATEGY. Review and update the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. |
| StrategyMeaning | String | The strategic plan of actions and policies that are targeted by the program. An example strategy is Innovation. A list of accepted values is defined in the lookup type ORA_PROJECT_PROGRAM_STRATEGY. Review and update the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. |
| TreeStructureId | Long | The unique identifier of the program hierarchy structure. |
| OwningOrganizationName | String | The name of the owning organization. The value is for informational purposes only. Review and update organizations classified as owning organizations using the Setup and Maintenance work area and the task Manage Project Organization Classifications. |
| OwningOrganizationId | Long | The unique identifier of the owning organization. |
| ProgramBudget | Decimal | The budgeted amount allotted to the program. |
| ProgramBudgetCurrency | String | The currency of the budgeted amount allotted to the program. |
| Finder | String | finder |
| PersonId | Long | personid |
| ProjectId | Long | projectid |
The Program Avatars resource is used to manage the avatar image for a program. A program can have only one avatar at a time.
| Name | Type | Description |
| ProjectProgramsProjectProgramId [KEY] | Long | The unique identifier of the program. |
| ImageId [KEY] | Long | The unique identifier of the image for a program. |
| Image | String | The base 64 encoded image. |
| ImageName | String | The name of the image. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| LastUpdatedBy | String | The user who last updated the record. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| Finder | String | finder |
| PersonId | Long | personid |
| ProjectId | Long | projectid |
| ProjectProgramId | Long | projectprogramid |
| TreeStructureId | String | treestructureid |
The operations from the Project Programs/Program Descriptive Flexfields category.
| Name | Type | Description |
| ProjectProgramsProjectProgramId [KEY] | Long | The unique identifier of the program. |
| ProjectProgramId [KEY] | Long | The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId= |
| _FLEX_Context | String | Context Segment |
| _FLEX_Context_DisplayValue | String | Context Segment |
| Finder | String | finder |
| PersonId | Long | personid |
| ProjectId | Long | projectid |
| TreeStructureId | String | treestructureid |
The Program Notes resource is used to manage notes for programs.
| Name | Type | Description |
| ProjectProgramsProjectProgramId [KEY] | Long | The unique identifier of the program. |
| NoteId [KEY] | Long | The unique identifier of the program note. |
| NoteNumber | String | The unique number of the program note. The default value is a system-generated number. |
| NoteTxt | String | The text for the program note. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| CreatorPartyId | Long | Unique identifier of the user who created the note. |
| PartyName | String | Name of the user who created the note. |
| Finder | String | finder |
| PersonId | Long | personid |
| ProjectId | Long | projectid |
| ProjectProgramId | Long | projectprogramid |
| TreeStructureId | String | treestructureid |
The Project Assignments resource is used to manage the assignments of projects to a program.
| Name | Type | Description |
| ProjectProgramsProjectProgramId [KEY] | Long | The unique identifier of the program. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| ProjectId | Long | The unique identifier of the project. |
| RelationshipId [KEY] | Long | The unique identifier of the project assignment to a program. |
| ProjectNumber | String | The unique number of the project. |
| Finder | String | finder |
| PersonId | Long | personid |
| ProjectProgramId | Long | projectprogramid |
| TreeStructureId | String | treestructureid |
The Project Assignment Notes resource is used to manage notes for the project assignments to a program.
| Name | Type | Description |
| ProjectProgramsProjectProgramId [KEY] | Long | The unique identifier of the program. |
| ProgramprojectsRelationshipId [KEY] | Long | The unique identifier of the project assignment to a program. |
| NoteId [KEY] | Long | The unique identifier of the project assignment note. |
| NoteNumber | String | The unique number of the project assignment note. The default value is a system-generated number. |
| NoteTxt | String | The text for the project assignment note. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| LastUpdatedBy | String | The user who last updated the record. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| CreatorPartyId | Long | Unique identifier of the user who created the note. |
| PartyName | String | Name of the user who created the note. |
| Finder | String | finder |
| PersonId | Long | personid |
| ProjectId | Long | projectid |
| ProjectProgramId | Long | projectprogramid |
| TreeStructureId | String | treestructureid |
The Stakeholders resource is used to manage the assignment of stakeholders and program administrators for a program.
| Name | Type | Description |
| ProjectProgramsProjectProgramId [KEY] | Long | The unique identifier of the program. |
| StakeholderAssociationId [KEY] | Long | The unique identifier of the stakeholder assignment to a program. |
| AccessTypeCode | String | The code that represents the access type for the assignee. The assignee with owner access can edit and delete the program. An assignee with contributor access can edit the program. An assignee with viewer access can view the program and receive stakeholder communications. The person who creates the program is the default owner. Only one direct assignment can have owner access at a given time. Valid values are OWNER, EDIT, and VIEW. The default value is VIEW. |
| AccessType | String | The access type for the assignee. The assignee with owner access can edit and delete the program. An assignee with contributor access can edit the program. An assignee with viewer access can view the program and receive stakeholder communications. The person who creates the program is the default owner. Only one direct assignment can have owner access at a given time. Valid values are Owner, Contributor, and Viewer. The default value is Viewer. |
| AssignmentCategoryCode | String | The code that represents the assignment category for the assignee as directly assigned or inherited from the program's parent or grandparent in the program hierarchy. Values are INHERITED and DIRECT. |
| AssignmentCategory | String | The assignment category for the assignee as directly assigned or inherited from the program's parent or grandparent in the program hierarchy. Values are Inherited and Direct. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| PersonId | Long | The unique identifier of the person who's assigned to the program as a stakeholder. |
| PersonName | String | The name of the person who's assigned to the program as a stakeholder. |
| PersonEmail | String | The email of the person who's assigned to the program as a stakeholder. |
| ImageId | Long | The unique identifier of the avatar image for a person. |
| ImageName | String | The name of the avatar image for a person. |
| Image | String | The avatar image for a person. |
| Finder | String | finder |
| ProjectId | Long | projectid |
| ProjectProgramId | Long | projectprogramid |
| TreeStructureId | String | treestructureid |
The Project Program Users resource is used to manage display preferences for users who define, coordinate, and monitor programs. Display preferences includes performance measures, watchlist, and currency. The resource is also used to retrieve the performance measures enabled for programs by your application administrator.
| Name | Type | Description |
| PersonId [KEY] | Decimal | The unique identifier of the person. |
| PersonName | String | The name of the person. |
| Finder | String | finder |
The Program Preferences resource is used to manage your program management display preferences. Display preferences includes performance measures, watchlist, and currency. Replace the person ID in the REST API path with the value -1 to get performance measures enabled for programs by your application administrator.
| Name | Type | Description |
| ProjectProgramUsersPersonId [KEY] | Decimal | The unique identifier of the person. |
| PreferenceId [KEY] | Long | The unique identifier of the display preference. |
| PreferenceType | String | The code that represents the type of preference. Examples for preference type include program currency, watchlists, and preferred performance measures for program analysis. A list of accepted values is defined in the lookup type ORA_PJS_PREFERENCE_TYPES. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. |
| PreferenceValue | String | The value for the display preference. The value depends on the preference type. For program analysis and highlights, provide the performance measure REST API attribute name. Replace the person ID in the REST API path with the value -1 to get a list of valid attribute names for performance measures enabled for programs by your project application administrator. For a program watchlist, provide the program ID. Provide the project ID for a project watchlist. Provide the ISO currency code for your preferred program currency. |
| RelatedPreferenceValue | String | The additional context for your display preference. For example, the program ID is the related preference value for a project added to the watchlist. |
| DisplaySequence | Long | The order in which the preference value displays. |
| DefaultFlag | Bool | Indicates whether the performance measure is displayed in the default view of the program analysis user interface. When the value is true, the measure is displayed. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| PreferenceValueTranslation | String | The user-defined name for the performance measure. |
| PreferencePropertyOne | String | An additional property of the preference value. |
| PreferencePropertyTwo | String | An additional property of the preference value. |
| PreferencePropertyThree | String | An additional property of the preference value. |
| PreferencePropertyFour | String | An additional property of the preference value. |
| PreferencePropertyFive | String | An additional property of the preference value. |
| PreferencePropertySix | String | An additional property of the preference value. |
| PreferencePropertySeven | String | An additional property of the preference value. |
| PreferencePropertyEight | String | An additional property of the preference value. |
| PreferencePropertyNine | String | An additional property of the preference value. |
| PreferencePropertyTen | String | An additional property of the preference value. |
| Finder | String | finder |
| PersonId | String | personid |
The Project Progress resource is used to capture draft progress, view draft and published progress, update draft progress, and publish progress for a project enabled for financial management.
| Name | Type | Description |
| ProjectId | Long | Unique identifier of the project. |
| ProjectName | String | Name assigned to the project. |
| ProjectNumber | String | Alphanumeric identifier of the project. |
| SourceApplicationCode | String | The third-party application from which the project originated. |
| SourceProjectReference | String | The identifier of the project in the external application where it was originally created. |
| ProgressAsOfDate | Date | Date through which progress is captured for the project. |
| ProgressAsOfPeriod | String | Period through which progress is captured for the project. |
| ActualAmountsThroughPeriod | String | Period through which actual amounts are summarized for project progress. |
| ActualAmountsDate | Date | Date on which actual amounts are summarized for project progress. |
| PublicationStatus | String | Status of current project progress. The status can either be Draft or Published. |
| CurrentActualAmountsPeriod | String | Period through which actual amounts are most recently summarized. |
| CurrentActualAmountsDate | Date | Date on which actual amounts are most recently summarized. |
| PlannedStartDate | Date | Scheduled start date of the project. |
| PlannedFinishDate | Date | Scheduled end date of the project. |
| BaselineStartDate | Date | Planned start date of the project in baseline project plan. Used to compare the deviation of the current project start from the original planned start date. |
| BaselineFinishDate | Date | Planned end date of the project in baseline project plan. Used to compare the deviation of the current project end from the original planned end date. |
| EstimatedStartDate | Date | Projected start date of the project. |
| EstimatedFinishDate | Date | Projected end date of the project. |
| ActualStartDate | Date | Date on which work commenced on the project as opposed to the planned start date of the project. |
| ActualFinishDate | Date | Date on which work completed on the project as opposed to the planned end date of the project. |
| PercentComplete | Double | The amount of physical work achieved on the project. |
| PreviousPercentComplete | Double | The amount of physical work achieved on the project in the most recently captured progress. |
| ProjectCurrency | String | The currency code for the project. The currency code is a three-letter ISO code associated with a currency. |
| ProjectRawActualCost | Decimal | Actual amount paid or actual amount incurred for the project in project currency. |
| ProjectBurdenedActualCost | Decimal | Cost that is actualy charged to the project in project currency. Burdened cost is the sum of raw cost and the overhead. |
| ProjectLedgerCurrency | String | The currency code used for accounting and reporting in the project ledger. The currency code is a three-letter ISO code associated with a currency. |
| ProjectLedgerRawActualCost | Decimal | Actual amount paid or actual amount incurred for the project in project ledger currency. |
| ProjectLedgerBurdenedActualCost | Decimal | Cost that is actualy charged to the project in project ledger currency. Burdened cost is the sum of raw cost and the overhead. |
| ProgressStatusCode | String | Code of the status, such as In Trouble, On Track or At Risk, that indicates the overall progress of the project. |
| ProgressStatus | String | Status, such as In Trouble, On Track or At Risk, that indicates the overall progress of the project. |
| Finder | String | finder |
The Attachment resource is used to view attachments for project progress.
| Name | Type | Description |
| AttachedDocumentId [KEY] | Long | The unique identifier of the attached document. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| DatatypeCode | String | A value that indicates the data type. |
| FileName | String | The file name of the attachment. |
| DmFolderPath | String | The folder path from which the attachment is created. |
| DmDocumentId | String | The document ID from which the attachment is created. |
| DmVersionNumber | String | The document version number from which the attachment is created. |
| Url | String | The URL of a web page type attachment. |
| CategoryName | String | The category of the attachment. |
| UserName | String | The login credentials of the user who created the attachment. |
| Uri | String | The URI of a Topology Manager type attachment. |
| FileUrl | String | The URI of the file. |
| UploadedText | String | The text content for a new text attachment. |
| UploadedFileContentType | String | The content type of the attachment. |
| UploadedFileLength | Long | The size of the attachment file. |
| UploadedFileName | String | The name to assign to a new attachment file. |
| ContentRepositoryFileShared | Bool | Indicates whether the attachment is shared |
| Title | String | The title of the attachment. |
| Description | String | The description of the attachment. |
| ErrorStatusCode | String | The error code, if any, for the attachment. |
| ErrorStatusMessage | String | The error message, if any, for the attachment. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| FileContents | String | The contents of the attachment. |
| ExpirationDate | Datetime | The expiration date of the contents in the attachment. |
| LastUpdatedByUserName | String | The user name who last updated the record. |
| CreatedByUserName | String | The user name who created the record. |
| AsyncTrackerId | String | Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. |
| FileWebImage | String | The base64 encoded image of the file displayed in .png format if the source is a convertible image. |
| DownloadInfo | String | JSON object represented as a string containing information used to programmatically retrieve a file attachment. |
| PostProcessingAction | String | The name of the action that can be performed after an attachment is uploaded. |
| Finder | String | finder |
| ProgressAsOfDate | Date | progressasofdate |
| ProjectId | Long | projectid |
| ProjectName | String | projectname |
| ProjectNumber | String | projectnumber |
| PublicationStatus | String | publicationstatus |
| SourceApplicationCode | String | sourceapplicationcode |
| SourceProjectReference | String | sourceprojectreference |
The Note resource is used to view, create, update, and delete notes for project progress.
| Name | Type | Description |
| NoteId [KEY] | Long | The unique identifier of the progress note. |
| NoteTxt | String | The text for the progress note. |
| LastUpdatedBy | String | The user who last updated the record. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| Finder | String | finder |
| ProgressAsOfDate | Date | progressasofdate |
| ProjectId | Long | projectid |
| ProjectName | String | projectname |
| ProjectNumber | String | projectnumber |
| PublicationStatus | String | publicationstatus |
| SourceApplicationCode | String | sourceapplicationcode |
| SourceProjectReference | String | sourceprojectreference |
The Project Progress Descriptive Flexfields resource is used to view, create, and update additional information for project progress.
| Name | Type | Description |
| _FLEX_Context | String | Context of the descriptive flexfield. |
| _FLEX_Context_DisplayValue | String | Context display value of the descriptive flexfield. |
| Finder | String | finder |
| ProgressAsOfDate | Date | progressasofdate |
| ProjectId | Long | projectid |
| ProjectName | String | projectname |
| ProjectNumber | String | projectnumber |
| PublicationStatus | String | publicationstatus |
| SourceApplicationCode | String | sourceapplicationcode |
| SourceProjectReference | String | sourceprojectreference |
The Task Progress resource is used to view draft progress for the tasks of a project enabled for financial management.
| Name | Type | Description |
| ProjectId | Long | Unique identifier of the project. |
| ProjectName | String | Name assigned to the project. |
| ProjectNumber | String | Alphanumeric identifier of the project. |
| SourceApplicationCode | String | The third-party application from which the project originated. |
| SourceProjectReference | String | The identifier of the project in the external application where it was originally created. |
| TaskId | Long | Unique identifier of the task. |
| TaskName | String | Name assigned to the task. |
| TaskNumber | String | Alphanumeric identifier of the task. |
| ProgressAsOfDate | Date | Date through which progress is captured for the project. |
| ProgressAsOfPeriod | String | Period through which progress is captured for the project. |
| ActualAmountsThroughPeriod | String | Period through which actual amounts are summarized for project progress. |
| ActualAmountsDate | Date | Date on which actual amounts are most recently summarized. |
| PublicationStatus | String | Status of current project progress. The status can either be Draft or Published. |
| CurrentActualAmountsPeriod | String | Period through which actual amounts are most recently summarized. |
| CurrentActualAmountsDate | Date | Date on which actual amounts are most recently summarized. |
| PlannedStartDate | Date | Scheduled start date of the task. |
| PlannedFinishDate | Date | Scheduled end date of the task. |
| BaselineStartDate | Date | Planned start date of the task in baseline project plan. Used to compare the deviation of the current task start from the original planned start date. |
| BaselineFinishDate | Date | Planned end date of the task in baseline project plan. Used to compare the deviation of the current task end from the original planned end date. |
| EstimatedStartDate | Date | Projected start date of the task. |
| EstimatedFinishDate | Date | Projected end date of the task. |
| ActualStartDate | Date | Date on which work commenced on the task as opposed to the planned start date of the task. |
| ActualFinishDate | Date | Date on which work completed on the task as opposed to the planned end date of the task. |
| PercentComplete | Double | The amount of physical work achieved on the task. |
| PreviousPercentComplete | Double | The amount of physical work achieved on the task in the most recently captured progress. |
| ProjectCurrency | String | The currency code for the project. The currency code is a three-letter ISO code associated with a currency. |
| ProjectRawActualCost | Decimal | Actual amount paid or actual amount incurred for the task in project currency. |
| ProjectBurdenedActualCost | Decimal | Cost that is actualy charged to the task in project currency. Burdened cost is the sum of raw cost and the overhead. |
| ProjectLedgerCurrency | String | The currency code used for accounting and reporting in the project ledger. The currency code is a three-letter ISO code associated with a currency. |
| ProjectLedgerRawActualCost | Decimal | Actual amount paid or actual amount incurred for the task in project ledger currency. |
| ProjectLedgerBurdenedActualCost | Decimal | Cost that is actualy charged to the task in project ledger currency. Burdened cost is the sum of raw cost and the overhead. |
| ProgressStatusCode | String | Code of the status, such as In Trouble, On Track or At Risk, that indicates the overall progress of the task. |
| ProgressStatus | String | Status, such as In Trouble, On Track or At Risk, that indicates the overall progress of the task. |
| Finder | String | finder |
The Attachment resource is used to view attachments for task progress.
| Name | Type | Description |
| AttachedDocumentId [KEY] | Long | The unique identifier of the attached document. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| DatatypeCode | String | A value that indicates the data type. |
| FileName | String | The file name of the attachment. |
| DmFolderPath | String | The folder path from which the attachment is created. |
| DmDocumentId | String | The document ID from which the attachment is created. |
| DmVersionNumber | String | The document version number from which the attachment is created. |
| Url | String | The URL of a web page type attachment. |
| CategoryName | String | The category of the attachment. |
| UserName | String | The login credentials of the user who created the attachment. |
| Uri | String | The URI of a Topology Manager type attachment. |
| FileUrl | String | The URI of the file. |
| UploadedText | String | The text content for a new text attachment. |
| UploadedFileContentType | String | The content type of the attachment. |
| UploadedFileLength | Long | The size of the attachment file. |
| UploadedFileName | String | The name to assign to a new attachment file. |
| ContentRepositoryFileShared | Bool | Indicates whether the attachment is shared |
| Title | String | The title of the attachment. |
| Description | String | The description of the attachment. |
| ErrorStatusCode | String | The error code, if any, for the attachment. |
| ErrorStatusMessage | String | The error message, if any, for the attachment. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| FileContents | String | The contents of the attachment. |
| ExpirationDate | Datetime | The expiration date of the contents in the attachment. |
| LastUpdatedByUserName | String | The user name who last updated the record. |
| CreatedByUserName | String | The user name who created the record. |
| AsyncTrackerId | String | Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. |
| FileWebImage | String | The base64 encoded image of the file displayed in .png format if the source is a convertible image. |
| DownloadInfo | String | JSON object represented as a string containing information used to programmatically retrieve a file attachment. |
| PostProcessingAction | String | The name of the action that can be performed after an attachment is uploaded. |
| Finder | String | finder |
| ProgressAsOfDate | Date | progressasofdate |
| ProjectId | Long | projectid |
| ProjectName | String | projectname |
| ProjectNumber | String | projectnumber |
| PublicationStatus | String | publicationstatus |
| SourceApplicationCode | String | sourceapplicationcode |
| SourceProjectReference | String | sourceprojectreference |
The Note resource is used to view delete notes for task progress.
| Name | Type | Description |
| NoteId [KEY] | Long | The unique identifier of the progress note. |
| NoteTxt | String | The text for the progress note. |
| LastUpdatedBy | String | The user who last updated the record. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| Finder | String | finder |
| ProgressAsOfDate | Date | progressasofdate |
| ProjectId | Long | projectid |
| ProjectName | String | projectname |
| ProjectNumber | String | projectnumber |
| PublicationStatus | String | publicationstatus |
| SourceApplicationCode | String | sourceapplicationcode |
| SourceProjectReference | String | sourceprojectreference |
The Project Progress resource is used to capture draft progress, view draft and published progress, update draft progress, and publish progress for a project enabled for financial management.
| Name | Type | Description |
| ProjectId | Long | Unique identifier of the project. |
| ProjectName | String | Name assigned to the project. |
| ProjectNumber | String | Alphanumeric identifier of the project. |
| SourceApplicationCode | String | The third-party application from which the project originated. |
| SourceApplicationReference | String | The identifier of the project in the external application where it was originally created. |
| TaskId | Long | Unique identifier of the task. |
| TaskName | String | Name assigned to the task. |
| TaskNumber | String | Alphanumeric identifier of the task. |
| ProgressAsOfDate | Date | Date through which progress is captured for the project. |
| ProgressAsOfPeriod | String | Period through which progress is captured for the project. |
| ActualsAmountsThroughPeriod | String | Period through which actual amounts are summarized for project progress. |
| ActualAmountsDate | Date | Date on which actual amounts are most recently summarized. |
| PublicationStatus | String | Status of the current project progress. The status can either be Draft or Published. |
| CurrentActualAmountsPeriod | String | Period through which actual amounts are most recently summarized. |
| CurrentActualAmountsDate | Date | Date on which actual amounts are most recently summarized. |
| PlanningStartDate | Date | Scheduled start date of the task. |
| PlanningEndDate | Date | Scheduled end date of the task. |
| BaselineStartDate | Date | Planned start date of the task in the baseline project plan. Used to compare the deviation of the current task start from the original planned start date. |
| BaselineFinishDate | Date | Planned end date of the task in the baseline project plan. Used to compare the deviation of the current task end from the original planned end date. |
| ProjectCurrency | String | The currency code for the project. It is a three-letter ISO code associated with a currency. |
| ProjectRawActualCost | Decimal | Actual amount paid or actual amount incurred for the task in project currency. |
| ProjectBurdenedActualCost | Decimal | Cost that is actually charged to the task in project currency. Burdened cost is the sum of raw cost and the overhead. |
| ProjectLedgerCurrency | String | The currency code used for accounting and reporting in the project ledger. It is a three-letter ISO code associated with a currency. |
| ProjectLedgerRawActualCost | Decimal | Actual amount paid or actual amount incurred for the task in project ledger currency. |
| ProjectLedgerBurdenedActualCost | Decimal | Cost that is actually charged to the task in project ledger currency. Burdened cost is the sum of raw cost and the overhead. |
| ResourceId | Long | Identifier of the ?resource breakdown structure element ?used to create the financial plan resource assignment. |
| ResourceName | String | Name or alias of the resource included in the planning resource breakdown structure that is used to create the financial plan resource assignment. |
| UnitOfMeasure | String | Unit of work that measures the quantity of effort for which the resource is planned for on the financial plan resource assignment. |
| ResourceClass | String | Grouping of predefined resource types to which the resource in the financial plan resource assignment belongs. ?A list of valid values are Labor, Equipment, Material Items, and Financial Resources. |
| ResourceAssignmentFromDate | Date | The date that is planned on the financial plan for a resource to begin their assignment on a project task. |
| ResourceAssignmentToDate | Date | The date that is planned on the financial plan for a resource to finish their assignment on a project task. |
| EstimatedStartDate | Date | An estimated start date collected during progress entry and usually defaulted to the resource assignments planned start date. |
| EstimatedFinishDate | Date | An estimated finish date collected during progress entry and usually defaulted to the resource assignments planned to date. |
| ActualStartDate | Date | Actual start date collected during progress entry. |
| ActualFinishDate | Date | Actual finish date collected during progress entry. |
| EstimatetoCompleteQuantity | Decimal | Estimate to complete in quantity. |
| EstimatetoCompleteCostinProjectCurrency | Decimal | Estimate to complete burdened cost in project currency. |
| EstimateatCompletionQuantity | Decimal | Estimate at completion quantity. |
| EstimateatCompletionCostinProjectCurrency | Decimal | Estimate at completion burdened cost in project currency. |
| Unplanned | String | Unplanned project cost included on the project. |
| BaselinedPlannedEffort | Decimal | Baselined planned effort from the financial project plan. |
| BaselinedPlannedQuantity | Decimal | Baselined planned quantity from the financial project plan. |
| BaselinedPlannedCost | Decimal | Baseline planned burdened cost from the project plan |
| CurrentPlannedEffort | Decimal | Current planned effort from the financial project plan. |
| CurrentPlannedQuantity | Decimal | Current planned quantity from the financial project plan. |
| CurrentPlannedCost | Decimal | Current planned burdened cost from the project plan |
| Finder | String | finder |
| SourceProjectReference | String | sourceprojectreference |
The Attachment resource is used to view attachments for resource progress.
| Name | Type | Description |
| AttachedDocumentId [KEY] | Long | The unique identifier of the attached document. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| DatatypeCode | String | A value that indicates the data type. |
| FileName | String | The file name of the attachment. |
| DmFolderPath | String | The folder path from which the attachment is created. |
| DmDocumentId | String | The document ID from which the attachment is created. |
| DmVersionNumber | String | The document version number from which the attachment is created. |
| Url | String | The URL of a web page type attachment. |
| CategoryName | String | The category of the attachment. |
| UserName | String | The login credentials of the user who created the attachment. |
| Uri | String | The URI of a Topology Manager type attachment. |
| FileUrl | String | The URI of the file. |
| UploadedText | String | The text content for a new text attachment. |
| UploadedFileContentType | String | The content type of the attachment. |
| UploadedFileLength | Long | The size of the attachment file. |
| UploadedFileName | String | The name to assign to a new attachment file. |
| ContentRepositoryFileShared | Bool | Indicates whether the attachment is shared |
| Title | String | The title of the attachment. |
| Description | String | The description of the attachment. |
| ErrorStatusCode | String | The error code, if any, for the attachment. |
| ErrorStatusMessage | String | The error message, if any, for the attachment. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| FileContents | String | The contents of the attachment. |
| ExpirationDate | Datetime | The expiration date of the contents in the attachment. |
| LastUpdatedByUserName | String | The user name who last updated the record. |
| CreatedByUserName | String | The user name who created the record. |
| AsyncTrackerId | String | Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. |
| FileWebImage | String | The base64 encoded image of the file displayed in .png format if the source is a convertible image. |
| DownloadInfo | String | JSON object represented as a string containing information used to programmatically retrieve a file attachment. |
| PostProcessingAction | String | The name of the action that can be performed after an attachment is uploaded. |
| Finder | String | finder |
| ProgressAsOfDate | Date | progressasofdate |
| ProjectId | Long | projectid |
| ProjectName | String | projectname |
| ProjectNumber | String | projectnumber |
| PublicationStatus | String | publicationstatus |
| SourceApplicationCode | String | sourceapplicationcode |
| SourceProjectReference | String | sourceprojectreference |
The Note resource is used to view notes for resource progress.
| Name | Type | Description |
| NoteId [KEY] | Long | The unique identifier of the progress note. |
| NoteTxt | String | The text for the progress note. |
| LastUpdatedBy | String | The user who last updated the record. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| Finder | String | finder |
| ProgressAsOfDate | Date | progressasofdate |
| ProjectId | Long | projectid |
| ProjectName | String | projectname |
| ProjectNumber | String | projectnumber |
| PublicationStatus | String | publicationstatus |
| SourceApplicationCode | String | sourceapplicationcode |
| SourceProjectReference | String | sourceprojectreference |
The Resource Progress Descriptive Flexfields resource is used to view, create, and update additional information for resource progress.
| Name | Type | Description |
| _FLEX_Context | String | Context of the descriptive flexfield. |
| _FLEX_Context_DisplayValue | String | Context display value of the descriptive flexfield. |
| Finder | String | finder |
| ProgressAsOfDate | Date | progressasofdate |
| ProjectId | Long | projectid |
| ProjectName | String | projectname |
| ProjectNumber | String | projectnumber |
| PublicationStatus | String | publicationstatus |
| SourceApplicationCode | String | sourceapplicationcode |
| SourceProjectReference | String | sourceprojectreference |
The Task Progress Descriptive Flexfields resource is used to view, create, and update additional information for task progress.
| Name | Type | Description |
| _FLEX_Context | String | Context of the descriptive flexfield. |
| _FLEX_Context_DisplayValue | String | Context display value of the descriptive flexfield. |
| Finder | String | finder |
| ProgressAsOfDate | Date | progressasofdate |
| ProjectId | Long | projectid |
| ProjectName | String | projectname |
| ProjectNumber | String | projectnumber |
| PublicationStatus | String | publicationstatus |
| SourceApplicationCode | String | sourceapplicationcode |
| SourceProjectReference | String | sourceprojectreference |
The Project Resource Actual Hours resource is used to view and create actual hours for a resource.
| Name | Type | Description |
| TransactionId [KEY] | Long | Unique identifier of the actual hours record. |
| ResourceId | Long | Identifier of the project enterprise resource who reported actual hours worked. |
| ResourceEmail | String | Email of the project enterprise resource who reported actual hours worked. |
| HCMPersonId | Long | HCM Person identifier of the project enterprise resource for which actual hours are reported. |
| ResourceName | String | Name of the project enterprise resource who reported actual hours worked. |
| WorkDate | Date | Date on which the project enterprise resource worked. |
| UtilizationDate | Date | Date that's associated with the actual hours worked for utilization reporting purposes. If no value is specified, then the utilization date is based on the work date. |
| ProjectId | Long | Identifier of the project for which the project enterprise resource reported the actual hours worked. |
| ProjectNumber | String | Number of the project for which the project enterprise resource reported the actual hours worked. |
| ProjectName | String | Name of the project for which the project enterprise resource reported the actual hours worked. |
| TaskId | Long | Identifier of the task for which the project enterprise resource reported actual hours worked. |
| TaskName | String | Name of the task for which the project enterprise resource reported actual hours worked. |
| ActualHoursWorkedCategory | String | Type of activity that's represented by the actual hours. Examples are Project Work, Paid Time Off, Training, and Other. |
| ActualHoursWorkedCategoryCode | String | Code for the type of activity that's represented by the actual hours. Examples are PROJECT_WORK, PTO, TRAINING, and OTHER. |
| Quantity | Decimal | Total actual hours worked that the resource reports for a day. The actual hours worked can be positive or negative with a maximum of two decimal places. |
| Comments | String | Information about the actual hours reported. |
| UtilizationFlag | Bool | Indicates whether the actual hours reported are eligible to be included in utilization calculations for the resource. Valid values are Y or N. It will default to Y if ActualHoursWorkedCategoryCode is PROJECT_WORK and to N if ActualHoursWorkedCategoryCode is PTO,TRAINING or OTHER. |
| BillableUtilizationFlag | Bool | Indicates whether the actual hours reported will be included in billable resource utilization calculation. Valid values are Y or N. If no value is provided, it will default to Y if ActualHoursWorkedCategoryCode is PROJECT_WORK and to N if ActualHoursWorkedCategoryCode is PTO,TRAINING or OTHER. |
| OriginalTransactionReference | String | Reference to the transaction details in the originating source system. |
| AdjustmentEntryFlag | Bool | Indicates if the actual hours reported represent an adjustment to existing actual hours for a resource. This attribute is set to N during POST operation if no value is specified. |
| AdjustedTransactionReference | String | Reference to the original transaction that this transaction adjusts, if this transaction is for an adjustment. This is an optional value even for an adjustment transaction. |
| Finder | String | finder |
The Project Resource Assignment Daily Hours resource is used to view and manage daily assignment hours for a resource.
| Name | Type | Description |
| AssignDailyHoursId [KEY] | Long | Unique identifier of the project resource assignment that captures the daily assigned hours for a resource. |
| AssignmentId | Long | Unique identifier of the project resource assignment. |
| AssignmentName | String | Name of a project resource assignment. |
| AssignmentStartDate | Date | Start date of a project resource assignment. |
| AssignmentFinishDate | Date | Finish date of a project resource assignment. |
| AssignmentEntryDate | Date | Date that's associated to project resource assignment hours. |
| AssignmentDailyHours | Double | Number of hours for a project resource assignment for a specific day. |
| ResourceId | Long | Unique identifier of the resource for a project resource assignment. |
| ResourceName | String | Name of the resource for a project resource assignment. |
| ResourceEmail | String | Email of the resource for a project resource assignment. |
| ResourceHCMPersonId | Long | Unique identifier of the resource defined in Oracle Human Capital Management for a project resource assignment. |
| ProjectId | Long | Unique identifier of the project for a project resource assignment. |
| ProjectNumber | String | Number of the project for a project resource assignment. |
| ProjectName | String | Name of the project for a project resource assignment. |
| ProjectRoleId | Long | Unique identifier of the project role for a project resource assignment. |
| AssignmentTypeCode | String | Code for the project resource assignment type. Example is BILLABLE. |
| AssignmentType | String | Indicates if the project resource assignment is billable. |
| AssignmentStatusCode | String | Code for the project resource assignment status. Examples are ASSIGNED, RESERVED, PENDING_ADJUSTMENT, and CANCELED. |
| AssignmentStatusName | String | Name of the project resource assignment status. Examples are Confirmed, Reserved, Pending Adjustment, and Canceled. |
| Finder | String | finder |
The Project Resource Assignments resource is used to view project resource assignments.
| Name | Type | Description |
| AssignmentId [KEY] | Long | Unique identifier of the project resource assignment. |
| ResourceId | Long | Unique identifier of the resource who is selected for the assignment. To identify the resource, you may provide a value for this attribute or for Resource Email attribute but not both. Resource is mandatory when creating an assignment. |
| ResourceEmail | String | Email of the resource who is selected for the assignment. To identify the resource, you may provide a value for this attribute or for Resource ID attribute but not both. |
| ResourceHCMPersonId | Long | HCM person identifier for the project enterprise resource who is selected for the assignment. |
| ResourceName | String | Name of the resource that is selected for the assignment. |
| ProjectId | Long | Unique identifier of the project associated to the resource assignment. To identify the project, you may provide a value only for this attribute, the Project Number attribute, or the Project Name attribute. Project is mandatory when creating an assignment. |
| ProjectNumber | String | Unique number of the project associated to the resource assignment. To identify the project associated to the assignment, you may provide a value only for this attribute or the Project ID attribute or the Project Name attribute. |
| ProjectName | String | Name of the project associated to the resource assignment. To identify the project associated to the assignment, you may provide a value only for this attribute, Project ID attribute, or the Project Number attribute. |
| AssignmentStartDate | Date | The date from which the resource is assigned to the project assignment. If no value is passed when creating the assignment, it defaults to the system date. |
| AssignmentEndDate | Date | The date until which the resource is engaged on the project assignment. If no value is passed when creating the assignment, it defaults to project end date. |
| AssignmentStatusCode | String | Status code of the assignment. |
| AssignmentStatusName | String | Status of the assignment. |
| ProjectRoleId | Long | Identifier of the role that the selected resource is assigned to on a project assignment. To identify the project role, you may provide a value for this attribute or for Project Role Name attribute but not both. Project Role value is mandatory when creating an assignment. |
| ProjectRoleName | String | Name of the role that the selected resource is assigned to on a project resource assignment. To identify the project role, you may provide a value for only this attribute or for Project Role ID attribute but not both. |
| UseProjectCalendarFlag | Bool | Indicates if the hours for the assignment are provided in Assignment Hours Per Day attribute or if it should be derived from the project calendar. Valid values are Y and N. If the value is Y, the assignment hours are derived from the project calendar. |
| AssignmentHoursPerDay | Decimal | A period of time measured in hours for each day for the project resource assignment. Mandatory if you are passing Use Project Calendar Flag attribute value as N. |
| CostRateCurrencyCode | String | Code of the currency used to define the cost rate. |
| CostRate | Decimal | Rate that represents the cost rate for the resource on the assignment. |
| BillRateCurrencyCode | String | Code of the currency used to define the bill rate. The bill rate currency must be the same as the project currency. |
| BillRate | Decimal | Rate that represents the targeted bill rate for the resource on the assignment. |
| AssignmentLocation | String | Location for the work specified on the project resource assignment. |
| ReservationReasonCode | String | Code for the reason for reserving a resource on the project resource assignment. You may provide a value for this attribute or for Reservation Reason attribute but not both. Applies only if the Assignment Status is RESERVED. |
| ReservationReason | String | Reason for reserving a resource on the project resource assignment. You may provide a value for this attribute or for Resource Reason Code attribute but not both. Applies only if the Assignment Status is RESERVED. |
| ReservationExpirationDate | Date | Date until which the resource should be reserved on the project. On or before this date, you should either confirm the assignment or cancel the reservation. |
| AssignmentComments | String | Additional details for the project resource assignment. |
| AssignmentExternalIdentifier | String | Identifier of the assignment in an external application. |
| AdjustmentType | String | Type of adjustment if some adjustment has happenned on the project resource assignment. |
| AdjustmentTypeCode | String | Code for the adjustment performed on the project resource assignment. |
| CanceledBy | String | The user who canceled the project resource assignment, if the assignment is canceled. |
| CanceledByResourceId | Long | Unique Identifier of the resource who canceled the project resource assignment, if the assignment is canceled. |
| CancellationDate | Date | Date of cancellation if the assignment is canceled. |
| CancellationReason | String | Reason of cancellation if the assignment is canceled. |
| CreationDate | Datetime | The date when the record was created. |
| CreatedBy | String | The user who created the record. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| AssignmentTypeCode | String | Code to indicate if a request is for a billable or a nonbillable assignment. Examples are BILLABLE, NON-BILLABLE, or leave blank. |
| BillablePercent | Int | Indicates the percentage of assignment time that is billable for an assignment that is defined as Billable assignment. For a non-billable assignment, the value is ignored. Valid values are positive integer between 0 and 100. |
| BillablePercentReasonCode | String | Code that indicates the reason that the billable percentage of the project resource assignment is less than 100%. For a non-billable assignment, the value is ignored. |
| AssignmentType | String | Indicates if a request is for a billable or a nonbillable assignment. Examples are BILLABLE, NON-BILLABLE, or leave blank. |
| BillablePercentReason | String | Indicates the reason that the billable percentage of the project resource assignment is less than 100%. For a non-billable assignment, the value is ignored. |
| ProjectManagementFlowFlag | Bool | Flag that indicates if the action is called in the project manager flow. Set this value only if the service is being called in the project manager flow. Default value will be set to resource management flow which is the primary applicationation of the service. |
| UseVariableHoursFlag | Bool | Indicates if the hours for the assignment are variable for every day of the week or not. Valid values are True and False. If the value is True, the assignment hours are derived from the attributes Monday Hours through Sunday Hours. |
| SundayHours | Double | Hours for Sunday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true. |
| MondayHours | Double | Hours for Monday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true. |
| TuesdayHours | Double | Hours for Tuesday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true. |
| WednesdayHours | Double | Hours for Wednesday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true. |
| ThursdayHours | Double | Hours for Thursday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true. |
| FridayHours | Double | Hours for Friday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true. |
| SaturdayHours | Double | Hours for Saturday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true. |
| UseWeeklyHoursFlag | Bool | Indicates if the hours for the assignment are for every week or not. Valid values are True and False. If the value is True, the assignment hours are derived from the attributes AssignmentHoursPerWeek. |
| AssignmentHoursPerWeek | Double | Hours for every week of the assignment duration. Applicable only if Use Weekly Hours Indicator value is true. |
| AssignmentName | String | The name given to a project resource assignment. This name is used to identify an assignment. |
| UseDailyHoursFlag | Bool | Indicates if the hours for the assignment vary each day. Valid values are True and False. If the value is True, the assignment hours can vary each day of the project resource assignment. |
| TotalAssignedHours | Decimal | The total number of hours for a project resource assignment calculated based on the date range, daily hours, working days, and calendar exceptions. |
| ProjResourceId | Long | Identifier of the project labor resource associated with the project resource assignment. |
| PjrAssignmentEO_LastUpdatedOn_c | Datetime | PjrAssignmentEO_LastUpdatedOn_c |
| PjrAssignmentEO_LatestBillRate_c | Int | PjrAssignmentEO_LatestBillRate_c |
| PjrAssignmentEO_LatestCostRate_c | Int | PjrAssignmentEO_LatestCostRate_c |
| PjrAssignmentEO_ProductCode_c | Int | PjrAssignmentEO_ProductCode_c |
| PjrAssignmentEO_ProductLine_c | String | PjrAssignmentEO_ProductLine_c |
| PjrAssignmentEO_ReviewDate_c | Date | PjrAssignmentEO_ReviewDate_c |
| Finder | String | finder |
The Project Resource Pools resource is used to view project resource pools.
| Name | Type | Description |
| ResourcePoolId [KEY] | Long | Unique identifier of the project resource pool. |
| ResourcePoolName | String | Name of the project resource pool. |
| PoolOwnerResourceId | Long | Identifier of the project enterprise resource who's the project resource pool owner. |
| PoolOwnerName | String | Name of the project resource pool owner. |
| PoolOwnerEmail | String | Email of the project resource pool owner. |
| PoolOwnerPersonId | Long | Identifier of the HCM person associated to the project resource pool owner. |
| Description | String | Description of the project resource pool. |
| ParentResourcePoolId | Long | Unique identifier of the parent resource pool. |
| ParentResourcePoolName | String | Name of the parent resource pool. |
| Finder | String | finder |
The Project Resource Pool Managers resource is used to view project resource pool managers associated to a resource pool.
| Name | Type | Description |
| ProjectResourcePoolsResourcePoolId [KEY] | Long | Unique identifier of the project resource pool. |
| PoolManagerId [KEY] | Long | Unique identifier of the project resource pool manager. |
| PoolManagerResourceId | Long | Identifier of the project enterprise resource who's assigned as the resource pool manager. |
| PoolManagerEmail | String | Email of the project resource pool manager. |
| PoolManagerPersonId | Long | Identifier of the HCM person who's assigned as the project resource pool manager. |
| PoolManagerName | String | Name of the project resource pool manager. |
| InheritedFlag | Bool | Indicator if the resource pool manager is inherited from a parent resource pool. |
| Finder | String | finder |
| ResourcePoolId | Long | resourcepoolid |
The Project Resource Pool Members resource is used to view project resource pool members assigned to a resource pool.
| Name | Type | Description |
| ProjectResourcePoolsResourcePoolId [KEY] | Long | Unique identifier of the project resource pool. |
| ResourcePoolMembershipId [KEY] | Long | Unique identifier of the project resource pool membership. |
| ResourceId | Long | Identifier of project enterprise resource who's the project resource pool member. |
| ResourceEmail | String | Email of the project resource pool member. |
| ResourcePersonId | Long | Unique identifier of the HCM person who's the project resource pool member. |
| ResourceName | String | Name of the project enterprise resource who's the project resource pool member. |
| PoolMembershipFromDate | Date | Start date of the resource pool membership. |
| PoolMembershipToDate | Date | Last date of the resource pool membership. |
| Finder | String | finder |
| ResourcePoolId | Long | resourcepoolid |
The Project Resource Requests resource is used to view, create, and manage project resource requests.
| Name | Type | Description |
| ResourceRequestId [KEY] | Long | Identifier of the project resource request. |
| RequestName | String | Name of the project resource request. |
| RequestStatusCode | String | Code of the resource request status. The valid values are OPEN or DRAFT when creating the request. The default value is DRAFT. You can only update the request status from DRAFT to OPEN. |
| RequestStatus | String | Status of the project resource request. |
| RequestedStartDate | Date | Date from which a resource is requested. If no value is provided, the value is set to the current date for projects with start date in the past, and to the project start date for projects with start date in the future. |
| RequestedFinishDate | Date | Date until which a resource is requested. If no value is provided, the value is set to the project end date. You must provide a value if the project does not have an end date. |
| RequestFulfilledDate | Date | Date on which the project resource request is fulfilled. |
| RequestedHoursperDay | Double | Period of time measured in hours that establishes the number of requested hours per working day on a project resource request. You must provide a value if you have set the Use Project Calendar Indicator attribute value to N. |
| UseProjectCalendarFlag | Bool | Flag that indicates if the hours for the assignment is provided in Requested Hours per Day attribute or should be derived from the project calendar. The valid values are Y and N. If the value is Y, the request hours is derived from the project calendar. |
| Location | String | Resource assignment location specificed on the resource request. |
| RequestedResourceId | Long | Identifier of the resource who is selected to fulfill the project resource request, if the Requested Quantity is equal to 1. You may enter a value for only this attribute or for Requested Resource Email but not both. |
| RequestedResourceName | String | Name of the project enterprise resource who is selected to fulfill the project resource request, if the Requested Quantity is equal to 1. |
| RequestedResourceEmail | String | Email of the resource who is selected to fulfill the project resource request, if the Requested Quantity is equal to 1. You may enter a value for only this attribute or for Requested Resource ID but not both. |
| RequestedResourcePersonId | Long | HCM person identifier for the project enterprise resource who is selected to fulfill the project resource request, if the Requested Quantity is equal to 1. |
| ProjectId | Long | Unique identifier of the project associated to the resource request. To identify the project, you may provide a value only for this attribute, the Project Number attribute, or the Project Name attribute. Project is mandatory when creating an OPEN request. |
| ProjectName | String | Name of the project associated to the resource request. To identify the project, you may provide a value only for this attribute, the Project ID attribute, or the Project Name attribute. |
| ProjectNumber | String | Unique number of the project associated to the resource request. To identify the project, you may provide a value only for this attribute, the Project ID attribute, or the Project Name attribute. |
| ProjectRoleId | Long | Unique identifier of the role that the selected resources will be assigned to on the project. You may enter a value only for this attribute or for Project Role Name but not both. |
| ProjectRoleName | String | Role that the selected resources will be assigned to on the project. You may enter a value only for this attribute or for Project Role ID but not both. |
| RequesterResourceId | Long | Unique identifier of the project enterprise resource who requests the resources, mostly the project manager. You may enter a value only for this attribute or for Requester Email but not both. |
| RequesterName | String | Name of the project enterprise resource who requests the resources. |
| RequesterEmail | String | Email of the project enterprise resource who requests the resources, mostly the project manager. You may enter a value only for this attribute or for Requester Resource ID but not both. |
| RequesterPersonId | Long | Identifier of the HCM person who requests the resources. |
| SpecialInstructions | String | Special instructions for the project resource request, such as requester instructions to the resource manager. |
| StaffingOwnerResourceId | Long | Identifier of the project enterprise resource who is responsible for finding resources to fulfill the request. You may enter a value for only this attribute or for Staffing Owner Email but not both. |
| StaffingOwnerName | String | Name of the person who is responsible for finding a resource to fulfill the request. |
| StaffingOwnerEmail | String | Email of the person who is responsible for finding resources to fulfill the request. You may enter a value for only this attribute or Staffing Owner ID but not both. |
| StaffingOwnerPersonId | Long | Identifier of the HCM person who is responsible for finding a resource to fulfill the request. |
| StaffingRemarks | String | Remarks added by the resource manager during staffing. |
| RequestSubmittedDate | Date | Date on which the project resource request is submitted. |
| TargetBillRate | Decimal | Bill rate that represents the targeted rate for the resources who fulfill the request. |
| TargetBillRateCurrencyCode | String | Code of the currency used to define the bill rate. |
| TargetCostRate | Decimal | Cost rate that represents the targeted rate for the resources who are selected on the request. |
| TargetCostRateCurrencyCode | String | Code of the currency used to define the cost rate. |
| RequestedQuantity | Long | The quantity of resources requested for the project resource request. If no value is provided, the value is set to 1. |
| AssignedQuantity | Long | The number of resources assigned to the project for the resource request. |
| ProposedQuantity | Long | The number of resources proposed or nominated for the project resource request. |
| RemainingQuantity | Long | The number of resources remaining to fulfill the project resource request. |
| AssignmentTypeCode | String | Code to indicate if a request is for a billable or a nonbillable assignment. Examples are BILLABLE, NON-BILLABLE, or leave blank. |
| AssignmentType | String | Indicates if a request is for a billable or a nonbillable assignment. Examples are BILLABLE, NON-BILLABLE, or leave blank. |
| BillablePercentReasonCode | String | Code that indicates the reason that the billable percentage of the project resource assignment is less than 100%. For a non-billable assignment, the value is ignored. |
| BillablePercentReason | String | Indicates the reason that the billable percentage of the project resource assignment is less than 100%. For a non-billable assignment, the value is ignored. |
| BillablePercent | Int | Indicates the percentage of assignment time that is billable for an assignment that is defined as Billable assignment. For a non-billable assignment, the value is ignored. Valid values are positive integer between 0 and 100 |
| RequestSource | String | The requester's role specificed on the resource request. |
| UseVariableHoursFlag | Bool | Indicates if the hours for the request are variable for every day of the week or not. Valid values are True and False. If the value is True, the requested hours are derived from the attributes Monday Hours through Sunday Hours. |
| SundayHours | Double | Hours for Sunday of every week for the requested time period. Applicable only if Use Variable Hours Indicator is true. |
| MondayHours | Double | Hours for Monday of every week for the requested time period. Applicable only if Use Variable Hours Indicator value is true. |
| TuesdayHours | Double | Hours for Tuesday of every week for the requested time period. Applicable only if Use Variable Hours Indicator is true. |
| WednesdayHours | Double | Hours for Wednesday of every week for the requested time period. Applicable only if Use Variable Hours Indicator is true. |
| ThursdayHours | Double | Hours for Thursday of every week for the requested time period. Applicable only if Use Variable Hours Indicator is true. |
| FridayHours | Double | Hours for Friday of every week for the requested time period. Applicable only if Use Variable Hours Indicator is true. |
| SaturdayHours | Double | Hours for Saturday of every week for the requested time period. Applicable only if Use Variable Hours Indicator is true. |
| UseWeeklyHoursFlag | Bool | Indicates if the hours for the request are for every week or not. Valid values are True and False. If the value is True, the requested hours are derived from the attributes RequestedHoursPerWeek. |
| RequestedHoursPerWeek | Double | Hours for every week of the requested duration. Applicable only if Use Weekly Hours Indicator value is true. |
| TotalHours | Decimal | Total requested hours for the resource for the particular assignment. |
| Finder | String | finder |
The Project Resource Request Descriptive Flexfields resource is used to view, create, and update descriptive flexfields associated to a project resource request.
| Name | Type | Description |
| ProjectResourceRequestsResourceRequestId [KEY] | Long | Identifier of the project resource request. |
| ResourceRequestId [KEY] | Long | Identifier of the project resource request. |
| _FLEX_Context | String | Context of the descriptive flexfield. |
| _FLEX_Context_DisplayValue | String | Context display value of the descriptive flexfield. |
| Finder | String | finder |
The Project Resource Request Lines resource is used to view the status and details of all proposed or nominated resources associated to the request.
| Name | Type | Description |
| ProjectResourceRequestsResourceRequestId [KEY] | Long | Identifier of the project resource request. |
| RequestLineId [KEY] | Long | Unique identifier of the request line under the project resource request. |
| ResourceId | Long | Identifier of the project enterprise resource associated to the project resource request. |
| ResourceName | String | Name of the project enterprise resource associated to the project resource request. |
| ResourceEmail | String | Email of the project enterprise resource associated to the project resource request. |
| ResourcePersonId | Long | HCM person identifier of the project enterprise resource associated to the project resource request. |
| ResourceStatusCode | String | Status code for the resource associated to the project resource request. |
| ResourceStatus | String | Status of the resource associated to the project resource request. |
| AssignmentId | Long | Identifier of the assignment created for the resource, if an assignment is created for the resource on the request line. |
| AssignmentStatusCode | String | Code of the assignment created for the resource to fulfill the request. |
| AssignmentStatus | String | Status of the assignment created for the resource to fulfill the request. |
| ResourceProposedDate | Date | The date when the resource is proposed or nominated to fulfill the project resource request. |
| ResourceFulfilledDate | Date | The date the resource on the request line is approved to fulfill the project resource request. |
| CurrentFlag | Bool | Indicates whether the project resource request is the most recent request for the assignment. |
| RejectionReasonCode | String | Code to indicate the reason the nominated resource is rejected for the project resource assignment. |
| RejectionReason | String | Reason the nominated resource is rejected for the project resource assignment. |
| AssignmentStartDate | Date | Assignment start date for the resource. |
| AssignmentFinishDate | Date | Assignment finish date for the resource. |
| ProjectRole | String | Resource role for the project assignment. |
| UseProjectCalendarFlag | Bool | Select whether to use project calendar hours or specific hours per day. |
| AssignedHours | Decimal | Assigned hours per day when the specify hours per day is selected for use project calendar flag. |
| ResourceSystemStatus | String | Resource system status based on the seeded values. |
| ReservationReason | String | Select reservation reason for the resource if the assignment status is reserved. |
| ReservationExpirationDate | Date | Select reservation expiration date for the resource if the assignment status is reserved. |
| Finder | String | finder |
| ResourceRequestId | Long | resourcerequestid |
The Project Resource Request Qualifications resource is used to view project resource qualifications under a specific request.
| Name | Type | Description |
| ProjectResourceRequestsResourceRequestId [KEY] | Long | Identifier of the project resource request. |
| ResourceRequestDetailId [KEY] | Long | Unique identifier of the resource request qualification associated to the request. |
| Keyword | String | Unstructured words or phrases that appear as keywords on a project resource request. |
| QualificationId | Long | Identifier of a structured content item such as a competency or language. The structured content items are defined in HCM Talent Profile. You may enter a value for only this attribute or for Qualification Name but not both. |
| QualificationName | String | Name of a structured content item such as a competency or language. The structured content items are defined in HCM Talent Profile. You may enter a value for only this attribute or for Qualification ID but not both. |
| QualificationType | String | Type of the structured content item to indicate whether the qualification is Competency or Language. |
| CompetencyProficiencyLevelId | Long | Identifier of the level of expertise or ability to perform a competency. You may enter a value for only this attribute or for Competency Proficiency Level but not both. Competency Proficiency level applies only if the Qualification Type value is Competency. |
| CompetencyProficiencyLevel | String | Level of expertise or ability to perform a competency. You may enter a value for only this attribute or for Competency Proficiency Level ID but not both. |
| ReadingLanguageProficiencyLevelId | Long | Identifier of the level of ability to read text in a specific language. You may enter a value for only this attribute or for Reading Language Proficiency Level Name but not both. Reading Language Proficiency level applies only if the Qualification Type value is Language. |
| ReadingLanguageProficiencyLevel | String | Level of ability to read text in a specific language. You may enter a value for only this attribute or for Reading Language Proficiency Level ID but not both. |
| WritingLanguageProficiencyLevelId | Long | Identifier of the level of ability to write text in a specific language. You may enter a value for only this attribute or for Write Language Proficiency Level Name but not both. Writing Language Proficiency level applies only if the Qualification Type value is Language. |
| WritingLanguageProficiencyLevel | String | Level of ability to write text in a specific language. You may enter a value for only this attribute or for Writing Language Proficiency Level ID but not both. |
| SpeakingLanguageProficiencyLevelId | Long | Identifier of the level of ability to speak a specific language. You may enter a value for only this attribute or for Speaking Language Proficiency Level Name but not both. Speaking Language Proficiency level applies only if the Qualification Type value is Language. |
| SpeakingLanguageProficiencyLevel | String | Level of ability to speak a specific language. You may enter a value for only this attribute or for Speaking Language Proficiency Level ID but not both. |
| SectionId | Long | Identifier of the qualification content section. You may enter a value for only this attribute or for Content Section Name but not both. |
| SectionName | String | Content section name for the qualification. |
| MandatoryFlag | Bool | Indicates whether the qualification is mandatory or optional. |
| Finder | String | finder |
| ResourceRequestId | Long | resourcerequestid |
The Project Resource Request Schedules resource is used to view schedule details of project resource requests with variable weekly hours
| Name | Type | Description |
| ProjectResourceRequestsResourceRequestId [KEY] | Long | Identifier of the project resource request. |
| Finder | String | finder |
| ResourceRequestId | Long | resourcerequestid |
The Project Roles LOV resource is used to view a Project Role. This object includes attributes which are used to store values of a project role.
| Name | Type | Description |
| ProjectRoleId [KEY] | Long | Unique identifier of the project role. |
| ProjectRoleName | String | Name of the project role. |
| Description | String | Description of the project role. |
| StartDateActive | Date | Start date of a project role. |
| EndDateActive | Date | End date of a project role. |
| RoleName | String | Name of the enterprise role. |
| RoleId | Long | Unique identifier of the enterprise role. |
| Finder | String | finder |
| ProjectRoleDate | Date | projectroledate |
| SearchTerm | String | searchterm |
The Project resource is used to view a project. A project is the effort and resources required to achieve a significant business objective within a specific, usually finite, time frame.
| Name | Type | Description |
| AllowCapitalizedInterestFlag | Bool | Indicates that the project is enabled for capitalization of interest amounts. If the value is true then it means that the project is enabled for capitalization of interest amounts and if the value is false then it means that the project isn't enabled for capitalization of interest amounts. |
| AllowCrossChargeFlag | Bool | An option at the project level to indicate if transaction charges are allowed from all provider business units to the project. Valid values are true and false. By default, the value is false. |
| AssetAllocationMethodCode | String | Code of the method by which unassigned asset lines and common costs are allocated across multiple assets. Valid values are AU (for Actual units), CC (for Current cost), EC (for Estimated cost), SC ( for Standard unit cost), SE (for Spread evenly), CE (for Client extension), and N (for None). |
| BillingFlag | Bool | Indicates the billable status of the project. |
| BurdenScheduleId | Long | Unique identifier of the burden schedule associated to the project. |
| BurdenScheduleFixedDate | Date | A specific date used to determine the right set of burden multipliers for the project. |
| BurdenScheduleName | String | Name of the burden schedule associated to the project. |
| BurdeningFlag | Bool | Indicates that burden costs will be calculated for the project. |
| BusinessUnitId | Long | Unique identifier of the business unit to which the project belongs. |
| BusinessUnitName | String | Name of the business unit to which the project belongs. |
| CapitalEventProcessingMethodCode | String | Code of the method for processing events on capital projects. Valid values are M (for Manual), P (for Periodic), and N (for None). |
| CapitalizableFlag | Bool | Indicates the capitalization status of the project. |
| CIntRateSchName | String | The rate schedule used to calculate the capitalized interest. |
| CIntStopDate | Date | The date when capitalized interest will stop accruing. |
| CIntRateSchId | Long | Unique identifier of the rate schedule used to calculate the capitalized interest. |
| CrossChargeLaborFlag | Bool | Indicator to show that the project will allow processing of cross-charge transactions between business units for labor transactions. Valid values are true and false. By default, the value is false. |
| CrossChargeNonLaborFlag | Bool | Indicator to show that the project will allow processing of cross-charge transactions between business units for non labor transactions. Valid values are true and false. By default, the value is false. |
| CurrencyConvRateType | String | Source of a currency conversion rate, such as user defined, spot, or corporate. In this case, the rate determines how to convert an amount from one currency to the project currency. |
| CurrencyConvDateTypeCode | String | Code of the date type that is used when converting amounts to the project currency. Valid values are A (for Accounting Date), P (for Project Accounting Date), T (for Transaction Date), and F (for Fixed Date). |
| CurrencyConvDate | Date | Date used to obtain currency conversion rates when converting an amount to the project currency. This date is used when the currency conversion date type is Fixed Date (F). |
| EnableBudgetaryControlFlag | Bool | An option at the project level to indicate if budgetary control are enabled. Valid values are true and false. |
| ExternalProjectId | String | Unique identifier of the project that is created in the third-party application. |
| HoursPerDay | Decimal | Number of hours that a resource works on the project in a day. |
| IncludeNotesInKPINotificationsFlag | Bool | Indicates that the notes about the KPI are included on the KPI notification report. Valid values are true and false. |
| IntegrationApplicationCode | String | The third-party application code in which the project is integrated. The valid values are ORA_EPM or blank. Attribute can't be set using the POST operation. |
| IntegrationProjectReference | String | Identifier of the integrated project in a third-party application. Attribute can't be set using the POST operation. |
| KPINotificationEnabledFlag | Bool | Indicates that the workflow notifications are sent to the project manager after KPI values are generated. Valid values are true and false. |
| LaborTpFixedDate | Date | A specific date used to determine a price on a transfer price schedule for labor transactions. |
| LaborTpSchedule | String | Name of the transfer price schedule that associates transfer price rules with pairs of provider and receiver organizations for labor transactions. |
| LaborTpScheduleId | Decimal | Unique identifier of the labor transfer price schedule. |
| LegalEntityId | Long | Identifier of the legal entity associated with the project. |
| LegalEntityName | String | Name of the legal entity associated with the project. A legal entity is a recognized party with given rights and responsibilities by legislation. Legal entities generally have the right to own property, the right to trade, the responsibility to repay debt, and the responsibility to account for themselves to company regulators, taxation authorities, and owners according to rules specified in the relevant legislation. |
| NlTransferPriceFixedDate | Date | A specific date used to determine a price on a transfer price schedule for non labor transactions. |
| NlTransferPriceSchedule | String | Name of the transfer price schedule that associates transfer price rules with pairs of provider and receiver organizations for labor transactions. |
| NlTransferPriceScheduleId | Decimal | Unique Identifier of the non labor transfer price schedule. |
| NumberAttr01 | Decimal | Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project. |
| NumberAttr02 | Decimal | Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project. |
| NumberAttr03 | Decimal | Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project. |
| NumberAttr04 | Decimal | Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project. |
| NumberAttr05 | Decimal | Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project. |
| NumberAttr06 | Decimal | Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project. |
| NumberAttr07 | Decimal | Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project. |
| NumberAttr08 | Decimal | Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project. |
| NumberAttr09 | Decimal | Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project. |
| NumberAttr10 | Decimal | Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project. |
| OwningOrganizationId | Long | Unique identifier of the organization that owns the project. |
| OwningOrganizationName | String | A organizing unit in the internal or external structure of the enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting for the project. |
| PlanningProjectFlag | Bool | Indicates that the project is used to plan and schedule tasks and resources on the tasks. Valid values are true and false. |
| ProjectCalendarId | Decimal | Unique identifier of the calendar associated to the project. |
| ProjectCalendarName | String | Name of the calendar associated to the project. |
| ProjectCode01 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode02 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode03 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode04 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode05 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode06 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode07 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode08 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode09 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode10 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode11 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode12 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode13 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode14 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode15 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode16 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode17 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode18 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode19 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode20 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode21 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode22 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode23 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode24 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode25 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode26 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode27 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode28 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode29 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode30 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode31 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode32 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode33 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode34 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode35 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode36 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode37 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode38 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode39 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCode40 | Long | Project code defined during implementation that provides a list of values to capture additional information for a project. |
| ProjectCurrencyCode | String | The currency code for the project. The currency code is a three-letter ISO code associated with a currency. |
| ProjectDescription | String | A description about the project. This might include high-level information about the work being performed. |
| ProjectEndDate | Date | The date that work or information tracking completes for a project. |
| ProjectId [KEY] | Long | Unique identifier of the project. |
| ProjectLedgerCurrencyCode | String | Code that identifies the ledger currency of the business unit that owns the project. |
| ProjectManagerEmail | String | Email of the person who leads the project team and who has the authority and responsibility for meeting the project objectives. |
| ProjectManagerName | String | Name of the person who leads the project team and who has authority and responsibility for meeting project objectives. |
| ProjectManagerResourceId | Long | Unique identifier of the person who leads the project team and who has the authority and responsibility for meeting the project objectives. This attribute has been deprecated. |
| ProjectName | String | Name of the project that is being created. |
| ProjectNumber | String | Number of the project that is being created. |
| ProjectPlanViewAccessCode | String | Access level code that specifies who can view the project plan in Oracle Fusion Task Management. Valid codes are ORA_PJT_PRJ_PLAN_VIEW_TEAM and ORA_PJT_PRJ_PLAN_VIEW_ALL. |
| ProjectPriorityCode | String | Unique identifier of the importance of a project based on a predefined scale. |
| ProjectStartDate | Date | The date that work or information tracking begins on a project. |
| ProjectStatus | String | An implementation-defined classification of the status of a project. Typical project statuses are Active and Closed. |
| ProjectStatusCode | String | The current status set on a project. A project status is an implementation-defined classification of the status of a project. Typical project status names are Active and Closed. |
| ProjectTypeId | Long | Unique identifier of the set of project options that determine the nature of the project. |
| ProjectTypeName | String | Name of the set of project options that determine the nature of the project. |
| ProjectUnitId | Long | Unique identifier of the project unit assigned to the project. |
| ProjectUnitName | String | Name of the project unit assigned to the project. |
| ScheduleTypeCode | String | The schedule type of the project. Valid values are FIXED_EFFORT and FIXED_DURATION. |
| ServiceType | String | A classification of the service or activity associated with a project. |
| ServiceTypeCode | String | Code identifier of the service type. |
| SourceApplicationCode | String | The code of the third-party application from which the project originates. A list of accepted values is defined in the lookup type Source Application. To review and update the list of values, use the Setup and Maintenance work area and the Manage Source Applications task. |
| SourceProjectReference | String | The identifier of the project in the external system where it was originally entered. |
| SourceTemplateId | Long | Unique identifier of the template that is used to create the project. |
| SourceTemplateName | String | Unique identifier of the template that is used to create the project. |
| SponsoredFlag | Bool | Indicates that the project is a sponsored project. |
| TextAttr01 | String | Project code defined during implementation that provides free-form text entry to capture additional information for a project. |
| TextAttr02 | String | Project code defined during implementation that provides free-form text entry to capture additional information for a project. |
| TextAttr03 | String | Project code defined during implementation that provides free-form text entry to capture additional information for a project. |
| TextAttr04 | String | Project code defined during implementation that provides free-form text entry to capture additional information for a project. |
| TextAttr05 | String | Project code defined during implementation that provides free-form text entry to capture additional information for a project. |
| TextAttr06 | String | Project code defined during implementation that provides free-form text entry to capture additional information for a project. |
| TextAttr07 | String | Project code defined during implementation that provides free-form text entry to capture additional information for a project. |
| TextAttr08 | String | Project code defined during implementation that provides free-form text entry to capture additional information for a project. |
| TextAttr09 | String | Project code defined during implementation that provides free-form text entry to capture additional information for a project. |
| TextAttr10 | String | Project code defined during implementation that provides free-form text entry to capture additional information for a project. |
| TextAttr11 | String | Project code defined during implementation that provides free-form text entry to capture additional information for a project. |
| TextAttr12 | String | Project code defined during implementation that provides free-form text entry to capture additional information for a project. |
| TextAttr13 | String | Project code defined during implementation that provides free-form text entry to capture additional information for a project. |
| TextAttr14 | String | Project code defined during implementation that provides free-form text entry to capture additional information for a project. |
| TextAttr15 | String | Project code defined during implementation that provides free-form text entry to capture additional information for a project. |
| TextAttr16 | String | Project code defined during implementation that provides free-form text entry to capture additional information for a project. |
| TextAttr17 | String | Project code defined during implementation that provides free-form text entry to capture additional information for a project. |
| TextAttr18 | String | Project code defined during implementation that provides free-form text entry to capture additional information for a project. |
| TextAttr19 | String | Project code defined during implementation that provides free-form text entry to capture additional information for a project. |
| TextAttr20 | String | Project code defined during implementation that provides free-form text entry to capture additional information for a project. |
| TransactionControlFlag | Bool | Type of transaction controls, inclusive or exclusive, defined for the selected project or task. true means inclusive, false means exclusive. |
| WorkplanTemplateId | Long | Unique identifier of the work plan template used for the project. |
| WorkplanTemplateName | String | Name of the work plan template used for the project. |
| WorkType | String | A classification of the work associated with a task. You can use work types to categorize and group projects for processing purposes. |
| WorkTypeId | Long | Unique identifier of the work type. |
| CreationDate | Datetime | The date when the record was created. |
| CreatedBy | String | The user who created the record. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| ActiveDate | Date | activedate |
| ClassCategory | String | classcategory |
| Finder | String | finder |
| FinishDate | Date | finishdate |
| PartyName | String | partyname |
| PersonId | Long | personid |
| PersonName | String | personname |
| ProjectRole | String | projectrole |
| SearchAttribute | String | searchattribute |
| StartDate | Date | startdate |
The Attachments resource is used to view attachments to a project.
| Name | Type | Description |
| ProjectsProjectId [KEY] | Long | Unique identifier of the project. |
| AttachedDocumentId [KEY] | Long | The unique identifier of the attached document. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| DatatypeCode | String | A value that indicates the data type. |
| FileName | String | The file name of the attachment. |
| DmFolderPath | String | The folder path from which the attachment is created. |
| DmDocumentId | String | The document ID from which the attachment is created. |
| DmVersionNumber | String | The document version number from which the attachment is created. |
| Url | String | The URL of a web page type attachment. |
| CategoryName | String | The category of the attachment. |
| UserName | String | The login credentials of the user who created the attachment. |
| Uri | String | The URI of a Topology Manager type attachment. |
| FileUrl | String | The URI of the file. |
| UploadedText | String | The text content for a new text attachment. |
| UploadedFileContentType | String | The content type of the attachment. |
| UploadedFileLength | Long | The size of the attachment file. |
| UploadedFileName | String | The name to assign to a new attachment file. |
| ContentRepositoryFileShared | Bool | Indicates whether the attachment is shared |
| Title | String | The title of the attachment. |
| Description | String | The description of the attachment. |
| ErrorStatusCode | String | The error code, if any, for the attachment. |
| ErrorStatusMessage | String | The error message, if any, for the attachment. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| FileContents | String | The contents of the attachment. |
| ExpirationDate | Datetime | The expiration date of the contents in the attachment. |
| LastUpdatedByUserName | String | The user name who last updated the record. |
| CreatedByUserName | String | The user name who created the record. |
| AsyncTrackerId | String | Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. |
| FileWebImage | String | The base64 encoded image of the file displayed in .png format if the source is a convertible image. |
| DownloadInfo | String | JSON object represented as a string containing information used to programmatically retrieve a file attachment. |
| PostProcessingAction | String | The name of the action that can be performed after an attachment is uploaded. |
| ActiveDate | Date | activedate |
| ClassCategory | String | classcategory |
| Finder | String | finder |
| FinishDate | Date | finishdate |
| OwningOrganizationName | String | owningorganizationname |
| PartyName | String | partyname |
| PersonId | Long | personid |
| PersonName | String | personname |
| ProjectId | Long | projectid |
| ProjectName | String | projectname |
| ProjectRole | String | projectrole |
| ProjectStatus | String | projectstatus |
| SearchAttribute | String | searchattribute |
| SourceApplicationCode | String | sourceapplicationcode |
| SourceProjectReference | String | sourceprojectreference |
| StartDate | Date | startdate |
The Projects LOV resource is used to view a list of values of projects. This object includes attributes which are used to store values of a project.
| Name | Type | Description |
| ProjectId [KEY] | Long | Unique identifier of the project. |
| ProjectNumber | String | Number of the project. |
| ProjectStartDate | Date | The date on which the work or information tracking begins on a project. |
| ProjectFinishDate | Date | The date on which the work or information tracking completes for a project. |
| ProjectName | String | Name of the project. |
| BusinessUnitId | Long | businessunitid |
| Finder | String | finder |
| PersonId | Long | personid |
The Project Classification resource is used to view a project classification. A project classification includes a class category and a class code, wherein the category is a broad subject within which you can classify projects, and the code is a specific value of the category.
| Name | Type | Description |
| ProjectsProjectId [KEY] | Long | Unique identifier of the project. |
| ProjectClassificationId [KEY] | Long | Unique identifier of the project classification. |
| ClassCategoryId | Long | Unique identifier of the project class category. |
| ClassCategory | String | Name of the project class category. |
| ClassCodeId | Long | Unique identifier of the project class code. |
| ClassCode | String | Name of the project class code. |
| CodePercentage | Decimal | Indicates the relative proportion of each class code when multiple class codes are associated with a single class category. The definition of the class category determines whether the sum of all class code percentages must equal 100. Valid values are numbers between 0 and 100. |
| ActiveDate | Date | activedate |
| Finder | String | finder |
| FinishDate | Date | finishdate |
| OwningOrganizationName | String | owningorganizationname |
| PartyName | String | partyname |
| PersonId | Long | personid |
| PersonName | String | personname |
| ProjectId | Long | projectid |
| ProjectName | String | projectname |
| ProjectRole | String | projectrole |
| ProjectStatus | String | projectstatus |
| SearchAttribute | String | searchattribute |
| SourceApplicationCode | String | sourceapplicationcode |
| SourceProjectReference | String | sourceprojectreference |
| StartDate | Date | startdate |
The Project Customers resource is used to view customers associated with those projects that are enabled for financial management. This applies only to those customers that are defined as parties as part of the project definition. This doesn't retrieve the customer information from a contract linked to the project.
| Name | Type | Description |
| ProjectsProjectId [KEY] | Long | Unique identifier of the project. |
| PartyId | Long | Unique identifier of the project customer party. |
| PartyNumber | String | Unique number of a person or group of persons who constitute the project customer. |
| PartyName | String | Name of a person or group of persons who constitute the project customer. |
| ProjectId | Long | Unique identifier of the project. |
| ProjectPartyId [KEY] | Long | Unique identifier of a party assignment to the project. |
| ActiveDate | Date | activedate |
| ClassCategory | String | classcategory |
| Finder | String | finder |
| FinishDate | Date | finishdate |
| OwningOrganizationName | String | owningorganizationname |
| PersonId | Long | personid |
| PersonName | String | personname |
| ProjectName | String | projectname |
| ProjectRole | String | projectrole |
| ProjectStatus | String | projectstatus |
| SearchAttribute | String | searchattribute |
| SourceApplicationCode | String | sourceapplicationcode |
| SourceProjectReference | String | sourceprojectreference |
| StartDate | Date | startdate |
A listing of all the descriptive flexfields available for projects.
| Name | Type | Description |
| ProjectsProjectId [KEY] | Long | Unique identifier of the project. |
| ProjectId [KEY] | Long | Unique identifier of the project. |
| MasterProject | String | MasterProject |
| Location | String | Location |
| _FLEX_Context | String | Context of the descriptive flexfield. |
| _FLEX_Context_DisplayValue | String | Context display value of the descriptive flexfield. |
| ActiveDate | Date | activedate |
| ClassCategory | String | classcategory |
| Finder | String | finder |
| FinishDate | Date | finishdate |
| OwningOrganizationName | String | owningorganizationname |
| PartyName | String | partyname |
| PersonId | Long | personid |
| PersonName | String | personname |
| ProjectName | String | projectname |
| ProjectRole | String | projectrole |
| ProjectStatus | String | projectstatus |
| SearchAttribute | String | searchattribute |
| SourceApplicationCode | String | sourceapplicationcode |
| SourceProjectReference | String | sourceprojectreference |
| StartDate | Date | startdate |
An object that includes attributes that are used to store values while creating or updating the opportunity details for a project. An opportunity is defined as a potential revenue-generating event.
| Name | Type | Description |
| ProjectsProjectId [KEY] | Long | Unique identifier of the project. |
| OpportunityAltNumber | String | Unique identifier of the opportunity that is created in third-party application. |
| OpportunityAmount | Decimal | Total amount of a customer deal in the opportunity management application. |
| OpportunityCurrencyCode | String | Currency code of the deal amount for the opportunity. |
| OpportunityCustomerId | Long | Unique identifier of the customer with whom the deal is made for the project. |
| OpportunityCustomerName | String | Name of the customer with whom the deal is made for the project. |
| OpportunityCustomerNumber | String | Customer number in the opportunity management application. |
| OpportunityDescription | String | Description of the opportunity that the project is associated with. |
| OpportunityName | String | Name of the opportunity that the project is associated with. |
| OpportunityNumber | String | The public unique identifier for an opportunity in the opportunity management application. |
| OpportunityStatus | String | Status of an opportunity in the opportunity management application. |
| OpportunityWinConfPercent | Decimal | Percentage probability of winning an opportunity in the opportunity management application. |
| OpportunityId [KEY] | Long | Identifier of the opportunity associated with the project |
| ProjectId | Long | Unique identifier of the project unit assigned to the project. |
| ActiveDate | Date | activedate |
| ClassCategory | String | classcategory |
| Finder | String | finder |
| FinishDate | Date | finishdate |
| OwningOrganizationName | String | owningorganizationname |
| PartyName | String | partyname |
| PersonId | Long | personid |
| PersonName | String | personname |
| ProjectName | String | projectname |
| ProjectRole | String | projectrole |
| ProjectStatus | String | projectstatus |
| SearchAttribute | String | searchattribute |
| SourceApplicationCode | String | sourceapplicationcode |
| SourceProjectReference | String | sourceprojectreference |
| StartDate | Date | startdate |
The endpoint that provides all project status changes and associated comments throughout the project's lifecycle.
| Name | Type | Description |
| ProjectsProjectId [KEY] | Long | Unique identifier of the project. |
| StatusChangeComments | String | The comments entered when the status of the object, such as milestone or project, is changed. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| NewStatusCode | String | The new status code of the object, such as milestone or project. |
| NewStatusClassificationCode | String | The new internal status classification code of the object, such as milestone or project. Status classifications are predefined groupings of statuses for each status object which typically govern delivered application behavior. Status classification attributes also control extensibility. |
| StatusHistoryId [KEY] | Long | Unique identifier of the status change record. |
| ObjectId | Long | The unique identifier of the object, such as Milestone ID or Project ID. |
| OldStatusCode | String | The old status code of the object, such as milestone or project. |
| OldStatusClassificationCode | String | The old internal status classification code of the object, such as milestone or project. Status classifications are predefined groupings of statuses for each status object which typically govern delivered application behavior. Status classification attributes also control extensibility. |
| StatusObject | String | Type of the object that's undergoing the status change. For example, project or milestone. |
| NewStatusClassification | String | The new internal status classification of the object, such as milestone or project. Status classifications are predefined groupings of statuses for each status object which typically govern delivered application behavior. Status classification attributes also control extensibility. |
| OldStatusClassification | String | The old internal status classification of the object, such as milestone or project. Status classifications are predefined groupings of statuses for each status object which typically govern delivered application behavior. Status classification attributes also control extensibility. |
| NewStatus | String | The new status of the object, such as milestone or project. |
| OldStatus | String | The old status of the object, such as milestone or project. |
| ActiveDate | Date | activedate |
| ClassCategory | String | classcategory |
| Finder | String | finder |
| FinishDate | Date | finishdate |
| OwningOrganizationName | String | owningorganizationname |
| PartyName | String | partyname |
| PersonId | Long | personid |
| PersonName | String | personname |
| ProjectId | Long | projectid |
| ProjectName | String | projectname |
| ProjectRole | String | projectrole |
| ProjectStatus | String | projectstatus |
| SearchAttribute | String | searchattribute |
| SourceApplicationCode | String | sourceapplicationcode |
| SourceProjectReference | String | sourceprojectreference |
| StartDate | Date | startdate |
An object that includes attributes that are used to store values while creating or updating team members on a project. A project team member is a person who is assigned a role on a project.
| Name | Type | Description |
| ProjectsProjectId [KEY] | Long | Unique identifier of the project. |
| FinishDate | Date | Date on which the assignment of the project team member to the project is scheduled to end. |
| PersonEmail | String | Email of the person assigned as a team member to the project. |
| PersonName | String | Name of the person assigned as a team member to the project. |
| ProjectId | Long | Unique identifier of the project. |
| ProjectRole | String | A classification of the relationship that an employee has to a project. You use project roles to define an employee's level of access to project information. Examples are Project Manager, Project Accountant and Technical Lead. |
| StartDate | Date | Date from which the assignment of the team member to the project is scheduled to begin. |
| TeamMemberId [KEY] | Long | Unique identifier of the team member assigned to the project. |
| PersonId | Long | Unique identifier of the person assigned as a team member to the project. |
| TrackTimeFlag | Bool | Indicates whether time cards are expected from internal team members. Valid values are true and false. The default value is false. Information about missing time cards is displayed on the project manager dashboard. |
| ResourcePlanningCostRate | Decimal | Cost Rate of the resource assignment for the planning purpose. If no value is specified, Cost Rate of the resource defined in Project Enterprise Resource is used if it is available in the project currency. |
| ResourceAllocationPercentage | Decimal | Percentage of time for which a resource is assigned to the project. The default value is 100. |
| ResourceAssignmentEffortInHours | Decimal | Number of hours for which a resource is assigned to the project. |
| ResourcePlanningBillRate | Decimal | Bill Rate of the resource assignment for the planning purpose. If no value is specified, Bill Rate of the resource defined in Project Enterprise Resource is used if it is available in the project currency. |
| AssignmentType | String | Indicates if a request is for a billable or a nonbillable assignment. Examples are BILLABLE, NON-BILLABLE, or leave blank. |
| BillablePercentReason | String | Indicates the reason that the billable percentage of the project resource assignment is less than 100%. For a non-billable assignment, the value is ignored. |
| AssignmentTypeCode | String | Indicates if a request is for a billable or a nonbillable assignment. Examples are BILLABLE, NON-BILLABLE, or leave blank. |
| BillablePercentReasonCode | String | Indicates if a request is for a billable or a nonbillable assignment. Examples are BILLABLE, NON-BILLABLE, or leave blank. |
| BillablePercent | String | Indicates if a request is for a billable or a nonbillable assignment. Examples are BILLABLE, NON-BILLABLE, or leave blank. |
| ActiveDate | Date | activedate |
| ClassCategory | String | classcategory |
| Finder | String | finder |
| OwningOrganizationName | String | owningorganizationname |
| PartyName | String | partyname |
| ProjectName | String | projectname |
| ProjectStatus | String | projectstatus |
| SearchAttribute | String | searchattribute |
| SourceApplicationCode | String | sourceapplicationcode |
| SourceProjectReference | String | sourceprojectreference |
The Project Transaction Control resource is used to view, create, update, and delete a project transaction control. Project transaction controls are a set of criteria that control whether a transaction can be charged to a project.
| Name | Type | Description |
| ProjectsProjectId [KEY] | Long | Unique identifier of the project. |
| TransactionControlId [KEY] | Long | Identifier of the transaction control. |
| RuleNumber | Long | Identifier of the transaction control within a project or task. Default value is the successor of the maximum existing rule number. |
| ProjectId | Long | Identifier of the project. Default value is the identifier of the project for which the transaction control is created. |
| StartDateActive | Date | The date from which the transaction control is effective. Default value is the project start date. |
| EndDateActive | Date | The date after which the transaction control is no longer effective. |
| BillableHint | String | Indicates that transactions charged to the project can be billed to customers. This attribute is applicable for billable projects. A list of accepted values - No and Task - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Billable Code or both of them. Default value is Task. |
| Billable | String | Indicates that transactions charged to the project can be billed to customers. This attribute is applicable for billable projects. A list of accepted values - N and T - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Billable or both of them. Default value is T. |
| ChargeableHint | String | Indicates that something is eligible to be charged to the project. A list of accepted values - Yes and No - is defined in the lookup type PJC_YES_NO. You can enter either this attribute or Chargeable Code or both of them. Default value is No. |
| Chargeable | String | Indicates that something is eligible to be charged to the project. A list of accepted values - Y and N - is defined in the lookup type PJC_YES_NO. You can enter either this attribute or Chargeable or both of them. Default value is N. |
| CapitalizableHint | String | Indicates the capitalizable status of the transaction. This attribute is applicable for capital projects. A list of accepted values - No and Task - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Capitalizable Code or both of them. Default value is Task. |
| Capitalizable | String | Indicates the code for the capitalizable status of the transaction. This attribute is applicable for capital projects. A list of accepted values - N and T - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Capitalizable or both of them. Default value is T. |
| ExpenditureCategoryId | Long | Identifier of the expenditure category. You can enter either this attribute or Expenditure Category or both of them. |
| ExpenditureCategoryName | String | A grouping of expenditure types by type of cost. For example, an expenditure category with a name such as Labor refers to the cost of labor. You can enter either this attribute or Expenditure Category ID or both of them. |
| ExpenditureTypeId | Long | Identifier of the expenditure type. You can enter either this attribute or Expenditure Type or both of them. |
| ExpenditureTypeName | String | A classification of cost that is assigned to each project cost transaction. Expenditure types are grouped into cost groups (expenditure categories) and revenue groups (revenue categories). You can enter either this attribute or Expenditure Type ID or both of them. |
| NonLaborResourceId | Long | Identifier of the nonlabor resource. You can enter either this attribute or Nonlabor Resource or both of them. |
| NonLaborResourceName | String | An implementation defined asset or pool of assets. These assets may represent actual pieces of equipment whose time is consumed, or an asset whose output is consumed. For example, you can define a nonlabor resource with a name of Training Room to track the usage of a physical room and the associated costs. The actual usage of the room is tracked in hours. You can enter either this attribute or Nonlabor Resource ID or both of them. |
| PersonName | String | The name of an individual human team member. You can enter either this attribute, Person ID, Person Number, or Email or a combination of these attributes. |
| PersonId | Long | Identifier of the person. You can enter either this attribute, Person Name, Person Number, or Email, or a combination of these attributes. |
| PersonNumber | String | Number that uniquely identifies a person. This number refers to the Fusion HCM specific identifier that uniquely identifies a person in the application, regardless of their relationship to the enterprise. It does not have any relation to any national identifier component. You can enter either this attribute, Person ID, Person Name, or Email, or a combination of these attributes. |
| EmailAddress | String | Email address of the person. You can enter either this attribute, Person ID, Person Number, or Person Name, or a combination of these attributes. |
| JobId | Long | Identifier of the job. You can enter either this attribute or Job or both of them. You must enter at least one from among the Person Name, Person ID, Person Number, and Email attributes if you enter a value for this attribute. |
| Job | String | The job that is being performed by the person that incurred the cost that was charged to the task. You can enter either this attribute or Job ID or both of them. You must enter at least one from among the Person Name, Person ID, Person Number, and Email attributes if you enter a value for this attribute. |
| PersonTypeHint | String | The type used to classify the person in human resources. For example, the person type can be either employee or contingent worker. A list of accepted values - Employee and Contingent Worker - is defined in the lookup type PJF_PERSON_TYPE You can enter either this attribute or Person Type Code or both of them. |
| PersonType | String | Indicates the code of the type used to classify the person in human resources. For example, the person type can be either employee or contingent worker. A list of accepted values - EMP and CWK - is defined in the lookup type PJF_PERSON_TYPE You can enter either this attribute or Person Type or both of them. |
| OrganizationId | Long | Identifier of the organization to which the person job belongs. You can enter either this attribute or Organization or both of them. You must enter the person and job attributes if you enter a value for this attribute. |
| Organization | String | The name of the organization to which the person job belongs. You can enter either this attribute or Organization ID or both of them. You must enter the person and job attributes if you enter a value for this attribute. |
| ActiveDate | Date | activedate |
| ClassCategory | String | classcategory |
| Finder | String | finder |
| FinishDate | Date | finishdate |
| OwningOrganizationName | String | owningorganizationname |
| PartyName | String | partyname |
| ProjectName | String | projectname |
| ProjectRole | String | projectrole |
| ProjectStatus | String | projectstatus |
| SearchAttribute | String | searchattribute |
| SourceApplicationCode | String | sourceapplicationcode |
| SourceProjectReference | String | sourceprojectreference |
| StartDate | Date | startdate |
This Project resource is used to view provider business units, regardless of whether they're from Project Portfolio Management or imported from third-party applications. The Provider Business Unit resource is a child of the Project resource.
| Name | Type | Description |
| ProjectsProjectId [KEY] | Long | Unique identifier of the project. |
| BusinessUnitId [KEY] | Long | Identifier of the business unit associated with the project to which the provider business unit has been assigned. |
| BusinessUnitName | String | Name of the provider business unit associated with this project. |
| CreatedBy | String | Name of the user who associated the provider business unit with this project. |
| CreationDate | Datetime | Date when the provider business unit was associated with this project. |
| LastUpdatedDate | Datetime | The date on which provider business unit information was last updated for this project. |
| LastUpdatedBy | String | Name of the user who last updated the provider business unit information associated with this project. |
| ActiveDate | Date | activedate |
| ClassCategory | String | classcategory |
| Finder | String | finder |
| FinishDate | Date | finishdate |
| OwningOrganizationName | String | owningorganizationname |
| PartyName | String | partyname |
| PersonId | Long | personid |
| PersonName | String | personname |
| ProjectId | Long | projectid |
| ProjectName | String | projectname |
| ProjectRole | String | projectrole |
| ProjectStatus | String | projectstatus |
| SearchAttribute | String | searchattribute |
| SourceApplicationCode | String | sourceapplicationcode |
| SourceProjectReference | String | sourceprojectreference |
| StartDate | Date | startdate |
The Task Dependencies resource is used to store values while creating or updating the schedule dependencies between tasks. For example, a task that has a finish-to-start dependency on another task can start only after the other task is completed.
| Name | Type | Description |
| ProjectsProjectId [KEY] | Long | Unique identifier of the project. |
| DependencyId [KEY] | Long | Identifier of the dependency that exists between tasks. |
| ProjectId | Long | Identifier of the project with which the element is associated. |
| PredecessorTaskName | String | Name of the predecessor task. |
| ExternalPredecessorTaskId | String | Unique identifier of the predecessor project task that is created in the third-party application. |
| PredecessorTaskNumber | String | Number of the task which is a predecessor to another task. |
| PredecessorTaskId | Long | Unique identifier of the predecessor project element. |
| TaskName | String | Name of the task. |
| ExternalTaskId | String | Identifier of the project task that is created in the third-party application. |
| TaskNumber | String | The number of a task. |
| TaskId | Long | The unique identifier of the project element. |
| Lag | Decimal | Number of days that exist between tasks before the dependency is activated. |
| DependencyType | String | The type of dependency that exists between tasks. |
| ActiveDate | Date | activedate |
| ClassCategory | String | classcategory |
| Finder | String | finder |
| FinishDate | Date | finishdate |
| OwningOrganizationName | String | owningorganizationname |
| PartyName | String | partyname |
| PersonId | Long | personid |
| PersonName | String | personname |
| ProjectName | String | projectname |
| ProjectRole | String | projectrole |
| ProjectStatus | String | projectstatus |
| SearchAttribute | String | searchattribute |
| SourceApplicationCode | String | sourceapplicationcode |
| SourceProjectReference | String | sourceprojectreference |
| StartDate | Date | startdate |
The Task resource includes the attributes that are used to store values while creating or updating project tasks. Tasks are units of project work assigned or performed as part of the duties of a resource. Tasks can be a portion of project work to be performed within a defined period by a specific resource or multiple resources.
| Name | Type | Description |
| ProjectsProjectId [KEY] | Long | Unique identifier of the project. |
| ActualQuantity | Decimal | Actual effort spent on the project task. |
| AllowCrossChargeTransactionsFlag | Bool | Indicates if the task can accept charges from other business units. |
| BaselineAllocation | Decimal | Original planned allocation of the task in the primary work plan baseline. |
| BaselineDuration | Decimal | Original planned duration of the task in the primary work plan baseline. |
| BaselineFinishDate | Date | Original planned finish date of the task in the primary work plan baseline. |
| BaselineStartDate | Date | Original planned start date of the task in the primary work plan baseline. |
| BaselineQuantity | Decimal | Original planned effort of the task in the primary work plan baseline. |
| BillableFlag | Bool | Indicates transactions charged to that task can be billed to customers. |
| BurdenSchedule | String | Name of the burden schedule associated with the task. A burden schedule is a set of burden multipliers that is maintained for use across projects. Also referred to as a standard burden schedule. |
| ChargeableFlag | Bool | Chargeable task checkbox indicator |
| CapitalizableFlag | Bool | Specifies if the project task is capitalizable. A value of true means that the task is capitalizable and a value of false means that the task is not capitalizable. The default value is false for a summary task belonging to a noncapital project. The default value is true for a summary task belonging to a capital project. For a subtask belonging to a capital project, the default value is the corresponding value of the parent task. |
| ConstraintDate | Date | The date when a task must start or complete based on the constraint type for the task. |
| ConstraintType | String | The type of scheduling constraint applied on the task. |
| CriticalFlag | Bool | A task that must be completed on schedule or it will impact the finish date of the entire project. |
| CrossChargeLaborFlag | Bool | Indicates that the task will allow processing of cross-charge transactions between business units for labor costs. |
| CrossChargeNonLaborFlag | Bool | Indicates that the task will allow processing of cross-charge transactions between business units for nonlabor costs. |
| ReceiveIntercompanyAndInterprojectInvoicesFlag | Bool | Indicates if the task can receive invoices from other projects and organizations. A value of true means that the task can be included on intercompany and interproject invoices and a value of false means that the task cannot be included on intercompany and interproject invoices. The default value is false. |
| ServiceType | String | Specifies an activity assigned to the project task for tracking purposes. You can enter a value either for this attribute or Service Type Code but not both while creating or updating a project task. A list of valid values is defined in the lookup type PJF_SERVICE_TYPE. The default value is derived from the project to which the task belongs. |
| ServiceTypeCode | String | Code that specifies an activity assigned to the project task for tracking purposes. You can enter a value either for this attribute or Service Type but not both while creating or updating a project task. A list of valid values is defined in the lookup type PJF_SERVICE_TYPE. The default value is derived from the project to which the task belongs. |
| WorkType | String | Name of the classification of the work associated with the project task. Use work types to categorize and group tasks for processing purposes. You can enter a value for either this attribute or Work Type ID but not both while creating a project task. The work type must be active within the planned task dates. The default value is derived from the project type or the project to which the task belongs. |
| WorkTypeId | Long | Name of the classification of the work associated with the project task. Use work types to categorize and group tasks for processing purposes. You can enter a value for either this attribute or Work Type ID but not both while creating a project task. The work type must be active within the planned task dates. The default value is derived from the project type or the project to which the task belongs. |
| CurrentFinishDate | Date | The date when the task is estimated to end. |
| CurrentStartDate | Date | The date when the task is estimated to start. |
| CurrentQuantity | Decimal | Total estimated effort on the task at completion. |
| ElementType | String | Title for the exposed attribute for element type task attributes in OTBI. |
| ExecutionDisplaySequence | Long | The order in which the task is displayed in the project. |
| ExternalParentTaskId | String | Unique identifier of the parent project task that is created in the third-party application. |
| ExternalTaskId | String | Unique identifier of the project task that is created in the third-party application. |
| LowestLevelTask | String | Indicates the task is at the lowest level. |
| ManualSchedule | String | The schedule mode where you need to schedule the task manually and can't update it automatically using the scheduling process. |
| MilestoneFlag | Bool | Indicates the project milestone during which the task must be completed. |
| ParentTaskId | Long | Identifier of the parent task of the task. |
| ProgressStatusCode | String | The status of work completed on the task or milestone. Valid values for the status of a task or nonbillable milestone are NOT_STARTED, IN_PROGRESS, COMPLETED. Valid values for the status of a billable milestone are NOT_STARTED, IN_PROGRESS, REJECTED, SUBMITTED, COMPLETED. |
| RemainingQuantity | Decimal | Effort remaining on the project task. |
| RequirementCode | String | The unique code corresponding to a requirement. |
| RequirementName | String | The name of the requirement. |
| Sprint | String | The sprint in which the task was completed or is estimated to be completed. You can configure the valid values during application set up. |
| TaskActualFinishDate | Date | The actual finish date for the task as opposed to a planned finish date for the task. |
| TaskActualStartDate | Date | The date that work commenced on a task as opposed to the planned start date for the task. |
| TaskCode01Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode02Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode03Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode04Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode05Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode06Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode07Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode08Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode09Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode10Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode11Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode12Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode13Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode14Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode15Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode16Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode17Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode18Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode19Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode20Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode21Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode22Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode23Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode24Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode25Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode26Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode27Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode28Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode29Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode30Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode31Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode32Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode33Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode34Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode35Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode36Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode37Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode38Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode39Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskCode40Id | Long | Task code defined during implementation that provides a list of values to capture additional information for a project task. |
| TaskDescription | String | Text description of the project task that is being created. |
| TaskDuration | Decimal | Length of time within which the project task is scheduled to be completed. |
| TaskFinishDate | Date | Scheduled end date of the project task. |
| TaskId | Long | Unique identifier of the project task. |
| SourceApplication | String | The external application from which the task is imported. |
| SourceReference | String | Identifier of the task in the external system where it was originally entered. |
| TaskLevel | Int | Indicates level of the task in the WBS. |
| TaskManagerEmail | String | Email of the person who is assigned as task manager to the task. |
| TaskManagerName | String | The resource who manages the task. |
| TaskManagerPersonId | Long | Unique identifier of the person who leads the project task and who has the authority and responsibility for meeting the task objectives. |
| TaskName | String | The name of the task. A task is subdivision of project work. Each project can have a set of top tasks and a hierarchy of subtasks below each top task. |
| TaskNumber | String | The number of a task. |
| TaskNumberAttr01 | Decimal | Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task. |
| TaskNumberAttr02 | Decimal | Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task. |
| TaskNumberAttr03 | Decimal | Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task. |
| TaskNumberAttr04 | Decimal | Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task. |
| TaskNumberAttr05 | Decimal | Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task. |
| TaskNumberAttr06 | Decimal | Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task. |
| TaskNumberAttr07 | Decimal | Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task. |
| TaskNumberAttr08 | Decimal | Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task. |
| TaskNumberAttr09 | Decimal | Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task. |
| TaskNumberAttr10 | Decimal | Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task. |
| TaskOrganizationId | Long | Unique identifier of the task organization. |
| TaskOrganizationName | String | The name of the task organization. |
| TaskPercentComplete | Decimal | Percentage of work completed for an object or task. |
| TaskPhysicalPercentComplete | Decimal | The amount of physical work achieved on a task. |
| TaskPriority | Decimal | Indicates the importance of a project task based on a predefined scale. |
| TaskQuantity | Decimal | Measure of the effort required to complete the project task. |
| TaskResourceAllocationPercent | Decimal | Percentage of hours that a resource is allocated to the project task for a specified duration |
| TaskSequence | Long | Position of the project task in a hierarchical arrangement. |
| TaskStartDate | Date | Scheduled start date of the project task. |
| TaskTextAttr01 | String | Task code defined during implementation that provides free-form text entry to capture additional information for a project task. |
| TaskTextAttr02 | String | Task code defined during implementation that provides free-form text entry to capture additional information for a project task. |
| TaskTextAttr03 | String | Task code defined during implementation that provides free-form text entry to capture additional information for a project task. |
| TaskTextAttr04 | String | Task code defined during implementation that provides free-form text entry to capture additional information for a project task. |
| TaskTextAttr05 | String | Task code defined during implementation that provides free-form text entry to capture additional information for a project task. |
| TaskTextAttr06 | String | Task code defined during implementation that provides free-form text entry to capture additional information for a project task. |
| TaskTextAttr07 | String | Task code defined during implementation that provides free-form text entry to capture additional information for a project task. |
| TaskTextAttr08 | String | Task code defined during implementation that provides free-form text entry to capture additional information for a project task. |
| TaskTextAttr09 | String | Task code defined during implementation that provides free-form text entry to capture additional information for a project task. |
| TaskTextAttr10 | String | Task code defined during implementation that provides free-form text entry to capture additional information for a project task. |
| TaskTextAttr11 | String | Task code defined during implementation that provides free-form text entry to capture additional information for a project task. |
| TaskTextAttr12 | String | Task code defined during implementation that provides free-form text entry to capture additional information for a project task. |
| TaskTextAttr13 | String | Task code defined during implementation that provides free-form text entry to capture additional information for a project task. |
| TaskTextAttr14 | String | Task code defined during implementation that provides free-form text entry to capture additional information for a project task. |
| TaskTextAttr15 | String | Task code defined during implementation that provides free-form text entry to capture additional information for a project task. |
| TaskTextAttr16 | String | Task code defined during implementation that provides free-form text entry to capture additional information for a project task. |
| TaskTextAttr17 | String | Task code defined during implementation that provides free-form text entry to capture additional information for a project task. |
| TaskTextAttr18 | String | Task code defined during implementation that provides free-form text entry to capture additional information for a project task. |
| TaskTextAttr19 | String | Task code defined during implementation that provides free-form text entry to capture additional information for a project task. |
| TaskTextAttr20 | String | Task code defined during implementation that provides free-form text entry to capture additional information for a project task. |
| TransactionCompletionDate | Date | Transaction finish date of a task. |
| TransactionStartDate | Date | Transaction start date of a task. |
| TopTaskId | Long | Identifier of the top task to which the task rolls up. If the task is a top task, the identifier of the top task is same as the identifier of the task. |
| TransactionControlFlag | Bool | Type of transaction controls, inclusive or exclusive, defined for the selected task. A value of true means inclusive and a value of false means exclusive. |
| ActiveDate | Date | activedate |
| ClassCategory | String | classcategory |
| Finder | String | finder |
| FinishDate | Date | finishdate |
| OwningOrganizationName | String | owningorganizationname |
| PartyName | String | partyname |
| PersonId | Long | personid |
| PersonName | String | personname |
| ProjectId | Long | projectid |
| ProjectName | String | projectname |
| ProjectRole | String | projectrole |
| ProjectStatus | String | projectstatus |
| SearchAttribute | String | searchattribute |
| SourceApplicationCode | String | sourceapplicationcode |
| SourceProjectReference | String | sourceprojectreference |
| StartDate | Date | startdate |
An object that includes the attributes that are used to store values while creating or updating expense resource assignments for a project task. For example, hotel expenses can be planned on a project task.
| Name | Type | Description |
| ProjectsProjectId [KEY] | Long | Unique identifier of the project. |
| ExpenseResourceActualAmount | Decimal | Column to indicate the actual expense cost amount of a specific expense resource assigned to the task. |
| ExpenseResourceAssignmentId [KEY] | Long | Unique identifier of the expense resource assignment to the project task. |
| ExpenseResourceId | Long | Identifier of the expense resource assigned to the project. |
| ExpenseResourcePlannedAmount | Decimal | Column to indicate the planned expense cost amount of a specific expense resource assigned to the task. |
| ExpenseResourceRemainingAmount | Decimal | Column to indicate the sum of remaining expense cost amounts of a specific expense resource assigned to the task. |
| ProjElementId | Long | Identifier of the task to which the expense resource is assigned. |
| ExpenseResourceName | String | Name of the expense resource assigned to the project task. |
| ActiveDate | Date | activedate |
| ClassCategory | String | classcategory |
| Finder | String | finder |
| FinishDate | Date | finishdate |
| OwningOrganizationName | String | owningorganizationname |
| PartyName | String | partyname |
| PersonId | Long | personid |
| PersonName | String | personname |
| ProjectId | Long | projectid |
| ProjectName | String | projectname |
| ProjectRole | String | projectrole |
| ProjectStatus | String | projectstatus |
| SearchAttribute | String | searchattribute |
| SourceApplicationCode | String | sourceapplicationcode |
| SourceProjectReference | String | sourceprojectreference |
| StartDate | Date | startdate |
An object that includes the attributes that are used to store values while creating or updating labor resource assignments for a project task. For example, a DBA can be assigned as labor resource for a project task.
| Name | Type | Description |
| ProjectsProjectId [KEY] | Long | Unique identifier of the project. |
| LaborBilledAmount | Decimal | Column to indicate the labor bill amount of the task. |
| LaborCostAmount | Decimal | Column to indicate the labor cost of the task |
| LaborPrimaryResource | String | Unique identifier of the primary labor resource for the project task. |
| LaborResourceAssignmentId [KEY] | Long | Unique identifier of the labor resource assignment to the project task. |
| LaborResourceId | Long | Unique identifier of the labor resource assigned to the project task. |
| ProjElementId | Long | Identifier of the task to which the labor resource is assigned. |
| ResourceAllocationPercent | Decimal | Allocation percentage of the labor resource assigned to the task. |
| LaborResourceName | String | Name of labor resource assigned to the project task. |
| LaborResourceEmail | String | E-mail address of the labor resource assigned to the task. Required if the resource type is Labor. |
| ProjectResourceAssignId | Long | Unique identifier of the assignment of the labor resource in a project. |
| ActiveDate | Date | activedate |
| ClassCategory | String | classcategory |
| Finder | String | finder |
| FinishDate | Date | finishdate |
| OwningOrganizationName | String | owningorganizationname |
| PartyName | String | partyname |
| PersonId | Long | personid |
| PersonName | String | personname |
| ProjectId | Long | projectid |
| ProjectName | String | projectname |
| ProjectRole | String | projectrole |
| ProjectStatus | String | projectstatus |
| SearchAttribute | String | searchattribute |
| SourceApplicationCode | String | sourceapplicationcode |
| SourceProjectReference | String | sourceprojectreference |
| StartDate | Date | startdate |
The Tasks Descriptive Flexfields resource is used to view, create, and update additional information for project tasks.
| Name | Type | Description |
| ProjectsProjectId [KEY] | Long | ProjectsProjectId |
| ProjElementId [KEY] | Long | The identifier of the project task. |
| ObjectType | String | Internal attribute that indicates the basis of the project task. |
| ElementType | String | Internal attribute that indicates the nature of the project task, whether financial, execution, or both. |
| _FLEX_Context | String | Code that identifies the context for the segments of the project tasks. |
| _FLEX_Context_DisplayValue | String | Name of the context for the segments of the project tasks. |
| ActiveDate | Date | activedate |
| ClassCategory | String | classcategory |
| Finder | String | finder |
| FinishDate | Date | finishdate |
| OwningOrganizationName | String | owningorganizationname |
| PartyName | String | partyname |
| PersonId | Long | personid |
| PersonName | String | personname |
| ProjectId | Long | projectid |
| ProjectName | String | projectname |
| ProjectRole | String | projectrole |
| ProjectStatus | String | projectstatus |
| SearchAttribute | String | searchattribute |
| SourceApplicationCode | String | sourceapplicationcode |
| SourceProjectReference | String | sourceprojectreference |
| StartDate | Date | startdate |
The Task Transaction Control resource is used to view a task transaction control. Task transaction controls are a set of criteria that control whether a transaction can be charged to a task.
| Name | Type | Description |
| ProjectsProjectId [KEY] | Long | Unique identifier of the project. |
| TransactionControlId [KEY] | Long | Identifier of the transaction control. |
| RuleNumber | Long | Identifier of the transaction control within a project or task. Default value is the successor of the maximum existing rule number. |
| ProjectId | Long | Identifier of the project. Default value is the identifier of the project for which the transaction control is created. |
| TaskId | Long | Identifier of the project task. Default value is the identifier of the project task for which the transaction control is created. |
| StartDateActive | Date | The date from which the transaction control is effective. Default value is the system date. |
| EndDateActive | Date | The date after which the transaction control is no longer effective. |
| BillableHint | String | Indicates that transactions charged to the task can be billed to customers. This attribute is applicable for billable tasks. A list of accepted values - No and Task - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Billable Code or both of them. Default value is Task. |
| Billable | String | Indicates that transactions charged to the task can be billed to customers. This attribute is applicable for billable tasks. A list of accepted values - N and T - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Billable or both of them. Default value is T. |
| ChargeableHint | String | Indicates that something is eligible to be charged to the task. A list of accepted values - Yes and No - is defined in the lookup type PJC_YES_NO. You can enter either this attribute or Chargeable Code or both of them. Default value is No. |
| Chargeable | String | Indicates that something is eligible to be charged to the task. A list of accepted values - Y and N - is defined in the lookup type PJC_YES_NO. You can enter either this attribute or Chargeable or both of them. Default value is N. |
| CapitalizableHint | String | Indicates the capitalizable status of the transaction. This attribute is applicable for capital projects. A list of accepted values - No and Task - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Capitalizable Code or both of them. Default value is Task. |
| Capitalizable | String | Indicates the code for the capitalizable status of the transaction. This attribute is applicable for capital projects. A list of accepted values - N and T - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Capitalizable or both of them. Default value is T. |
| ExpenditureCategoryId | Long | Identifier of the expenditure category. You can enter either this attribute or Expenditure Category or both of them. |
| ExpenditureCategoryName | String | A grouping of expenditure types by type of cost. For example, an expenditure category with a name such as Labor refers to the cost of labor. You can enter either this attribute or Expenditure Category ID or both of them. |
| ExpenditureTypeId | Long | Identifier of the expenditure type. You can enter either this attribute or Expenditure Type or both of them. |
| ExpenditureTypeName | String | A classification of cost that is assigned to each project cost transaction. Expenditure types are grouped into cost groups (expenditure categories) and revenue groups (revenue categories). You can enter either this attribute or Expenditure Type ID or both of them. |
| NonLaborResourceId | Long | Identifier of the nonlabor resource. You can enter either this attribute or Nonlabor Resource or both of them. |
| NonLaborResourceName | String | An implementation defined asset or pool of assets. These assets may represent actual pieces of equipment whose time is consumed, or an asset whose output is consumed. For example, you can define a nonlabor resource with a name of Training Room to track the usage of a physical room and the associated costs. The actual usage of the room is tracked in hours. You can enter either this attribute or Nonlabor Resource ID or both of them. |
| PersonName | String | The name of an individual human team member. You can enter either this attribute, Person ID, Person Number, or Email or a combination of these attributes. |
| PersonId | Long | Identifier of the person. You can enter either this attribute, Person Name, Person Number, or Email, or a combination of these attributes. |
| PersonNumber | String | Number that uniquely identifies a person. This number refers to the Fusion HCM specific identifier that uniquely identifies a person in the application, regardless of their relationship to the enterprise. It does not have any relation to any national identifier component. You can enter either this attribute, Person ID, Person Name, or Email, or a combination of these attributes. |
| EmailAddress | String | Email address of the person. You can enter either this attribute, Person ID, Person Number, or Person Name, or a combination of these attributes. |
| JobId | Long | Identifier of the job. You can enter either this attribute or Job or both of them. You must enter at least one from among the Person Name, Person ID, Person Number, and Email attributes if you enter a value for this attribute. |
| Job | String | The job that is being performed by the person that incurred the cost that was charged to the task. You can enter either this attribute or Job ID or both of them. You must enter at least one from among the Person Name, Person ID, Person Number, and Email attributes if you enter a value for this attribute. |
| PersonTypeHint | String | The type used to classify the person in human resources. For example, the person type can be either employee or contingent worker. A list of accepted values - Employee and Contingent Worker - is defined in the lookup type PJF_PERSON_TYPE You can enter either this attribute or Person Type Code or both of them. |
| PersonType | String | Indicates the code of the type used to classify the person in human resources. For example, the person type can be either employee or contingent worker. A list of accepted values - EMP and CWK - is defined in the lookup type PJF_PERSON_TYPE You can enter either this attribute or Person Type or both of them. |
| OrganizationId | Long | Identifier of the organization to which the person job belongs. You can enter either this attribute or Organization or both of them. You must enter the person and job attributes if you enter a value for this attribute. |
| Organization | String | The name of the organization to which the person job belongs. You can enter either this attribute or Organization ID or both of them. You must enter the person and job attributes if you enter a value for this attribute. |
| ActiveDate | Date | activedate |
| ClassCategory | String | classcategory |
| Finder | String | finder |
| FinishDate | Date | finishdate |
| OwningOrganizationName | String | owningorganizationname |
| PartyName | String | partyname |
| ProjectName | String | projectname |
| ProjectRole | String | projectrole |
| ProjectStatus | String | projectstatus |
| SearchAttribute | String | searchattribute |
| SourceApplicationCode | String | sourceapplicationcode |
| SourceProjectReference | String | sourceprojectreference |
| StartDate | Date | startdate |
The project user resource is used to retrieve attributes for a team member. A team member can have project tasks and to do tasks assigned for tracking and completion.
| Name | Type | Description |
| ResourceId [KEY] | Long | Unique identifier of the project enterprise resource. |
| Phone | String | The telephone number of the projects user |
| String | E-mail address of the projects user | |
| DisplayName | String | Name of the projects user |
| PersonId | Long | The unique identifier of the projects user in HCM. |
| Finder | String | finder |
The tasks for which the projects user can report expenditures such as time.
| Name | Type | Description |
| ProjectsUsersResourceId [KEY] | Long | The unique identifier of the resource assigned to the task. |
| ProjectId [KEY] | Long | Unique identifier of the project. |
| TaskId | Long | Unique identifier of the task. |
| TaskNumber | String | Number of the task. |
| TaskName | String | Name of the task. |
| TransactionStartDate | Date | Date from which transaction can be reported for a task. |
| TransactionCompletionDate | Date | Date upto which transaction can be reported for task. |
| TaskStartDate | Date | Task start date. |
| TaskFinishDate | Date | Task finish date |
| TaskManagerId | Long | Unique identifer of the resource who manages the task. |
| TaskManagerName | String | Name of the resource who manages task. |
| TaskOrganizationName | String | The organization that owns the task |
| ProjectName | String | Name of the project. |
| ProjectUnitId | Long | Unique identifer of the project unit. |
| AssignmentNumber | String | Number for organization assignment. |
| AssignmentId [KEY] | Long | Unique identifer of the organization assignment. |
| PrimaryAssignment | String | Indicates whether an assignment is the primary assignment. |
| DefaultExpenditureTypeName | String | Default expenditure type name of the project |
| DefaultExpenditureTypeId | Long | Unique identifier of the expenditure type. |
| Finder | String | finder |
| ResourceId | Long | resourceid |
The projects for which the projects user can report expenditures such as time.
| Name | Type | Description |
| ProjectsUsersResourceId [KEY] | Long | The unique identifier of the project. |
| ProjectName | String | Name of the project that is created. |
| ProjectNumber | String | Project Number of the project. |
| ProjectId [KEY] | Long | The unique identifier of the project. |
| ProjectFinishDate | Date | The date that work or information tracking ends on a project. |
| OwningOrganizationId | Long | Unique identifer of the organization. |
| ProjectDescription | String | The description of the project. |
| ProjectManagerResourceId | Long | Unique identifer of the person who leads the project team |
| ProjectManagerName | String | Name of the person who leads the project team. |
| ProjectManagerEmail | String | E-mail of the person who leads the project team. |
| OwningOrganizationName | String | An organization unit in the internal or external structure |
| BusinessUnitName | String | Name of the business unit ti which the porject belongs. |
| BusinessUnitId | Long | Unique identifer of the business unit to which the project belongs. |
| ProjectUnitName | String | Name of the project unit assigned to the project. |
| DefaultExpenditureTypeName | String | Name of the default expenditure type for a resouce class in a project. |
| DefaultExpenditureTypeId | Long | Unique identifier of the default expenditure type set for a resource class. |
| ProjectStartDate | Date | The date that work or information tracking begins on project. |
| ProjectUnitId | Long | Unique identifier of the project unit assigned to the user |
| AssignmentId | Long | Unique idendifer of the organization of the projects user |
| AssignmentNumber | String | Unique reference of the organization assignment of the projects user |
| PrimaryAssignment | String | Indicates whether an assignment is the primary assignment of the person |
| Finder | String | finder |
| ResourceId | Long | resourceid |
The followed project task resource is used to retrieve attributes for a project task that a project user follows.
| Name | Type | Description |
| ProjectsUsersResourceId [KEY] | Long | The unique identifier of the resource assigned to the task. |
| CreationDate | Datetime | The date when the task is created. |
| CreatedBy | String | Unique identifier of the user who created the task. |
| ExecutionDisplaySequence | Long | Display sequence of the task in the project. |
| ElementVersionId | Long | Element version identifier of the task. |
| ElementType | String | Element Type of a task. |
| FinancialParentTaskNumber | String | The number of lowest level financial parent task. |
| FinancialParentTaskName | String | The name of the lowest level financial parent task. |
| FinancialParentTaskId | Long | Identifer of the lowest level financial parent task. |
| LastUpdatedBy | String | Unique identifier of the user who last updated the task. |
| LastUpdateDate | Datetime | The date when the task is last updated. |
| MilestoneFlag | Bool | Text that indicates that a particular task is a milestone in the Team Member Dashboard and in Task Management. |
| ParentTaskId | Long | The unique identifier of the parent task. |
| ParentTaskName | String | The name of the task that will be the parent of the new task. |
| ParentTaskNumber | String | The number of the parent task. If the task is a top task, the parent task number is null. |
| ProjElementId [KEY] | Long | Project Element Identifier of the task. |
| ProjectId | Long | Project identifier of the task. |
| ProjectName | String | Name of the project to which task is associated. |
| ProjectStatusCode | String | Code corresponding to the label to display the status of the project. |
| ProjectStatusName | String | Label to display the status of the project. |
| PlanLineId [KEY] | Long | Unique identifier of the plan line of the followed project task. |
| ObjectType | String | Object type of the task. |
| TaskId | Long | Unique identifier of the task. |
| TaskActualFinishDate | Date | The date on which the work completed on a task. |
| TaskActualStartDate | Date | The date on which the work commenced on a task. |
| TaskActualQuantity | Decimal | The number of hours that the project team member reports working on the task. |
| TaskCurrentFinishDate | Date | The date when the task is estimated to end. |
| TaskCurrentStartDate | Date | The date when the task is estimated to start. |
| TaskCurrentActualQuantity | Decimal | Current estimated effort to complete the task. |
| TaskLevel | Int | Indicates level of the task in the project work plan. |
| TaskName | String | The name of the task. |
| TaskFollowerId [KEY] | Long | Unique identifier of the task follower. |
| TaskProgressEnteredDate | Date | The date when last progress was entered. |
| TaskPrimaryResourceId | Long | Identifier of the primary resource assigned to the task. |
| TaskProgressStatusCode | String | The code of progress status of the task. |
| TaskProgressStatus | String | Progress Status of the task. |
| TaskPercentComplete | Decimal | The percent of work complete for a particular task. |
| TaskPlannedFinishDate | Date | Date on which a task is intended to finish. |
| TaskPlannedStartDate | Date | Date on which a task is intended to begin. |
| TaskPriority | Decimal | Priority of the task. |
| TaskProposedFinishDate | Date | The date that the task is expected to finish on. |
| TaskProposedStartDate | Date | The date that the task is expected to start on. |
| TaskProposedQuantity | Decimal | The total number of hours estimated to take a particular persoon to complete a particular task. |
| TaskRemainingQuantity | Decimal | The hours the project team member has left to complete the task. |
| TaskResourceAllocationPercent | Decimal | Percentage of time that all resources assigned to the task are planned to work on the task. |
| TaskQuantity | Decimal | The number of hours that a resource is assigned to work on a task. |
| TopTaskId | Long | Identifer of the top task to which the task rolls up.if the task is a top task, the number of the top task is same as the number of the task. |
| TopTaskName | String | The name of the top task to which the task rolls up. if the task is a top task, the name of the top task is same as the number of the task. |
| TopTaskNumber | String | The number of the top task to which the task rolls up. if the task is a top task, the name of the top task is same as the number of the task. |
| OsnSharedTaskFlag | Bool | Indicates if task is shared on OSN. |
| Finder | String | finder |
| ResourceId | Long | resourceid |
The followed to do task resource is used to retrieve attributes for a to do task that a project user follows. To do Tasks may be followed by many project users.
| Name | Type | Description |
| ProjectsUsersResourceId [KEY] | Long | The unique identifier of the resource assigned to the task. |
| TaskName | String | The name of the task. |
| ProjElementId [KEY] | Long | Project Element Identifier of the task. |
| ObjectType | String | Object type of the task. |
| ElementType | String | Element Type of a task. |
| TaskDescription | String | Description of a task. |
| TaskPriority | Decimal | Priority of the task. |
| PlanLineId [KEY] | Long | Unique identifer of the plan line of the followed to do task. |
| TaskProgressStatusCode | String | Code of the progress status of the task. |
| TaskProgressEnteredDate | Date | The date when last progress was entered. |
| TaskActualFinishDate | Date | The date on which the work completed on a task. |
| TaskActualStartDate | Date | The date on which the work commenced on a task. |
| TaskPlannedStartDate | Date | The date that the task starts. |
| TaskPlannedFinishDate | Date | The date that the task ends. |
| ElementVersionId | Long | Element version identifier of the task. |
| ResourceId | Long | Identifier of the resource assigned to the task. |
| TaskFollowerId | Long | Unique identifier of the task follower. |
| TaskProgressStatus | String | Progress Status of the task. |
| TaskId | Long | Unique identifier of the task. |
| CreatedBy | String | Unique identifier of the user who created the task. |
| CreationDate | Datetime | The date when the task is created. |
| LastUpdatedBy | String | Unique identifier of the user who last updated the task. |
| LastUpdateDate | Datetime | The date when the task is last updated. |
| OsnSharedTaskFlag | Bool | Indicates if Task is shared on OSN |
| Finder | String | finder |
The project task resource is used to store values while creating or updating project tasks. A task is a unit of project work assigned or performed as part of a resource's duties. Tasks may be a portion of project work to be performed within a defined period by a specific resource or multiple resources.
| Name | Type | Description |
| ProjectsUsersResourceId [KEY] | Long | The unique identifier of the resource assigned to the task. |
| ElementVersionId | Long | Element version identifier of the task. |
| ExecutionDisplaySequence | Long | Display sequence of the task in the project |
| ElementType | String | Element Type of a task. |
| FinancialParentTaskName | String | The name of the lowest level financial parent task. |
| FinancialParentTaskId | Long | Unique identifer of the lowest financail parent task. |
| FinancialParentTaskNumber | String | The number of the lowest level financial parent task. |
| MilestoneFlag | Bool | Text that indicates that a particular task is a milestone in the Team Member Dashboard and in Task Management. |
| ObjectType | String | Object type of the task. |
| ParentTaskName | String | The name of the task that will be the parent of the new task. |
| ParentTaskNumber | String | The number of the parent task. If the task is a top task, the parent task number is null. |
| PlanVersionId | Long | Plan version identifier of the proejct task. |
| ProjectStatusCode | String | Code corresponding to the label to display the status of the project. |
| PlanLineId [KEY] | Long | Unique identifier of the plan line of the task. |
| ProjectSystemStatusCode | String | Code of the system status corresponding status of the project. |
| ProjectStatusName | String | Label to display the status of the project. |
| ProjectName | String | Name of the project to which task is associated |
| ProjElementId [KEY] | Long | Project Element Identifier of the task |
| ProjectId | Long | Identifier of the project to which task is associated |
| TaskId | Long | Unique identifier of the task. |
| TaskActualFinishDate | Date | The date on which the work completed on a task |
| TaskActualStartDate | Date | The date on which the work commenced on a task. |
| TaskName | String | The name of the task. |
| TaskActualQuantity | Decimal | The number of hours that the project team member reports working on the task. |
| TaskCurrentActualQuantity | Decimal | Current estimated effort to complete the task. |
| TaskCurrentFinishDate | Date | The date when the task is estimated to end. |
| TaskCurrentStartDate | Date | The date when the task is estimated to start. |
| TaskExceptions | String | The exceptions generated by the progress entry for the task. |
| TaskPlannedFinishDate | Date | Date on which a task is intended to finish. |
| TaskPlannedStartDate | Date | Date on which a task is intended to begin. |
| TaskPriority | Decimal | Priority of the task. |
| TaskPercentComplete | Decimal | The percent of work complete for a particular task. |
| TaskDescription | String | Description of a task. |
| TaskProposedFinishDate | Date | The date that the task is expected to finish on. |
| TaskProposedStartDate | Date | The date that the task is expected to start on. |
| TaskProgressStatus | String | Progress Status of the task. |
| TaskQuantity | Decimal | The number of hours that a resource is assigned to work on a task |
| TaskProposedQuantity | Decimal | The total number of hours estimated to take a particular persoon to complete a particular task. |
| TaskRemainingQuantity | Decimal | The hours the project team member has left to complete the task. |
| TaskResourceAllocationPercent | Decimal | Percentage of time that all resources assigned to the task are planned to work on the task. |
| TaskLevel | Int | Indicates level of the task in the project work plan. |
| TaskProgressStatusCode | String | Code of the progress status of the task. |
| TaskPrimaryResourceId | Long | Identifier of the primary resource assigned to the task. |
| TaskProgressEnteredDate | Date | The date when last progress was entered. |
| TopTaskId | Long | Identifer of the top task to which the task rolls up.if the task is a top task, the number of the top task is same as the number of the task. |
| TopTaskName | String | The name of the top task to which the task rolls up. if the task is a top task, the name of the top task is same as the number of the task. |
| TopTaskNumber | String | The number of the top task to which the task rolls up. if the task is a top task, the number of the top task is same as the number of the task. |
| LastUpdatedBy | String | Unique identifier of the user who last updated the task. |
| LastUpdateDate | Datetime | The date when the task is last updated. |
| CreatedBy | String | Unique identifier of the user who created the task. |
| CreationDate | Datetime | The date when the task is created. |
| OsnSharedTaskFlag | Bool | Indicates whether a task is shared on OSN. If the value is true, then the task is shared. The default value is false. |
| Finder | String | finder |
| ResourceId | Long | resourceid |
The labor resource assignment includes attributes used to store values while creating or updating labor resource assignments for a project task. For example, a DBA may be assigned as a labor resource for a project task.
| Name | Type | Description |
| ProjectsUsersResourceId [KEY] | Long | The unique identifier of the resource assigned to the task. |
| ProjecttasksPlanLineId [KEY] | Long | The unique identifier of the plan line of the task. |
| ProjecttasksProjElementId [KEY] | Long | The unique identifier of the project Element of the task. |
| String | E-mail address for the resource | |
| ResourceId | Long | The unique identifier of the resource assigned to the task. |
| DisplayName | String | Name of the resource assigned to the task |
| Phone | String | The telephone number for a resource. |
| ResourceAllocationPercent | Decimal | Percentage of time that the assigned resources is planned to work on the task |
| ElementVersionId | Long | Element version identifier of the task |
| Quantity | Decimal | The number of hours that a resource is assigned to work on a task. |
| PrimaryResource | String | Indicator that a resource is primary resource or not on the task. |
| TaskId | Long | Unique identifier of the task. |
| LaborResourceAssignmentId | Long | Unique identifier of the resource assignment on the task. |
| Finder | String | finder |
The task follower resource is used to store values while adding or removing followers on project tasks. A project user can be assigned as a follower on a project task for viewing task details and tracking its completion.
| Name | Type | Description |
| ProjectsUsersResourceId [KEY] | Long | The unique identifier of the resource assigned to the task. |
| ProjecttasksPlanLineId [KEY] | Long | The unique identifier of the plan line of the task. |
| ProjecttasksProjElementId [KEY] | Long | The unique identifier of the project Element of the task. |
| ResourceId | Long | Unique identifier of the resource assignment on the task. |
| TaskFollowerId [KEY] | Long | Unique identifier of the task follower. |
| ElementVersionId | Long | Element version identifier of the task. |
| String | E-mail address for the follower resource. | |
| DisplayName | String | Name of the follower resource. |
| Phone | String | The telephone number of the follower resource. |
| Finder | String | finder |
The to do task resource is used to store values while creating or updating to do tasks. A to do task is a unit of work assigned or performed as part of a resource's duties outside of any project. To do tasks may be performed within a defined period by a specific resource.
| Name | Type | Description |
| ProjectsUsersResourceId [KEY] | Long | The unique identifier of the resource assigned to the task. |
| TaskName | String | The name of the task. |
| ProjElementId [KEY] | Long | Project Element Identifier of the task. |
| ObjectType | String | Object type of the task. |
| ElementType | String | Element Type of a task. |
| TaskDescription | String | Description of a task. |
| TaskPlannedFinishDate | Date | The date that the task ends. |
| TaskPlannedStartDate | Date | The date that the task starts. |
| TaskProgressStatusCode | String | Code of the progress status of the task. |
| TaskProgressEnteredDate | Date | The date when last progress was entered. |
| TaskPriority | Decimal | Priority of the task. |
| TaskProgressStatus | String | Progress Status of the task. |
| ElementVersionId [KEY] | Long | Element version identifier of the task. |
| TaskId | Long | Unique identifier of the task. |
| CreatedBy | String | Unique identifier of the user who created the task. |
| CreationDate | Datetime | The date when the task is created. |
| LastUpdateDate | Datetime | The date when the task is last updated. |
| LastUpdatedBy | String | Unique identifier of the user who last updated the task. |
| PlanLineId | Long | Unique identifer of the plan line of the to do task. |
| OsnSharedTaskFlag | Bool | Indicates of the task is shared on OSN. |
| Finder | String | finder |
| ResourceId | Long | resourceid |
The to do task follower resource is used to store values while adding or removing followers on to do tasks.
| Name | Type | Description |
| ProjectsUsersResourceId [KEY] | Long | The unique identifier of the resource assigned to the task. |
| TodotasksElementVersionId [KEY] | Long | The unique identifier of the element version of the task. |
| TodotasksProjElementId [KEY] | Long | The unique identifier of the project element of the task. |
| ResourceId | Long | Unique identifier of the resource assignment on the task. |
| TaskFollowerId [KEY] | Long | Unique identifier of the task follower. |
| ElementVersionId | Long | Element version identifier of the task. |
| String | E-mail address for the follower resource. | |
| DisplayName | String | Name of the follower resource. |
| Phone | String | The telephone number of the follower resource. |
| Finder | String | finder |
The LOV for Project Tasks resource is used to view project tasks for a specific project.
| Name | Type | Description |
| ElementType | String | Indicates if the task is enabled for financial management. A value of FINANCIAL or FIN_EXEC indicates that the task is enabled for financial management. |
| ProjectId | Long | Identifier of the project to which the task belongs. |
| TaskId [KEY] | Long | Identifier of the project task. |
| TaskName | String | Name of the project task. |
| TaskNumber | String | Number of the project task that identifies it uniquely in the project task hierarchy. |
| TransactionCompletionDate | Date | The latest date a transaction can be created for the task. |
| TransactionStartDate | Date | The earliest date a transaction can be created for the task. |
| Finder | String | finder |
The Project Template resource is used to view and create a project template that is used for project creation.
| Name | Type | Description |
| AllowCrossChargeFlag | Bool | An option at the project level to indicate if transaction charges are allowed from all provider business units to the project. Valid values are true and false. By default, the value is false. |
| AllowCapitalizedInterestFlag | Bool | Indicates whether the project allows capitalization of interest amounts. If true, then interest capitalization is allowed. If false, then it isn't. The default value is derived from the project type. |
| AssetAllocationMethodCode | String | Code identifier of the method by which unassigned asset lines and common costs are allocated across multiple assets. Valid values include AU for actual units, CC for current cost, EC for estimated cost, SC for standard unit cost, SE for spread evenly, CE for client extension, and N for none. A list of accepted values is defined in the PJC_ASSET_ALLOCATION_METHOD lookup type. The default value is derived from the project type. |
| CapitalEventProcessingMethodCode | String | Code identifier of the method for processing events on capital projects. Valid values include M for manual, P for periodic, and N for none. The default value is N. |
| CapitalizedInterestRateScheduleId | Long | Unique identifier of the rate schedule used to calculate capitalized interest. Enter a value for either this attribute or Capitalized Interest Rate Schedule, but not both. The default value is derived from the project type. |
| CapitalizedInterestRateScheduleName | String | Name of the rate schedule used to calculate capitalized interest. Enter a value for either this attribute or Capitalized Interest Rate Schedule ID, but not both. The default value is derived from the project type. |
| CapitalizedInterestStopDate | Date | Date when capitalized interest will stop accruing. |
| CurrencyConvDate | Date | A specific date used to obtain currency conversion rates when converting an amount to the project currency. This is used when the currency conversion date type is Fixed Date. |
| CurrencyConvDateTypeCode | String | Code identifier of the date type used when converting amounts to the project currency. Valid values include A for accounting date, P for project accounting date, T for transaction date, and F for fixed date. A list of accepted values is defined in the PJF_DEF_RATE_DATE_CODE lookup type. The default is the project accounting default rate type. Review the project accounting default using the Configure Project Accounting Business Functions task in the Setup and Maintenance work area. |
| CurrencyConvRateType | String | Rate type used to obtain currency conversion rates when converting an amount to the project currency. The default is the project accounting default rate type. Review the project accounting default using the Configure Project Accounting Business Functions task in the Setup and Maintenance work area. |
| BurdenScheduleId | Long | Unique identifier of the burden schedule. Enter a value for either this attribute or Burden Schedule, but not both. The default value is derived from the project type. |
| BurdenScheduleFixedDate | Date | A specific date used to determine the set of burden multipliers for the project. |
| BurdenScheduleName | String | Name of the burden schedule. Enter a value for either this attribute or Burden Schedule ID, but not both. The default value is derived from the project type. |
| BusinessUnitName | String | Name of the business unit to which the project belongs. |
| BusinessUnitId | Long | Unique identifier of the business unit to which the project belongs. |
| CrossChargeLaborFlag | Bool | Indicator to show that the project will allow processing of cross-charge transactions between business units for labor transactions. Valid values are true and false. By default, the value is false. |
| CrossChargeNonLaborFlag | Bool | Indicator to show that the project will allow processing of cross-charge transactions between business units for nonlabor transactions. Valid values are true and false. By default, the value is false. |
| EnableBudgetaryControlFlag | Bool | An option at the project level to indicate if budgetary control is enabled. Valid values are true and false. |
| IncludeNotesInKPINotificationsFlag | Bool | Indicates whether project KPI notes are included in KPI notifications. If true, then notes are included. If false, then they're not. The default value is true. |
| InitialProjectStatus | String | Default status of the project when created using a project template.Typical project statuses are Active and Draft. |
| InitialProjectStatusCode | String | Default status of the project when created using a project template. Typical project status codes are ACTIVE and DRAFT. |
| KPINotificationEnabledFlag | Bool | Indicates whether to notify project managers when KPI values are generated for the project. If true, then project managers are notified. If false, then they're not. The default value is true. |
| LaborTpFixedDate | Date | A specific date used to determine a price on a transfer price schedule for labor transactions. |
| LaborTpSchedule | String | Name of the transfer price schedule that associates transfer price rules with pairs of provider and receiver organizations for labor transactions. |
| LaborTpScheduleId | Decimal | Unique identifier of the labor transfer price schedule. |
| LegalEntityName | String | Name of the legal entity associated with the project. |
| LegalEntityId | Long | Unique identifier of the legal entity associated with the project. |
| NlTransferPriceFixedDate | Date | A specific date used to determine a price on a transfer price schedule for nonlabor transactions. |
| NlTransferPriceSchedule | String | Name of the transfer price schedule that associates transfer price rules with pairs of provider and receiver organizations for labor transactions. |
| NlTransferPriceScheduleId | Decimal | Unique Identifier of the nonlabor transfer price schedule. |
| OwningOrganizationName | String | A organizing unit in the internal or external structure of the enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting for the project. |
| OwningOrganizationId | Long | Unique identifier of the organization that owns the project. |
| PlanningProjectFlag | Bool | Indicates whether the project is used as a planning project. If true, plan features include Microsoft Project integration, creating task assignments, adding planned amounts, and capturing plan progress. If false, then these features aren't available. The default value is true. |
| ProjectCurrencyCode | String | The currency code for the project. The currency code is a three-letter ISO code associated with a currency. |
| ProjectEndDate | Date | The date that work or information tracking completes for a project. |
| ProjectLedgerCurrencyCode | String | Currency code for the ledger associated with the project business unit. The currency code is a three-letter ISO code associated with a currency. For example, USD. |
| ProjectManagerEmail | String | Email of the person who leads the project team and who has the authority and responsibility for meeting the project objectives. |
| ProjectManagerName | String | Name of the person who leads the project team and who has authority and responsibility for meeting project objectives. |
| ProjectManagerResourceId | Long | Unique identifier of the person who leads the project team and who has the authority and responsibility for meeting the project objectives. This attribute has been deprecated. |
| ProjectPlanType | String | The project plan type is a grouping of settings related to the project plan such as whether multiple currencies are used, progress settings, task date settings, etc. |
| ProjectPlanTypeId | Long | Unique identifier of the project plan type associated to the project template. |
| ProjectPriorityCode | String | Unique identifier of the importance of a project based on a predefined scale. |
| ProjectStartDate | Date | The date that work or information tracking begins on a project. |
| ProjectTemplateDescription | String | Description of the project template. |
| ProjectTemplateEndDate | Date | Date on which the project template becomes inactive. |
| ProjectTemplateId [KEY] | Long | Unique identifier of the project template. |
| ProjectTemplateName | String | Name of the project template that is being created. |
| ProjectTemplateNumber | String | Number of the project template that is being created. |
| ProjectTemplateStartDate | Date | Date on which the project template becomes active. |
| ProjectTypeName | String | Name of the set of project options that determine the nature of the project. |
| ProjectTypeId | Long | Unique identifier of the set of project options that determine the nature of the project. |
| ProjectUnitName | String | Name of the project unit assigned to the project. |
| ProjectUnitId | Long | Unique identifier of the project unit assigned to the project. |
| ServiceType | String | A classification of the service or activity associated with a project. |
| ServiceTypeCode | String | Unique identifier of the service type. |
| SourceApplicationCode | String | The third-party application from which the project template originates. |
| SourceReference | String | Reference of the business object identifier in the source application from which the project template is created. |
| TransactionControlFlag | Bool | Type of transaction controls, inclusive or exclusive, defined for the selected project or task. true means inclusive, false means exclusive. |
| WorkType | String | A classification of the work associated with a task. You can use work types to categorize and group projects for processing purposes. |
| WorkTypeId | Long | Unique identifier of the work type. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| LastUpdatedBy | String | The user who last updated the record. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| Finder | String | finder |
The LOV for Project Templates resource is used to view a list of project templates. Project templates are set up to have features common in the projects that an organization wants to create. A project template is used to enable a project for financial management and the financial attributes are copied from the template to the project.
| Name | Type | Description |
| ProjectTemplateId [KEY] | Long | Identifier of the project template. |
| TemplateName | String | Name of the project template. |
| TemplateNumber | String | Number of the project template. |
| OrganizationName | String | Name of the organization that owns the project template. |
| AwardCurrencyCode | String | awardcurrencycode |
| BillableCode | String | billablecode |
| BusinessUnitId | Long | businessunitid |
| Finder | String | finder |
| LegalEntityId | Long | legalentityid |
The Project Classification resource is used to view project classification. A project classification includes a class category and a class code, wherein the category is a broad subject within which you can classify projects, and the code is a specific value of the category.
| Name | Type | Description |
| ProjectTemplatesProjectTemplateId [KEY] | Long | Unique identifier of the project template. |
| ProjectClassificationId [KEY] | Long | Unique identifier of the project classification. |
| ClassCategoryId | Long | Unique identifier of the project class category. |
| ClassCategory | String | Name of the project class category. |
| ClassCodeId | Long | Unique identifier of the project class code. |
| ClassCode | String | Name of the project class code. |
| CodePercentage | Decimal | Indicates the relative proportion of each class code when multiple class codes are associated with a single class category. The definition of the class category determines whether the sum of all class code percentages must equal 100. Valid values are numbers between 0 and 100. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| LastUpdatedBy | String | The user who last updated the record. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| Finder | String | finder |
| ProjectTemplateId | Long | projecttemplateid |
The Project Customer resource is used to view and create a project customer. This represents the name of the customer organization with whom the agreement has been made on the project.
| Name | Type | Description |
| ProjectTemplatesProjectTemplateId [KEY] | Long | Unique identifier of the project template. |
| PartyId | Long | Unique identifier of the project customer party. |
| PartyName | String | Name of a person or group of persons who constitute the project customer. |
| PartyNumber | String | Unique number of a person or group of persons who constitute the project customer. |
| ProjectPartyId [KEY] | Long | Unique identifier of a party assignment to the project. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| LastUpdatedBy | String | The user who last updated the record. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| Finder | String | finder |
| ProjectTemplateId | Long | projecttemplateid |
The Project Team Member resource is used to view and create a project team member. A project team member is a person who is assigned a role on a project.
| Name | Type | Description |
| ProjectTemplatesProjectTemplateId [KEY] | Long | Unique identifier of the project template. |
| AssignmentType | String | Indicates if a request is for a billable or a nonbillable assignment. Examples are BILLABLE, NON-BILLABLE, or leave blank. |
| AssignmentTypeCode | String | Code to indicate if a request is for a billable or a nonbillable assignment. Examples are BILLABLE, NON-BILLABLE, or leave blank. |
| BillablePercent | Int | Indicates the percentage of assignment time that is billable for an assignment that is defined as billable assignment. For a non-billable assignment, the value is ignored. Valid values are positive integers between 0 and 100. |
| BillablePercentReason | String | Indicates the reason that the billable percentage of the project resource assignment is less than 100%. For a non-billable assignment, the value is ignored. |
| BillablePercentReasonCode | String | Code that indicates the reason that the billable percentage of the project resource assignment is less than 100%. For a non-billable assignment, the value is ignored. |
| FinishDate | Date | Date on which the assignment of the project team member to the project is scheduled to end. |
| PersonEmail | String | Email of the person assigned as a team member to the project. |
| PersonId | Long | Unique identifier of the person assigned as a team member to the project. |
| PersonName | String | Name of the person assigned as a team member to the project. |
| ProjectRoleId | Long | A classification of the relationship that an employee has to a project. You use project roles to define an employee's level of access to project information. Examples are Project Manager, Project Accountant and Technical Lead. |
| ProjectRoleName | String | A classification of the relationship that an employee has to a project. You use project roles to define an employee's level of access to project information. Examples are Project Manager, Project Accountant, and Technical Lead. |
| ResourceAllocationPercentage | Decimal | Percentage of time for which a resource is assigned to the project. The default value is 100. |
| ResourceAssignmentEffortInHours | Decimal | Number of hours for which a resource is assigned to the project. |
| ResourcePlanningBillRate | Decimal | Bill Rate of the resource assignment for the planning purpose. If no value is specified, Bill Rate of the resource defined in Project Enterprise Resource is used if it is available in the project currency. |
| ResourcePlanningCostRate | Decimal | Cost Rate of the resource assignment for the planning purpose. If no value is specified, Cost Rate of the resource defined in Project Enterprise Resource is used if it is available in the project currency. |
| StartDate | Date | Date from which the assignment of the team member to the project is scheduled to begin. |
| TeamMemberId [KEY] | Long | Unique identifier of the team member assigned to the project. |
| TrackTimeFlag | Bool | Indicates whether time cards are expected from internal team members. Valid values are true and false. The default value is false. Information about missing time cards is displayed on the project manager dashboard. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| Finder | String | finder |
| ProjectTemplateId | Long | projecttemplateid |
The Project Transaction Control resource is used to view and create a project transaction control. Project transaction controls are a set of criteria that control whether a transaction can be charged to a project.
| Name | Type | Description |
| ProjectTemplatesProjectTemplateId [KEY] | Long | Unique identifier of the project template. |
| TransactionControlId [KEY] | Long | Identifier of the transaction control. |
| RuleNumber | Long | Identifier of the transaction control within a project or task. Default value is the successor of the maximum existing rule number. |
| StartDateActive | Date | The date from which the transaction control is effective. Default value is the project start date. |
| EndDateActive | Date | The date after which the transaction control is no longer effective. |
| BillableHint | String | Indicates that transactions charged to the project can be billed to customers. This attribute is applicable for billable projects. A list of accepted values - No and Task - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Billable Code or both of them. Default value is Task. |
| Billable | String | Indicates that transactions charged to the project can be billed to customers. This attribute is applicable for billable projects. A list of accepted values - N and T - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Billable or both of them. Default value is T. |
| ChargeableHint | String | Indicates that something is eligible to be charged to the project. A list of accepted values - Yes and No - is defined in the lookup type PJC_YES_NO. You can enter either this attribute or Chargeable Code or both of them. Default value is No. |
| Chargeable | String | Indicates that something is eligible to be charged to the project. A list of accepted values - Y and N - is defined in the lookup type PJC_YES_NO. You can enter either this attribute or Chargeable or both of them. Default value is N. |
| CapitalizableHint | String | Indicates the capitalizable status of the transaction. This attribute is applicable for capital projects. A list of accepted values - No and Task - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Capitalizable Code or both of them. Default value is Task. |
| Capitalizable | String | Indicates the code for the capitalizable status of the transaction. This attribute is applicable for capital projects. A list of accepted values - N and T - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Capitalizable or both of them. Default value is T. |
| ExpenditureCategoryId | Long | Identifier of the expenditure category. You can enter either this attribute or Expenditure Category or both of them. |
| ExpenditureCategoryName | String | A grouping of expenditure types by type of cost. For example, an expenditure category with a name such as Labor refers to the cost of labor. You can enter either this attribute or Expenditure Category ID or both of them. |
| ExpenditureTypeId | Long | Identifier of the expenditure type. You can enter either this attribute or Expenditure Type or both of them. |
| ExpenditureTypeName | String | A classification of cost that is assigned to each project cost transaction. Expenditure types are grouped into cost groups (expenditure categories) and revenue groups (revenue categories). You can enter either this attribute or Expenditure Type ID or both of them. |
| NonLaborResourceId | Long | Identifier of the nonlabor resource. You can enter either this attribute or Nonlabor Resource or both of them. |
| NonLaborResourceName | String | An implementation defined asset or pool of assets. These assets may represent actual pieces of equipment whose time is consumed, or an asset whose output is consumed. For example, you can define a nonlabor resource with a name of Training Room to track the usage of a physical room and the associated costs. The actual usage of the room is tracked in hours. You can enter either this attribute or Nonlabor Resource ID or both of them. |
| PersonName | String | The name of an individual human team member. You can enter either this attribute, Person ID, Person Number, or Email or a combination of these attributes. |
| PersonId | Long | Identifier of the person. You can enter either this attribute, Person Name, Person Number, or Email, or a combination of these attributes. |
| PersonNumber | String | Number that uniquely identifies a person. This number refers to the Fusion HCM specific identifier that uniquely identifies a person in the application, regardless of their relationship to the enterprise. It does not have any relation to any national identifier component. You can enter either this attribute, Person ID, Person Name, or Email, or a combination of these attributes. |
| EmailAddress | String | Email address of the person. You can enter either this attribute, Person ID, Person Number, or Person Name, or a combination of these attributes. |
| JobId | Long | Identifier of the job. You can enter either this attribute or Job or both of them. You must enter at least one from among the Person Name, Person ID, Person Number, and Email attributes if you enter a value for this attribute. |
| Job | String | The job that is being performed by the person that incurred the cost that was charged to the task. You can enter either this attribute or Job ID or both of them. You must enter at least one from among the Person Name, Person ID, Person Number, and Email attributes if you enter a value for this attribute. |
| PersonTypeHint | String | The type used to classify the person in human resources. For example, the person type can be either employee or contingent worker. A list of accepted values - Employee and Contingent Worker - is defined in the lookup type PJF_PERSON_TYPE You can enter either this attribute or Person Type Code or both of them. |
| PersonType | String | Indicates the code of the type used to classify the person in human resources. For example, the person type can be either employee or contingent worker. A list of accepted values - EMP and CWK - is defined in the lookup type PJF_PERSON_TYPE You can enter either this attribute or Person Type or both of them. |
| OrganizationId | Long | Identifier of the organization to which the person job belongs. You can enter either this attribute or Organization or both of them. You must enter the person and job attributes if you enter a value for this attribute. |
| Organization | String | The name of the organization to which the person job belongs. You can enter either this attribute or Organization ID or both of them. You must enter the person and job attributes if you enter a value for this attribute. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| LastUpdateDate | Datetime | The user who last updated the record. |
| LastUpdatedBy | String | The date when the record was last updated. |
| Finder | String | finder |
| ProjectTemplateId | Long | projecttemplateid |
The project template resource is used to view provider business units. This includes viewing, creating, updating, and deleting provider business units that are from Project Portfolio Management and those imported from third-party applications. Provider Business Unit is a child of the Project Template.
| Name | Type | Description |
| ProjectTemplatesProjectTemplateId [KEY] | Long | Unique identifier of the project template. |
| BusinessUnitId [KEY] | Long | Identifier of the business unit associated with the project template to which the provider business unit has been assigned. |
| BusinessUnitName | String | Name of the business unit associated with the project template to which the provider business unit has been assigned. |
| CreatedBy | String | Name of user who created the provider business unit for this project template. |
| CreationDate | Datetime | Date on which the provider business unit was created for the project template. |
| LastUpdatedBy | String | Date on which the provider business unit was last updated for the project template. |
| LastUpdatedDate | Datetime | Name of user who last updated the provider business unit for this project template. |
| Finder | String | finder |
| ProjectTemplateId | Long | projecttemplateid |
The Quick Entry resource is used to view a quick entry for a project template.
| Name | Type | Description |
| ProjectTemplatesProjectTemplateId [KEY] | Long | Unique identifier of the project template. |
| FieldCode | String | Code of the field represented by the quick entry. Valid values are TEAM_MEMBER, CLASSIFICATION, LEGAL_ENTITY_ID, CARRYING_OUT_ORGANIZATION_ID, PARTNER_ORG, PRIORITY_CODE, CUSTOMER_NAME, DESCRIPTION, PROJECT_STATUS_CODE, and SUPPLIER_ORG. |
| MandatoryFlag | Bool | Indicates whether the quick entry is mandatory or not. Valid values are true and false. Default value is false. |
| Prompt | String | Display name of the field. |
| QuickEntryId [KEY] | Long | Unique identifier of the quick entry for a project template. |
| Specification | String | Specification of the field. It applies only if the field is TEAM_MEMBER or CLASSIFICATION. It is mandatory when the field is TEAM_MEMBER or CLASSIFICATION. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| LastUpdatedBy | String | The user who last updated the record. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| Finder | String | finder |
| ProjectTemplateId | Long | projecttemplateid |
The Setup Option resource is used to view a setup option for a project template.
| Name | Type | Description |
| ProjectTemplatesProjectTemplateId [KEY] | Long | Unique identifier of the project template. |
| DisplayFlag | Bool | Indicates whether the setup option will be displayed for the projects created using the project template. Valid values are true and false. |
| OptionCode [KEY] | String | Code of the setup option. Valid values are lookup codes for the lookup type PJF_OPTIONS_SS. Enter a value for either this attribute or Option but not both. |
| OptionName | String | Name of the setup option. Valid values are lookup meanings for the lookup type PJF_OPTIONS_SS. Enter a value for either this attribute or Option Code but not both. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| LastUpdatedBy | String | The user who last updated the record. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| Finder | String | finder |
| ProjectTemplateId | Long | projecttemplateid |
The Task resource is used to view and create a project task. Tasks are units of project work assigned or performed as part of the duties of a resource. Tasks can be a portion of project work to be performed within a defined period by a specific resource or multiple resources.
| Name | Type | Description |
| ProjectTemplatesProjectTemplateId [KEY] | Long | Unique identifier of the project template. |
| AllowCapitalInterestFlag | Bool | Indicates the task is enabled for capitalization of interest amounts. |
| AllowCrossChargeTransactionsFlag | Bool | Indicates that the project will allow cross-charge transactions from other business units. |
| BillableFlag | Bool | Indicates transactions charged to that task can be billed to customers. |
| BurdenSchedule | String | Name of the burden schedule associated to the task. |
| BurdenScheduleId | Long | Unique identifier of the burden schedule associated to the task. |
| BurdenScheduleFixedDate | Date | A specific date used to determine the right set of burden multipliers for the task. |
| CapitalizableFlag | Bool | Indicates the capitalizable status of a task. Transactions charged to that task can be set up as business assets in the books of account instead of treated as expenses. |
| CapitalizeInterestStopDate | Date | The date where capitalized interest will stop accruing. |
| ChargeableFlag | Bool | Chargeable task checkbox indicator |
| CriticalFlag | Bool | A task that must be completed on schedule or it will impact the finish date of the entire project. |
| CrossChargeLaborFlag | Bool | Indicator to show that the project allows processing of cross-charge transactions between business units for labor transactions. Valid values are true and false. |
| CrossChargeNonLaborFlag | Bool | Indicates whether nonlabor transactions are eligible for cross-charging when the task allows cross-charge transactions from other business units. If true, then nonlabor transactions are eligible for cross-charge processing. If false, they're not. The default value for a summary task is derived from the project. The default value for a subtask is derived from the corresponding value of the parent task. |
| ExternalParentTaskId | String | Unique identifier of the parent project task that is created in the third-party application. |
| ExternalTaskId | String | Unique identifier of the project task that is created in the third-party application. |
| LowestLevelTask | String | Indicates the task is at the lowest level. |
| LaborTpSchedule | String | Name of the transfer price schedule that associates transfer price rules with pairs of provider and receiver organizations for labor transactions. Enter a value for either this attribute or Labor Transfer |
| LaborTpScheduleId | Long | Unique identifier of the labor transfer price schedule. Enter a value for either this attribute or Labor Transfer Price Schedule but not both. |
| LaborTpFixedDate | Date | A specific date used to determine a price on a transfer price schedule for labor transactions. |
| MilestoneFlag | Bool | Indicates the project milestone during which the task must be completed. |
| NlTransferPriceSchedule | String | Name of the transfer price schedule that associates transfer price rules with pairs of provider and receiver organizations for nonlabor transactions. Enter a value for either this attribute or Nonlabor |
| NlTransferPriceScheduleId | Long | Unique Identifier of the nonlabor transfer price schedule. Enter a value for either this attribute or Nonlabor Transfer Price Schedule but not both. |
| NlTransferPriceFixedDate | Date | A specific date used to determine a price on a transfer price schedule for nonlabor transactions. |
| ParentTaskId | Long | Identifier of the parent task of the task. |
| PartySiteId | Long | The customer address or location of where the work for a project is being performed. |
| PercentCompleteCalculationMethodCode | String | The means of calculating physical percent complete. For example, you can calculate physical percent complete for a lowest task based on cost, effort, or manual entry. |
| ProgressETCMethodCode | String | The method used to calculate estimate-to-complete values in project progress. For example, calculation methods are remaining plan and manual entry. |
| ReceiveProjectInvoiceFlag | Bool | Indicates if a task can receive invoices from other projects. |
| RetirementCostFlag | Bool | The cost of the removal of an asset, equipment, property, or resource from service after its useful life, or following its sale. |
| ServiceType | String | A classification of the service or activity associated with a task. |
| ServiceTypeCode | String | A classification of the service or activity associated with a task. |
| SourceApplication | String | The third-party application from which the task is imported. |
| SourceReference | String | The identifier of the task in the external system where it was originally entered. |
| TaskDescription | String | Text description of the project task that is being created. |
| TaskFinishDate | Date | Scheduled end date of the project task. |
| TaskId | Long | Unique identifier of the project task. |
| TaskLevel | Int | Indicates level of the task in the WBS. |
| TaskManagerEmail | String | Email of the person who is assigned as task manager to the task. |
| TaskManagerName | String | The resource who manages the task. |
| TaskManagerPersonId | Long | Unique identifier of the person who leads the project task and who has the authority and responsibility for meeting the task objectives. |
| TaskName | String | Name of the task. A task is subdivision of project work. |
| TaskNumber | String | Number of a task. |
| TaskOrganizationId | Long | Unique identifier of the task organization. |
| TaskOrganizationName | String | Name of the organization that owns the task. |
| TaskSequence | Long | Position of the project task in a hierarchical arrangement. |
| TaskStartDate | Date | Scheduled start date of the project task. |
| TransactionCompletionDate | Date | Date after which transactions won't be accepted by the task. |
| TransactionStartDate | Date | Date before which transactions won't be accepted by the task. |
| TopTaskId | Long | Identifier of the top task to which the task rolls up. If the task is a top task, the identifier of the top task is same as the identifier of the task. |
| WorkType | String | A classification of the work associated with a task. You can use work types to categorize and group tasks for processing purposes. |
| WorkTypeId | Long | A classification of the work associated with a task. You can use work types to categorize and group tasks for processing purposes. |
| CreationDate | Datetime | The date when the record was created. |
| CreatedBy | String | The user who created the record. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| Finder | String | finder |
| ProjectTemplateId | Long | projecttemplateid |
The Task Transaction Control resource is used to view and create a task transaction control. Task transaction controls are a set of criteria that control whether a transaction can be charged to a task.
| Name | Type | Description |
| ProjectTemplatesProjectTemplateId [KEY] | Long | Unique identifier of the project template. |
| TransactionControlId [KEY] | Long | Identifier of the transaction control. |
| RuleNumber | Long | Identifier of the transaction control within a project or task. Default value is the successor of the maximum existing rule number. |
| TaskId | Long | Identifier of the project task. Default value is the identifier of the project task for which the transaction control is created. |
| StartDateActive | Date | The date from which the transaction control is effective. Default value is the system date. |
| EndDateActive | Date | The date after which the transaction control is no longer effective. |
| BillableHint | String | Indicates that transactions charged to the task can be billed to customers. This attribute is applicable for billable tasks. A list of accepted values - No and Task - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Billable Code or both of them. Default value is Task. |
| Billable | String | Indicates that transactions charged to the task can be billed to customers. This attribute is applicable for billable tasks. A list of accepted values - N and T - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Billable or both of them. Default value is T. |
| ChargeableHint | String | Indicates that something is eligible to be charged to the task. A list of accepted values - Yes and No - is defined in the lookup type PJC_YES_NO. You can enter either this attribute or Chargeable Code or both of them. Default value is No. |
| Chargeable | String | Indicates that something is eligible to be charged to the task. A list of accepted values - Y and N - is defined in the lookup type PJC_YES_NO. You can enter either this attribute or Chargeable or both of them. Default value is N. |
| CapitalizableHint | String | Indicates the capitalizable status of the transaction. This attribute is applicable for capital projects. A list of accepted values - No and Task - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Capitalizable Code or both of them. Default value is Task. |
| Capitalizable | String | Indicates the code for the capitalizable status of the transaction. This attribute is applicable for capital projects. A list of accepted values - N and T - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Capitalizable or both of them. Default value is T. |
| ExpenditureCategoryId | Long | Identifier of the expenditure category. You can enter either this attribute or Expenditure Category or both of them. |
| ExpenditureCategoryName | String | A grouping of expenditure types by type of cost. For example, an expenditure category with a name such as Labor refers to the cost of labor. You can enter either this attribute or Expenditure Category ID or both of them. |
| ExpenditureTypeId | Long | Identifier of the expenditure type. You can enter either this attribute or Expenditure Type or both of them. |
| ExpenditureTypeName | String | A classification of cost that is assigned to each project cost transaction. Expenditure types are grouped into cost groups (expenditure categories) and revenue groups (revenue categories). You can enter either this attribute or Expenditure Type ID or both of them. |
| NonLaborResourceId | Long | Identifier of the nonlabor resource. You can enter either this attribute or Nonlabor Resource or both of them. |
| NonLaborResourceName | String | An implementation defined asset or pool of assets. These assets may represent actual pieces of equipment whose time is consumed, or an asset whose output is consumed. For example, you can define a nonlabor resource with a name of Training Room to track the usage of a physical room and the associated costs. The actual usage of the room is tracked in hours. You can enter either this attribute or Nonlabor Resource ID or both of them. |
| PersonName | String | The name of an individual human team member. You can enter either this attribute, Person ID, Person Number, or Email or a combination of these attributes. |
| PersonId | Long | Identifier of the person. You can enter either this attribute, Person Name, Person Number, or Email, or a combination of these attributes. |
| PersonNumber | String | Number that uniquely identifies a person. This number refers to the Fusion HCM specific identifier that uniquely identifies a person in the application, regardless of their relationship to the enterprise. It does not have any relation to any national identifier component. You can enter either this attribute, Person ID, Person Name, or Email, or a combination of these attributes. |
| EmailAddress | String | Email address of the person. You can enter either this attribute, Person ID, Person Number, or Person Name, or a combination of these attributes. |
| JobId | Long | Identifier of the job. You can enter either this attribute or Job or both of them. You must enter at least one from among the Person Name, Person ID, Person Number, and Email attributes if you enter a value for this attribute. |
| Job | String | The job that is being performed by the person that incurred the cost that was charged to the task. You can enter either this attribute or Job ID or both of them. You must enter at least one from among the Person Name, Person ID, Person Number, and Email attributes if you enter a value for this attribute. |
| PersonTypeHint | String | The type used to classify the person in human resources. For example, the person type can be either employee or contingent worker. A list of accepted values - Employee and Contingent Worker - is defined in the lookup type PJF_PERSON_TYPE You can enter either this attribute or Person Type Code or both of them. |
| PersonType | String | Indicates the code of the type used to classify the person in human resources. For example, the person type can be either employee or contingent worker. A list of accepted values - EMP and CWK - is defined in the lookup type PJF_PERSON_TYPE You can enter either this attribute or Person Type or both of them. |
| OrganizationId | Long | Identifier of the organization to which the person job belongs. You can enter either this attribute or Organization or both of them. You must enter the person and job attributes if you enter a value for this attribute. |
| Organization | String | The name of the organization to which the person job belongs. You can enter either this attribute or Organization ID or both of them. You must enter the person and job attributes if you enter a value for this attribute. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| LastUpdatedBy | String | The user who last updated the record. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| Finder | String | finder |
| ProjectTemplateId | Long | projecttemplateid |
The Project Types LOV resource is used to view a project type. This object includes attributes which are used to store values of a project type.
| Name | Type | Description |
| ProjectTypeId [KEY] | Long | Unique identifier of the project type. |
| ProjectType | String | Name of the project type. |
| Description | String | Description of the project type. |
| StartDateActive | Date | Date before which the project type isn't active. |
| EndDateActive | Date | Date after which the project type isn't active. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| LastUpdatedBy | String | The user who last updated the record. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| Finder | String | finder |
The Rate Schedules resource is used to view project rate schedules and schedule lines, for schedule types of Job, Person, Nonlabor and Resource Class. Use project rate schedules to calculate costs, bill, plan, budget, and forecast amounts.
| Name | Type | Description |
| RateScheduleId [KEY] | Long | The unique identifier of the rate schedule. |
| RateScheduleName | String | Name of the rate schedule that contains rates or markup percentage for person, job, nonlabor expenditure type, nonlabor resource, and resource class. A rate schedule name is required to create a rate schedule. |
| Description | String | The description of the rate schedule. |
| ProjectRatesSetId | Long | Identifier of the reference data set for the project rates schedule. A project rates set ID or Code is required to create a rate schedule. The project rates set value can't be updated |
| ProjectRatesSetCode | String | Code of the reference data set for the project rates schedule. A project rates set ID or Code is required to create a rate schedule. Review the list of values using the Setup and Maintenance work area and the Manage Reference Data Sets task. The project rates set value can't be updated. |
| ProjectRatesSetName | String | Name of the reference data set for the project rates schedule. A project rates set is required to create a rate schedule. Review the list of values using the Setup and Maintenance work area and the Manage Reference Data Sets task. The project rates set value can't be updated. |
| ScheduleTypeCode | String | Type of rate schedule. Valid values are Person, Job, Project Role, Nonlabor, and Resource class. The schedule type is required to create a rate schedule. The value can't be updated. |
| ScheduleTypeName | String | Code for the type of rate schedule. Valid values are JOB, NONLABOR, EMPLOYEE, and RESOURCE_CLASS. The schedule type is required to create a rate schedule. The value can't be updated. |
| CurrencyCode | String | Currency code associated with the rate schedule. The currency code is a three-letter ISO code associated with a currency. A currency is required to create a rate schedule. The value can't be updated. |
| CurrencyName | String | Currency name associated with the rate schedule. |
| JobSetId | Long | Identifier of the reference data set for the jobs associated with a job rate schedule type. A job set ID or Code is required to create a rate schedule with a job schedule type. The value can't be updated. |
| JobSetCode | String | Code of the reference data set for the jobs associated with a job rate schedule type. A job set ID or Code is required to create a rate schedule with a job schedule type. The value can't be updated. |
| JobSetName | String | Name of the reference data set for the jobs associated with a job rate schedule type. A job set is required to create a rate schedule with a job schedule type. The value can't be updated. |
| CreationDate | Datetime | The date when the record was created. |
| CreatedBy | String | The user who created the record. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| Finder | String | finder |
The LOV for Rate Schedules resource is used to view a list of values of rate schedules. Rate schedules contain rates or markup percentage for person, job, nonlabor, and resource class.
| Name | Type | Description |
| RateScheduleId [KEY] | Long | The unique identifier of the rate schedule. |
| RateScheduleName | String | The name of the rate schedule. |
| Description | String | The description of the rate schedule. |
| RateScheduleTypeMeaning | String | The type of the rate schedule as job, nonlabor, person, and resource class. |
| CurrencyCode | String | The currency associated with the rate schedule. |
| JobSetId | Long | Identifier of the reference data set for the jobs associated with a job rate schedule type. |
| SetId | Long | Identifier of the reference data set to which the rate schedule is assigned. |
| RateScheduleTypeCode | String | The type of rate schedule. Values include JOB, NONLABOR, EMPLOYEE, RESOURCE_CLASS. |
| Finder | String | finder |
| SearchTerm | String | searchterm |
The operations from the Rate Schedules/Rates category.
| Name | Type | Description |
| RateSchedulesRateScheduleId [KEY] | Long | Identifier of the rate schedule. |
| Finder | String | finder |
| RateScheduleId | Long | ratescheduleid |
The operations from the Rate Schedules/Rate Schedule Descriptive Flexfields category.
| Name | Type | Description |
| RateSchedulesRateScheduleId [KEY] | Long | Identifier of the rate schedule. |
| RateScheduleId [KEY] | Long | The unique identifier of the rate schedule. |
| _FLEX_ValidationDate | Date | _FLEX_ValidationDate |
| _FLEX_Context | String | Context Prompt |
| _FLEX_NumOfSegments | Int | _FLEX_NumOfSegments |
| _FLEX_NumOfVisibleSegments | Int | _FLEX_NumOfVisibleSegments |
| Finder | String | finder |
The Resource Events resource is used to view calendar events for a resource.
| Name | Type | Description |
| EventDescription | String | Description of the calendar event. |
| EventName | String | Name of the calendar event. |
| ResourceEventId [KEY] | Long | Identifier of the resource event. |
| CreatedBy | String | Indicates the resource who created the row of data. |
| CreationDate | Datetime | Date when the row of data was created. |
| LastUpdateDate | Datetime | Date when the record was last edited. |
| LastUpdatedBy | String | Indicates who last edited the record. |
| ResourceId | Long | Identifier of the resource for which the event is created. |
| StartDate | Date | Start date of the calendar event. |
| EndDate | Date | Finish date of the calendar event. |
| ResourceName | String | Name of the resource for which the event is created. |
| ResourceCalendarName | String | Name of the calendar that defines the work schedule for the resource. |
| EventCategory | String | Category of the resource calendar event. Possible values for resources are PTO, training, or others. |
| DurationHours | Decimal | Length of the calendar event in hours. |
| ResourceEmail | String | Email of the resource for whom the event is created. |
| EventCategoryCode | String | Code that indicates the category of the resource calendar event. |
| AllDayFlag | Bool | Indicates whether the event is an All Day event. |
| BindProjectId | Long | bindprojectid |
| Finder | String | finder |
The Sprints resource is used to view sprints in Agile development. A sprint is a time-boxed activity in which a usable product increment is created.
| Name | Type | Description |
| SprintId [KEY] | Long | Unique identifier of the sprint. |
| SprintName | String | The name of the sprint. |
| StartDate | Date | The start date of the sprint. |
| EndDate | Date | The finish date of the sprint. |
| Description | String | The description of the sprint. |
| Finder | String | finder |
ValueSets
| Name | Type | Description |
| ValueSetId [KEY] | Long | The unique identifier of the value set. |
| ModuleId | String | The module ID of the value set. |
| ValueSetCode | String | The value set code identifying the value set. |
| Description | String | The description of the value set. |
| ValidationType | String | The validation type of the value set. |
| ValueDataType | String | The value data type of the value set. |
| ValueSubtype | String | The value subtype of the value set. |
| ProtectedFlag | String | Indicates if the value set is protected against updates. |
| MaximumLength | Int | The maximum permitted length for a value. |
| Precision | Int | The maximum number of digits in a value. |
| Scale | Int | The maximum number of digits permitted to the right of the decimal point. |
| UppercaseOnlyFlag | String | Indicates if the value must be in uppercase. |
| ZeroFillFlag | String | Indicates if a value must be left-padded with zeros. |
| SecurityEnabledFlag | String | Indicates if data security is enabled for this value set. |
| DataSecurityObjectName | String | The name of the data security object, if any, used to secure this value set. |
| MinimumValue | String | The minimum permitted value. |
| MinimumValueNumber | Decimal | The minimum permitted number value. |
| MinimumValueDate | Date | The minimum permitted date value. |
| MinimumValueTimestamp | Datetime | The minimum permitted time stamp value. |
| MaximumValue | String | The maximum permitted value. |
| MaximumValueNumber | Decimal | The maximum permitted number value. |
| MaximumValueDate | Date | The maximum permitted date value. |
| MaximumValueTimestamp | Datetime | The maximum permitted time stamp value. |
| IndependentValueSetId | Long | The value set ID, if any, of the independent value set. |
| IndependentValueSetCode | String | The value set code, if any, of the independent value set. |
| CreationDate | Datetime | The date when the record was created. |
| CreatedBy | String | The user who created the record. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| Finder | String | finder |
ValueSetsvalidationTable
| Name | Type | Description |
| ValueSetsValueSetId [KEY] | Long | The unique identifier of the value set. |
| ValueSetId [KEY] | Long | The unique identifier of the validation table. |
| FromClause | String | The FROM clause. |
| WhereClause | String | The WHERE clause. |
| OrderByClause | String | The ORDER BY clause, if any. |
| ValueColumnName | String | The name of the value column. |
| ValueColumnLength | Int | The length of the value column. |
| ValueColumnType | String | The data type of the value column. |
| IdColumnName | String | The name of the ID column, if any. |
| IdColumnLength | Int | The length of the ID column. |
| IdColumnType | String | The data type of the ID column. |
| DescriptionColumnName | String | The name of the description column, if any. |
| DescriptionColumnLength | Int | The length of the description column. |
| DescriptionColumnType | String | The data type of the description column. |
| EnabledFlagColumnName | String | The name of the enabled check box column, if any. |
| StartDateColumnName | String | The start date column name, if any. |
| EndDateColumnName | String | The name of the end date column, if any. |
| ValueAttributesTableAlias | String | The alias of the table containing the value attribute columns, if any. |
| CreationDate | Datetime | The date when the record was created. |
| CreatedBy | String | The user who created the record. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| Finder | String | finder |
| ValueSetCode | String | valuesetcode |
ValueSetsvalues
| Name | Type | Description |
| ValueSetsValueSetId [KEY] | Long | The unique identifier of the value set. |
| ValueId [KEY] | Long | The unique identifier of the value. |
| IndependentValue | String | The independent value. |
| IndependentValueNumber | Decimal | The independent number value. |
| IndependentValueDate | Date | The independent date value. |
| IndependentValueTimestamp | Datetime | The independent time stamp value. |
| Value | String | The value. |
| ValueNumber | Decimal | The number value. |
| ValueDate | Date | The date value. |
| ValueTimestamp | Datetime | The time stamp value. |
| TranslatedValue | String | The translated value. |
| Description | String | The description of the value. |
| EnabledFlag | String | Indicates if the value is enabled. |
| StartDateActive | Date | The first date on which the value is active, if any. |
| EndDateActive | Date | The last date on which the value is active, if any. |
| SortOrder | Long | The order in which the values should appear in the list of values. |
| SummaryFlag | String | The summary of the value. |
| DetailPostingAllowed | String | Indicates if posting is permitted for the value. |
| DetailBudgetingAllowed | String | Indicates if budget entry is permitted for the value. |
| AccountType | String | The account type of the value. |
| ControlAccount | String | The control account of the value. |
| ReconciliationFlag | String | The reconciliation indicator of the value. |
| FinancialCategory | String | The financial category of the value. |
| ExternalDataSource | String | The location of the external data source if the value is maintained externally. |
| CreationDate | Datetime | The date when the record was created. |
| CreatedBy | String | The user who created the record. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| LastUpdatedBy | String | The user who last updated the record. |
| Finder | String | finder |
| ValueSetCode | String | valuesetcode |
| ValueSetId | Long | valuesetid |
The Work Types LOV resource is used to view a work type. This object includes attributes which are used to store values of a work type.
| Name | Type | Description |
| Name | String | Name of the work type. |
| Description | String | Description of the work type. |
| StartDateActive | Date | Date from which the work type is active. |
| EndDateActive | Date | Date after which the work type isn't active. |
| WorkTypeId [KEY] | Long | Unique identifier of the work type. |
| CreatedBy | String | The user who created the record. |
| CreationDate | Datetime | The date when the record was created. |
| LastUpdatedBy | String | The user who last updated the record. |
| LastUpdateDate | Datetime | The date when the record was last updated. |
| ActiveDate | Date | activedate |
| Finder | String | finder |
| ProjectUnitId | Long | projectunitid |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| URL | The URL of the Oracle Fusion Cloud Financials account that you want to connect to. Typically, this is the URL of your Oracle Cloud service. |
| User | Specifies the user ID of the authenticating Oracle Fusion Cloud Financials user account. |
| Password | Specifies the password of the authenticating user account. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Property | Description |
| APIVersion | The Oracle Fusion Cloud Financials API version the provider uses to retrieve data. |
| IncludeCustomChildObjects | Whether the provider exposes custom child objects as views. |
| IncludeCustomObjects | Whether the provider exposes custom objects as views. |
| MaxRows | Specifies the maximum rows returned for queries without aggregation or GROUP BY. |
| Other | Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property. |
| RowScanDepth | The maximum number of rows to scan to look for the columns available in a table. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| URL | The URL of the Oracle Fusion Cloud Financials account that you want to connect to. Typically, this is the URL of your Oracle Cloud service. |
| User | Specifies the user ID of the authenticating Oracle Fusion Cloud Financials user account. |
| Password | Specifies the password of the authenticating user account. |
The URL of the Oracle Fusion Cloud Financials account that you want to connect to. Typically, this is the URL of your Oracle Cloud service.
You can find this URL in the welcome email sent to your Oracle Cloud service administrator.
For example, https://servername.fa.us2.oraclecloud.com.
Specifies the user ID of the authenticating Oracle Fusion Cloud Financials user account.
The authenticating server requires both User and Password to validate the user's identity.
Specifies the password of the authenticating user account.
The authenticating server requires both User and Password to validate the user's identity.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
| Description | Example |
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
The following table provides port number information for each of the supported protocols.
| Protocol | Default Port | Description |
| TUNNEL | 80 | The port where the Sync App opens a connection to Oracle Fusion Cloud Financials. Traffic flows back and forth via the proxy at this location. |
| SOCKS4 | 1080 | The port where the Sync App opens a connection to Oracle Fusion Cloud Financials. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted. |
| SOCKS5 | 1080 | The port where the Sync App sends data to Oracle Fusion Cloud Financials. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the TCP port to be used for a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Identifies the user ID of the account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the password of the user account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).
This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
The hostname or IP address of the proxy server that you want to route HTTP traffic through.
The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.
The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.
For other proxy types, see FirewallType.
Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
The authentication type can be one of the following:
For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
The username of a user account registered with the proxy server specified in the ProxyServer connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyUser |
| BASIC | The user name of a user registered with the proxy server. |
| DIGEST | The user name of a user registered with the proxy server. |
| NEGOTIATE | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NTLM | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NONE | Do not set the ProxyPassword connection property. |
The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.
The password associated with the user specified in the ProxyUser connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyPassword |
| BASIC | The password associated with the proxy server user specified in ProxyUser. |
| DIGEST | The password associated with the proxy server user specified in ProxyUser. |
| NEGOTIATE | The password associated with the Windows user account specified in ProxyUser. |
| NTLM | The password associated with the Windows user account specified in ProxyUser. |
| NONE | Do not set the ProxyPassword connection property. |
For SOCKS 5 authentication or tunneling, see FirewallType.
The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.
The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :
| AUTO | Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.
For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.
The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.
For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.
Note: Since this Sync App supports multiple schemas, custom schema files for Oracle Fusion Cloud Financials should be structured such that:
Location should always be set to the parent folder, and not to an individual schema's folder.
If left unspecified, the default location is %APPDATA%\\CData\\OracleERP Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:
| Platform | %APPDATA% |
| Windows | The value of the APPDATA environment variable |
| Linux | ~/.config |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.
If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.
If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| APIVersion | The Oracle Fusion Cloud Financials API version the provider uses to retrieve data. |
| IncludeCustomChildObjects | Whether the provider exposes custom child objects as views. |
| IncludeCustomObjects | Whether the provider exposes custom objects as views. |
| MaxRows | Specifies the maximum rows returned for queries without aggregation or GROUP BY. |
| Other | Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property. |
| RowScanDepth | The maximum number of rows to scan to look for the columns available in a table. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file. |
The Oracle Fusion Cloud Financials API version the provider uses to retrieve data.
The default is "latest", which means the Sync App uses the most recent API version.
Whether the provider exposes custom child objects as views.
If True, the Sync App exposes custom child objects, added via the Application Composer, as views. This includes custom child objects associated with both standard and custom objects.
Whether the provider exposes custom objects as views.
If True, the Sync App exposes custom objects, added via the Application Composer, as views.
Specifies the maximum rows returned for queries without aggregation or GROUP BY.
This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.
When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.
Note: It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.
Specify multiple properties in a semicolon-separated list.
| DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
| ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
This property allows you to define which pseudocolumns the Sync App exposes as table columns.
To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"
To include all pseudocolumns for all tables use: "*=*"
The maximum number of rows to scan to look for the columns available in a table.
The columns in a table must be determined by scanning table rows. This value determines the maximum number of rows that will be scanned.
Setting a high value may decrease performance. Setting a low value may prevent the data type from being determined properly, especially when there is null data.
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.
The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.
Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view. For example:
{
"MyView": {
"query": "SELECT * FROM Invoices WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.
Refer to User Defined Views for more information.