Get a project contract revenue

get

/fscmRestApi/resources/11.13.18.05/projectContractRevenue/{projectContractRevenueUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Project Contract Revenue resource and used to uniquely identify an instance of Project Contract Revenue. The client should not generate the hash key value. Instead, the client should query on the Project Contract Revenue collection resource in order to navigate to a specific instance of Project Contract Revenue to get the hash key.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : projectContractRevenue-item-response
Type: object
Show Source
  • Title: Associated Task Name
    Read Only: true
    Maximum Length: 255
    Name of the task that is linked to the contract line associated to the revenue distribution.
  • Title: Associated Task Number
    Read Only: true
    Maximum Length: 100
    A unique number that identifies the task in the task hierarchy that is at or above the level of the task recorded on the transaction and is associated with the contract for which revenue is recognized.
  • Title: Billing Resource
    Read Only: true
    Maximum Length: 240
    This is the name of the Billing Resource for the billing event or expenditure item from the billing event or expenditure item.
  • Title: Billing Resource ID
    Read Only: true
    Unique identifier of resource breakdown structure element.
  • Title: Billing Type Code
    Read Only: true
    Maximum Length: 30
    Indicates the code used to identify which billing type of the contract the revenue distribution uses to recognize revenue. Valid values are EX - External, IC - Intercompany, IP - Interproject.
  • Title: Bill Job ID
    Read Only: true
    Unique identifier of the bill job used when recording revenue for a labor item.
  • Title: Bill Rate in Bill Transaction Currency
    Read Only: true
    Bill rate in the currency of the bill transaction.
  • Title: Bill Transaction Number
    Read Only: true
    Number that uniquely identifies a billing transaction that is the source of this revenue distribution.
  • Title: Bill Transaction Type Code
    Read Only: true
    Maximum Length: 30
    Indicates the code used to classify the type of bill transaction. Valid values are EI - Expenditure Item or EVT - Billing Event.
  • Title: Business Unit
    Read Only: true
    Maximum Length: 240
    Name of the business unit associated with the revenue distribution.
  • Title: Business Unit ID
    Read Only: true
    Unique identifier of the business unit associated to the revenue distribution.
  • Title: Revenue in Contract Currency
    Read Only: true
    Indicates the amount in the contract currency.
  • Title: Contract Currency Conversion Date
    Read Only: true
    Indicates the date used for the conversion of the rates on the contract used for the revenue distribution.
  • Title: Contract Currency Conversion Rate
    Read Only: true
    Indicates the rate used to convert the revenue distribution amounts from the transaction currency to the contract currency.
  • Title: Contract Currency Conversion Rate Type
    Read Only: true
    Maximum Length: 30
    Indicates a classification of conversion rates used to convert the transaction amounts to the contract currency.
  • Title: Contract Currency
    Read Only: true
    Maximum Length: 30
    Indicates the code of the currency for the contract related to the revenue distribution.
  • Title: Contract ID
    Read Only: true
    Unique identifier of the contract for the revenue distribution.
  • Title: Contract Line ID
    Read Only: true
    Unique identifier of the contract line related to the revenue distribution.
  • Title: Contract Line Number
    Read Only: true
    Maximum Length: 150
    Number that identifies the contract line related to the revenue distribution.
  • Title: Contract Number
    Read Only: true
    Maximum Length: 120
    Number that uniquely identifies the contract for the revenue distribution.
  • Title: Contract Currency Conversion Date Type
    Read Only: true
    Maximum Length: 30
    Indicates the date type of the contract currency.
  • Title: Burdened Cost Amount in Bill Transaction Currency
    Read Only: true
    Indicates the burdened cost in the ledger currency of the provider business unit for inter company revenue distributions.
  • Title: Raw Cost Amount in Bill Transaction Currency
    Read Only: true
    Indicates the raw cost of the transaction in the ledger currency of the provider business unit for inter company revenue distributions.
  • Title: Document Number
    Read Only: true
    Maximum Length: 240
    Number that identifies a document on the revenue plan of a grants contract.
  • Title: Event Number
    Read Only: true
    Number that identifies an event if the revenue distribution is based on a billing event.
  • Title: Expenditure Type Class
    Read Only: true
    Maximum Length: 80
    A classification of the expenditure type of the expenditure item that was recognized for revenue.
  • Title: Accounting Date
    Read Only: true
    The date within a General Ledger (GL) accounting period to which the revenue transactions are posted.
  • Title: Accounting Period
    Read Only: true
    Maximum Length: 30
    Name of the General Ledger (GL) period for the GL Date attribute.
  • Title: Intercompany Transfer Price Amount Type
    Read Only: true
    Maximum Length: 30
    Indicates the intercompany transfer price amount type of an intercompany transfer revenue distribution.
  • Title: Intercompany Transfer Price Base
    Read Only: true
    Maximum Length: 30
    Indicates the intercompany transfer price base code of an intercompany transfer revenue distribution.
  • Title: Invoice Method Labor Schedule Type
    Read Only: true
    Maximum Length: 30
    Indicates the code of the type used to classify invoice method labor schedule as defined on the related bill plan.
  • Title: Invoice Method Nonlabor Schedule Type
    Read Only: true
    Maximum Length: 30
    Indicates the invoice method for a nonlabor schedule type.
  • Title: Invoice Date
    Read Only: true
    Indicates the invoice date for the invoice related to the revenue distribution.
  • Title: Revenue Method Labor Schedule Type
    Read Only: true
    Maximum Length: 80
    The type of labor schedule (namely bill rate, burden, or transfer price) from the revenue method used to determine revenue amounts on revenue distributions.
  • Title: Ledger Currency
    Read Only: true
    Maximum Length: 30
    The currency used for accounting and reporting in a ledger, often referred to as the accounting currency, base currency, or functional currency.
  • Title: Revenue in Ledger Currency
    Read Only: true
    Indicates the revenue amount in the ledger currency.
  • Title: Ledger Currency Conversion Date
    Read Only: true
    Indicates the conversion date used to convert the revenue distribution to the ledger currency.
  • Title: Ledger Currency Conversion Rate
    Read Only: true
    Indicates the conversion currency rate used to convert the revenue distribution to the ledger currency.
  • Title: Ledger Currency Conversion Rate Type
    Read Only: true
    Maximum Length: 30
    Indicates the conversion currency rate type used to convert the revenue distribution to the ledger currency.
  • Title: Ledger ID
    Read Only: true
    Unique identifier of the ledger associated to the revenue distribution.
  • Title: Ledger Currency Conversion Date Type
    Read Only: true
    Maximum Length: 30
    Indicates the currency conversion date type used to convert the revenue distribution to the ledger currency.
  • Title: Line Number
    Read Only: true
    A line identifier on a revenue distribution.
  • Title: Line Number Reversed
    Read Only: true
    Maximum Length: 20
    The line number of the original revenue distribution line being reversed by this revenue distribution line.
  • Title: Associated Project ID
    Read Only: true
    Indicates the unique identifier of project that is linked to contract and related to the revenue distribution.
  • Title: Linked Task ID
    Read Only: true
    Indicates the unique identifier of task that is linked to contract and related to the revenue distribution.
  • Links
  • Title: LOC Number
    Read Only: true
    Maximum Length: 240
    Indicates the Letter of Credit Number when the revenue distribution is related to a grants contract bill plan.
  • Title: Nonlabor Organization ID
    Read Only: true
    Unique identifier for the organization related to nonlabor revenue distributions.
  • Title: Nonlabor Resource ID
    Read Only: true
    Unique identifier for the resource related to nonlabor revenue distributions.
  • Title: Revenue Method Nonlabor Schedule Type
    Read Only: true
    Maximum Length: 80
    The type of nonlabor schedule (namely bill rate, burden, or transfer price) from the revenue method used to determine revenue amounts on revenue distributions.
  • Title: Project Accounting Date
    Read Only: true
    Indicates the date used for the project accounting.
  • Title: Project Accounting Period
    Read Only: true
    Maximum Length: 30
    Indicates the period name used for the project accounting.
  • Title: Person ID
    Read Only: true
    Unique identifier of the Person related to the revenue distribution.
  • Title: Project Currency
    Read Only: true
    Maximum Length: 30
    Indicates the currency code of the project.
  • Title: Project Currency Conversion Date
    Read Only: true
    Indicates the currency conversion date used to convert the revenue distribution to the project currency.
  • Title: Project Currency Conversion Rate
    Read Only: true
    Indicates the currency conversion rate used to convert the revenue distribution to the project currency.
  • Title: Project Currency Rate Type
    Read Only: true
    Maximum Length: 30
    Indicates the currency conversion rate type used to convert the revenue distribution to the project currency.
  • Title: Revenue in Project Currency
    Read Only: true
    Indicates the amount of the revenue distribution in the currency of the project.
  • Title: Project Linkage ID
    Read Only: true
    Unique identifier of the linkage used to identify the contract related to the revenue distribution.
  • Title: Project Name
    Read Only: true
    Maximum Length: 240
    The name assigned to a project recorded on the unprocessed revenue event.
  • Title: Project Number
    Read Only: true
    Maximum Length: 25
    Indicates the number for the project linked to the contract.
  • Title: Project Currency Conversion Date Type
    Read Only: true
    Maximum Length: 30
    Indicates the currency conversion date type used to convert the revenue distribution to the project currency.
  • Title: Provider Legal Entity ID
    Read Only: true
    Unique identifier of the provider legal entity for intercompany revenue distributions.
  • Title: Quantity
    Read Only: true
    Indicates the quantity of the source expenditure item for revenue distributions created from expenditure items.
  • Title: Receiver Legal Entity ID
    Read Only: true
    Unique identifier of the receiver legal entity.
  • Title: Revenue Amount Calculation Code
    Read Only: true
    Maximum Length: 30
    Indicates the code for the revenue amount calculation. Valid values are I - Indirect, O - Overrides, E - Extension, B - Bill rates, L - Labor Multiplier.
  • Title: Revenue Burden Compile Set ID
    Read Only: true
    Unique identifier of the compiled set used to calculate a burden schedule.
  • Title: Revenue Category Code
    Read Only: true
    Maximum Length: 30
    Indicates the revenue category code for the revenue distribution.
  • Title: Revenue Category
    Read Only: true
    Maximum Length: 80
    Indicates the meaning of the Revenue Category Code attribute that represents a grouping of expenditure types by type of revenue. For example, a revenue category with a name such as Labor refers to labor revenue.
  • Title: Revenue in Revenue Currency
    Read Only: true
    Indicates the revenue amount in the currency of the revenue distribution.
  • Title: Revenue Currency
    Read Only: true
    Maximum Length: 30
    Indicates the code for the currency of the revenue distribution.
  • Title: Revenue Currency Conversion Rate Type
    Read Only: true
    Maximum Length: 30
    The source of a currency conversion rate type, such as user defined, spot, or corporate, used to convert revenue amount from bill transaction currency into revenue currency.
  • Title: Revenue Currency Conversion Date Type
    Read Only: true
    Maximum Length: 30
    The revenue currency conversion date type used to calculate the revenue currency.
  • Title: Revenue Currency Conversion Date
    Read Only: true
    The currency conversion exchange date used to calculate the revenue currency.
  • Title: Revenue Currency Conversion Rate
    Read Only: true
    The source of a currency conversion rate, such as user defined, spot, or corporate, used to convert revenue amount from bill transaction currency into revenue currency.
  • Title: Revenue Currency Conversion Rate Type
    Read Only: true
    Maximum Length: 30
    The source of a currency conversion rate type, such as user defined, spot, or corporate, used to convert revenue amount from bill transaction currency into revenue currency.
  • Title: Discount Percentage
    Read Only: true
    Indicates a discount percentage, expressed as a proportion multiplied by 100, that is used to calculate the adjusted revenue and rate.
  • Title: Revenue Discount Reason Code
    Read Only: true
    Maximum Length: 30
    Reason code for discount override or rate override.
  • Title: Revenue Distribution Number
    Read Only: true
    Unique identifier of the revenue distribution.
  • Title: Revenue Incremental Percentage
    Read Only: true
    Indicates the incremental percentage the revenue distribution.
  • Title: Labor Multiplier
    Read Only: true
    A multiplier that is assigned to a contract line, and is used to calculate the revenue amount for labor items by applying the multiplier to the raw cost of the labor items.
  • Title: Revenue Labor Rate Type Code
    Read Only: true
    Maximum Length: 30
    Indicates the code of the type used to classify revenue labor rates.
  • Title: Revenue Nonlabor Rate Type Code
    Read Only: true
    Maximum Length: 30
    Indicates the code for the revenue nonlabor rate type.
  • Title: Revenue Plan ID
    Read Only: true
    Unique identifier of the revenue plan.
  • Title: Revenue Rate Source ID
    Read Only: true
    Unique identifier of the revenue rate source used for bill rate derivation. It stores the rate schedule id of bill rate schedule was used, or the override id if override used.
  • Title: Revenue Rate Source Type Code
    Read Only: true
    Maximum Length: 30
    Indicates the code of the type used to classify the revenue rate sources.
  • Title: Revenue Recognized
    Read Only: true
    Maximum Length: 1
    Indicates if the expenditure item or event is partially or fully recognized.
  • Title: Reversed
    Read Only: true
    Maximum Length: 1
    Indicates whether this revenue distribution was reversed.
  • Title: Reversed Distribution Number
    Read Only: true
    Unique identifier of the reversed revenue distribution if the revenue distribution is a reversal distribution.
  • Title: Subledger Accounting Event ID
    Read Only: true
    The system-generated number assigned to a subledger accounting event. You create accounting events for transactions that have a financial accounting impact.
  • Title: Task Name
    Read Only: true
    Maximum Length: 255
    Indicates the name of the task for which the revenue distribution applies.
  • Title: Task Number
    Read Only: true
    Maximum Length: 100
    The number assigned to a task associated with a contract line.
  • Title: Transfer Price Base Amount
    Read Only: true
    Indicates the basis amount for the transfer price calculation from the transfer price rule used to create an intercompany revenue distribution.
  • Title: Transfer Price Revenue Rule Percentage
    Read Only: true
    Indicates the applied percentage value from the transfer price rule used to create an intercompany revenue distribution.
  • Title: Transfer Price Revenue Schedule Line Percentage
    Read Only: true
    Indicates the applied percentage value from the transfer price schedule line used to create an intercompany revenue distribution.
  • Title: Bill Transaction Currency
    Read Only: true
    Maximum Length: 30
    Indicates the code of the currency used to bill transactions. The bill transaction currency for expenditure items is the bill rate currency if a bill rate schedule is used to derive rates. If a burden rate schedule is used to derive rates, the bill transaction currency is the cost transaction currency.
  • Title: Revenue in Bill Transaction Currency
    Read Only: true
    The amount of revenue in bill transaction currency.
  • Title: Transaction Date
    Read Only: true
    Indicates the expenditure item or event date when transaction occurs for this revenue
  • Title: Transaction ID
    Read Only: true
    Unique identifier of the expenditure item or event that is revenue distributed by the distribution line.
  • Title: Transaction Project ID
    Read Only: true
    Unique identifier of project for the revenue distribution.
  • Title: Transaction Task ID
    Read Only: true
    Unique identifier of transaction task for the revenue distribution.
  • Title: Transaction Type
    Read Only: true
    Maximum Length: 80
    Indicates whether the transaction that created a revenue distribution is an expenditure item or an event. Valid values include Expenditure Item or Event.
  • Title: Transaction Type ID
    Read Only: true
    Unique identifier of Event Type or Expenditure Item Type for the revenue distribution.
  • Title: Version
    Read Only: true
    Version number of contract when the revenue distribution was created.
Back to Top

Examples

The following example shows how to get a project contract revenue by submitting a GET request on the REST resource using cURL.

curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractRevenue/100010033099998

Response Body Example

The following shows an example of the response body in JSON format.

{
"RevenueDistributionId": 100010033099998,
"BusinessUnit": "Vision Operations",
"ContractNumber": "zBI_revcon2",
"ContractLineNumber": "Line1",
"ProjectName": "zBI_Projrev-02",
"ProjectNumber": "zBI_Projrev-02",
"AssociatedTaskName": null,
"AssociatedTaskNumber": null,
"TaskNumber": "1.1",
"TaskName": "Project Kickoff",
"EventNumber": null,
"ContractLineId": 100000015235306,
"ContractId": 100000015235298,
"BillTransactionTypeCode": "EI",
"BillJobId": 29,
"BillRate": 50,
"BillTransactionId": 100010033099999,
"BillingTypeCode": "EX",
"ContCurrencyRevenueExchgDate": null,
"ContCurrencyRevenueExchgRate": 1,
"ContCurrencyRevenueRateType": null,
"ContCurrencyRevenueAmount": 2500,
"ContractCurrencyCode": "USD",
"ProjectLinkageId": 100000015235308,
"ContractRateDateType": "TRANSACTION",
"DenomBurdenCost": 1725,
"DenomRawCost": 1250,
"DocumentNumber": null,
"GlDate": "2010-03-25",
"GlPeriodName": "Mar-10",
"ICTpAmountTypeCode": null,
"ICTpBaseCode": null,
"InvLaborRateTypeCode": null,
"InvNlRateTypeCode": null,
"InvoiceDate": null,
"LedgerCurrencyRevenueExchgDate": null,
"LedgerCurrencyRevenueExchgRate": 1,
"LedgerCurrencyRevenueRateType": null,
"LedgerCurrencyRevenueAmount": 2500,
"LedgerCurrencyCode": "USD",
"LedgerId": 1,
"LedgerRateDateType": "TRANSACTION",
"LineNumber": 1,
"LineNumberReversed": null,
"LinkedProjectId": 100000015136283,
"LinkedTaskId": null,
"Version": 1,
"LocNumber": null,
"NonLaborOrgId": null,
"NonLaborResourceId": null,
"BusinessUnitId": 204,
"PaDate": "2010-03-25",
"PaPeriodName": "MAR-W4-10",
"PersonId": 4384,
"ProjectCurrencyExchgRate": 1,
"ProjectCurrencyRateType": null,
"ProjectCurrencyRevenueAmount": 2500,
"ProjectCurrencyCode": "USD",
"ProjectCurrencyExchgDate": null,
"ProjectRateDateType": null,
"PrvdrLegalEntityId": 204,
"Quantity": 50,
"BillingResourceId": 100010023981323,
"RecvrLegalEntityId": 204,
"RevenueBurdenCompileSetId": null,
"RevenueDiscountReasonCode": null,
"RevenueIncrementalPercentage": 100,
"RevenueLaborRateTypeCode": "BILL_RATE",
"RevenueNlRateTypeCode": "BILL_RATE",
"RevenueRateSourceTypeCode": null,
"RevenueAmountCalculationCode": "B",
"RevenueCategoryCode": "Labor",
"RevenueCurrencyAmount": 2500,
"RevenueCurrencyDateType": "TRANSACTION",
"RevenueCurrencyExchgDate": null,
"RevenueCurrencyExchgRate": 1,
"RevenueCurrencyRateType": null,
"RevenueCurrencyCode": "USD",
"RevenueDiscountPercentage": null,
"RevenueLaborMultiplier": null,
"RevenuePlanId": 100000015235305,
"RevenueRateSourceId": 100000010146226,
"RevenueRecognized": "F",
"Reversed": null,
"ReversedRevenueDistributionId": null,
"SlaEventId": null,
"TpBaseAmount": null,
"TpRevenueRulePercentage": null,
"TpRevenueSchLinePercentage": null,
"TransactionTypeId": 10009,
"TransactionDate": "2010-03-25",
"TransactionId": 7680619,
"TransactionProjectId": 100000015136283,
"TransactionTaskId": 100000015136315,
"TransactionCurrencyRevenueAmount": 2500,
"TransactionCurrencyCode": "USD",
"RevenueCategoryMeaning": "Labor",
"ExpenditureType": "Straight Time",
"TransactionType": "Expenditure item",
"LaborScheduleType": "Bill rate",
"NonLaborScheduleType": "Bill rate",
"RevenueCurrencyConvType": null,
"BillingResource": "Labor"
}
Back to Top