XOG: Financial Transaction

ccppmop1561
Use the financial transaction XOG object to view inbound and outbound financial transaction attributes for investments. This XOG object exports WIP transactions from PPA_WWP table so that the data can be imported into an ERP or other enterprise system.
Schema Name
nikuxog_commonTransaction.xsd
Read and Write XML Files
The following XML files are included:
  • imp_transactions_read.xml. Use this file to export financial transaction attributes for investments from 
    Clarity PPM
    .
  • imp_transactions_write.xml. Use this file to import financial transaction attributes for investments that were previously exported from 
    Clarity PPM
    .
Prerequisites
Before you use this XOG object, verify that all foreign key references of the financial transaction (for example, resource, investment, and others) have been defined.
Business Rules and Processing
The following business rules and processing apply to this XOG object:
  • The XOG processes WIP transactions that are based on the following fields:
    • transactionType
      Defines the financial transaction type.
      Values:
      L, M, X, or Q.
    • projectID
      The valid project ID.
    • clientID
      The valid company ID.
    • transactionDate
      Enter Start Date, and End Date to get transaction data for all projects between the dates specified.
  • And and Or processing is supported among these fields.
  • Transactions on hold or in error are not processed.
  • Once a transaction is exported, XOG_EXPORTED is flagged and EXPORTED_DATE is stamped with the time and date in the PPA_WIP and PPA_BILLINGS tables. For adjustments and reversals, a negative amount is exported (or a positive amount if the posting was negative).
Read Filters
None
Schema Mappings
The schema mappings are provided for the following Financial Transaction tag names.
Transactions Schema Tag
This tag is part of the schema mapping for the Financial Transaction XOG object. It has the following attributes:
  • transactionID
    Required. The transaction identifier. It must be unique.
    Table and Column:
    TRANSNO
    Type:
    Number
  • applyToTransactionID
    Optional. If the transaction is an adjusted, reversed, or transferred transaction, then applyToTransactionID refers to the parent transaction. Otherwise this field is not public.
    Table and Column:
    APPLYTO
    Type:
    Number
  • clientID
    Required. The company identifier.
    Table and Column:
    COMPANY_CODE
    Type:
    String
  • clientName
    Required. Derived from company ID.
    Table and Column:
    CLNTSUPP.COMPANY_NAME
    Type:
    String
  • projectID
    Required. The project identifier.
    Table and Column:
    PROJECT_CODE
    Type:
    String
  • projectName
    Required. Derived from project ID
    Table and Column:
    SRM_PROJECTS.NAME
    Type:
    String
  • taskID
    Optional. A valid task identifier.
    Table and Column:
    TASK_ID
    Type:
    Number
  • taskName
    Optional. Derived from task ID.
    Table and Column:
    PRTASK. PRNAME
    Type:
    String
  • transactionDate
    Required. The date of the transaction.
    Table and Column:
    TRANSDATE
    Type:
    Date
  • resourceID
    Required. The resource identifier.
    Table and Column:
    RESOURCE_CODE
    Type:
    String
  • resourceName
    Required. Derived from resource ID.
    Table and Column:
    SRM_RESOURCES.FULL_NAME
    Type:
    String
  • roleID
    Optional. The role identifier.
    Table and Column:
    ROLE_CODE
    Type:
    String
  • transactionType
    Required. The transaction type.
    Table and Column:
    TRANSTYPE
    Type:
    String
  • chargeCode
    Required. A valid charge code.
    Table and Column:
    COSTCODE
    Type:
    String
  • inputTypeCode
    Optional. Valid input type code
    Table and Column:
    INPUT_TYPE
    Type:
    String
  • chargeable
    Required. Indicates if the transaction can be charged to the company.
    Values:
    • 0. Not chargeable
    • 1. chargeable
    Table and Column:
    CHARGEABLE
    Type:
    Number
  • units
    Required. The number of units.
    Table and Column:
    QUANTITY
    Type:
    Number
  • CurrencyValue ->actualCostRate
    Required.
    Table and Column:
    PPA_WIP_VALUES.ACTUALCOST
    Type:
    Number
  • CurrencyValue ->actualCostRateCurrency
    Required. Currency code for actual cost rate
    Table and Column:
    PPA_WIP_VALUES.COST_CURRENCY_CODE
    Type:
    String
  • CurrencyValue ->stdCostRate
    Required. The cost rate per unit.
    Table and Column:
    PPA_WIP_VALUES.STDCOST
    Type:
    Number
  • CurrencyValue ->stdCostRateCurrency
    Optional. The cCurrency code for standard cost rate.
    Table and Column:
    PPA_WIP_VALUES.STDCOST_CURRENCY_CODE
    Type:
    String
  • CurrencyValue ->billRate
    Required. The billing rate per unit.
    Table and Column:
    PPA_WIP_VALUES.BILLRATE
    Type:
    Number
  • CurrencyValue ->billRateCurrency
    Required. The currency code for bill rate.
    Table and Column:
    PPA_WIP_VALUES.RATE_CURRENCY_CODE
    Type:
    String
  • CurrencyValue-> currencyType
    Required. Indicates the currency transaction in the values table. This picks up the HOME, BILLING & NATURAL transaction lines.
    Table and Column:
    PPA_WIP_VALUES.CURRENCY_TYPE
    Type:
    String
  • CurrencyValue ->totalCost
    Required. The ActualCost x quantity.
    Table and Column:
    PPA_WIP_VALUES.TOTALCOST
    Type:
    Number
  • CurrencyValue ->totalAmount
    Required. The (BillRate x quantity) + Factor + Burden + Overhead
    Table and Column:
    PPA_WIP_VALUES.TOTALAMOUNT
    Type:
    String
  • vendorCode
    Optional. The vendor code that is associated with the transaction.
    Table and Column:
    PPA_WIP_APINFO.VENDOR_CODE
    Type:
    String
  • notes
    Optional. Additional information.
    Table and Column:
    NOTES
    Type:
    String
  • transactionStatus
    Required. The status of the transaction.
    Values:
    • 0. Normal
    • 1. Adjusted
    • 2. Reversed
    • 4. Under-adjust
    • 8. Under-bill
    Table and Column:
    STATUS
    Type:
    Number
  • CurrencyValue ->amountRemaining
    Required. The Total Amount - Amount Billed.
    Table and Column:
    PPA_WIP_VALUES.AMOUNTREMAINING
    Type:
    Number
  • userLov1
    Optional. Refers to PRTIMEENTRY_USERLOV1.
    Table and Column:
    USER_LOV1
    Type:
    String
  • userLov2
    Optional. Refers to PRTIMEENTRY_USERLOV2.
    Table and Column:
    USER_LOV2
    Type:
    String
  • expenseType
    Optional. Either CAPITAL_EXPENDITURE or DEPRECIATION.
    Table and Column:
    EXPENSE_TYPE
    Type:
    String
Transaction Import Schema Tag
The transaction import tag is part of the schema mapping for the Financial Transaction XOG object. It has the following attributes:
  • externalID
    Required. The external identifier. The value must be unique.
    Table and Column:
    EXTERNALID
    Type:
    String
  • clientID
    Optional. The valid company ID. If the client ID is empty, the value is taken from the project.
    Table and Column:
    COMPANY_CODE
    Type:
    String
  • projectID
    Required. The valid project ID.
    Table and Column:
    PROJECT_CODE
    Type:
    String
  • taskID
    Required. The valid internal task ID.
    Table and Column:
    TASKID
    Type:
    Number
  • transactionDate
    Required. The date of the transaction. It must be between the project start and end dates.
    Table and Column:
    TRANSDATE
    Type:
    Date
  • resourceID
    Optional. The resource ID associated with the transaction, when applicable. Otherwise, the resource ID from Cost Key Definition default.
    Table and Column:
    RESOURCE_CODE
    Type:
    String
  • roleID
    Optional. The valid role identifier.
    Table and Column:
    ROLE_CODE
    Type:
    String
  • transactionType
    Required. Defines the transaction type.
    Values:
    L, M, X, and Q
    Table and Column:
    TRANSTYPE
    Type:
    String
  • chargeCode
    Optional. A valid charge code.
    Table and Column:
    CHARGE_CODE
    Type:
    String
  • inputTypeCode
    Optional. A valid input type.
    Table and Column:
    INPUT_TYPE
    Type:
    String
  • Chargeable
    Optional. Indicates if the transaction is chargeable to the company.
    Values:
    • 0. Not chargeable
    • 1. chargeable
    Default:
    0
    Table and Column:
    CHARGEABLE
    Type:
    Number
  • Units
    The number of units (for all expense transactions). Not required for expense transactions, but required for all other transaction types.
    Values:
    L, M, and Q (Quantity)
    Table and Column:
    QUANTITY
    Type:
    Number
  • actualCostRate
    Optional. Cost rate per unit. It must be a valid number. If not specified, the cost is taken from the rate matrix.
    Table and Column:
    PPA_WIP_VALUES.ACTUALCOST
    Type:
    Number
  • actualCostRateCurrency
    Optional. ISO currency code for actual cost rate.
    Table and Column:
    PPA_WIP_VALUES.COST_CURRENCY_CODE
    Type:
    String
  • BillRate
    Optional. The billing rate per unit; must be a valid number. If not specified, the rate is picked up from the rate matrix.
    Table and Column:
    RATE
    Type:
    Number
  • billRateCurrency
    Optional. ISO currency code for the bill rate.
    Table and Column:
    RATE_CURRENCY
    Type:
    String
  • notes
    Optional. Additional information.
    Table and Column:
    NOTES
    Type:
    String
  • importStatus
    Optional. The allowed value is N for New.
    Table and Column:
    IMPORTSTATUS
    Type:
    String
  • importDate
    Optional. The date the transaction was imported. If not specified, the current server date is used.
    Table and Column:
    IMPORTDATE
    Type:
    Date