Jump to

• Request
• Response
• Examples

Get all project contract revenues

get

/fscmRestApi/resources/11.13.18.05/projectContractRevenue

Request

Query Parameters

• expand: string
  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).
• fields: string
  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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds the project contract revenue with the specified primary key.
    Finder Variables:
    • RevenueDistributionId; integer; Unique identifier of the revenue distribution.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AssociatedTaskName; string; Name of the task that is linked to the contract line associated to the revenue distribution.
  • AssociatedTaskNumber; string; 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.
  • BillJobId; integer; Unique identifier of the bill job used when recording revenue for a labor item.
  • BillRate; number; Bill rate in the currency of the bill transaction.
  • BillTransactionId; integer; Number that uniquely identifies a billing transaction that is the source of this revenue distribution.
  • BillTransactionTypeCode; string; Indicates the code used to classify the type of bill transaction. Valid values are EI - Expenditure Item or EVT - Billing Event.
  • BillingResource; string; This is the name of the Billing Resource for the billing event or expenditure item from the billing event or expenditure item.
  • BillingResourceId; integer; Unique identifier of resource breakdown structure element.
  • BillingTypeCode; string; 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.
  • BusinessUnit; string; Name of the business unit associated with the revenue distribution.
  • BusinessUnitId; integer; Unique identifier of the business unit associated to the revenue distribution.
  • ContCurrencyRevenueAmount; number; Indicates the amount in the contract currency.
  • ContCurrencyRevenueExchgDate; string; Indicates the date used for the conversion of the rates on the contract used for the revenue distribution.
  • ContCurrencyRevenueExchgRate; number; Indicates the rate used to convert the revenue distribution amounts from the transaction currency to the contract currency.
  • ContCurrencyRevenueRateType; string; Indicates a classification of conversion rates used to convert the transaction amounts to the contract currency.
  • ContractCurrencyCode; string; Indicates the code of the currency for the contract related to the revenue distribution.
  • ContractId; integer; Unique identifier of the contract for the revenue distribution.
  • ContractLineId; integer; Unique identifier of the contract line related to the revenue distribution.
  • ContractLineNumber; string; Number that identifies the contract line related to the revenue distribution.
  • ContractNumber; string; Number that uniquely identifies the contract for the revenue distribution.
  • ContractRateDateType; string; Indicates the date type of the contract currency.
  • DenomBurdenCost; number; Indicates the burdened cost in the ledger currency of the provider business unit for inter company revenue distributions.
  • DenomRawCost; number; Indicates the raw cost of the transaction in the ledger currency of the provider business unit for inter company revenue distributions.
  • DocumentNumber; string; Number that identifies a document on the revenue plan of a grants contract.
  • EventNumber; integer; Number that identifies an event if the revenue distribution is based on a billing event.
  • ExpenditureType; string; A classification of the expenditure type of the expenditure item that was recognized for revenue.
  • GlDate; string; The date within a General Ledger (GL) accounting period to which the revenue transactions are posted.
  • GlPeriodName; string; Name of the General Ledger (GL) period for the GL Date attribute.
  • ICTpAmountTypeCode; string; Indicates the intercompany transfer price amount type of an intercompany transfer revenue distribution.
  • ICTpBaseCode; string; Indicates the intercompany transfer price base code of an intercompany transfer revenue distribution.
  • InvLaborRateTypeCode; string; Indicates the code of the type used to classify invoice method labor schedule as defined on the related bill plan.
  • InvNlRateTypeCode; string; Indicates the invoice method for a nonlabor schedule type.
  • InvoiceDate; string; Indicates the invoice date for the invoice related to the revenue distribution.
  • LaborScheduleType; string; The type of labor schedule (namely bill rate, burden, or transfer price) from the revenue method used to determine revenue amounts on revenue distributions.
  • LedgerCurrencyCode; string; The currency used for accounting and reporting in a ledger, often referred to as the accounting currency, base currency, or functional currency.
  • LedgerCurrencyRevenueAmount; number; Indicates the revenue amount in the ledger currency.
  • LedgerCurrencyRevenueExchgDate; string; Indicates the conversion date used to convert the revenue distribution to the ledger currency.
  • LedgerCurrencyRevenueExchgRate; number; Indicates the conversion currency rate used to convert the revenue distribution to the ledger currency.
  • LedgerCurrencyRevenueRateType; string; Indicates the conversion currency rate type used to convert the revenue distribution to the ledger currency.
  • LedgerId; integer; Unique identifier of the ledger associated to the revenue distribution.
  • LedgerRateDateType; string; Indicates the currency conversion date type used to convert the revenue distribution to the ledger currency.
  • LineNumber; integer; A line identifier on a revenue distribution.
  • LineNumberReversed; string; The line number of the original revenue distribution line being reversed by this revenue distribution line.
  • LinkedProjectId; integer; Indicates the unique identifier of project that is linked to contract and related to the revenue distribution.
  • LinkedTaskId; integer; Indicates the unique identifier of task that is linked to contract and related to the revenue distribution.
  • LocNumber; string; Indicates the Letter of Credit Number when the revenue distribution is related to a grants contract bill plan.
  • NonLaborOrgId; integer; Unique identifier for the organization related to nonlabor revenue distributions.
  • NonLaborResourceId; integer; Unique identifier for the resource related to nonlabor revenue distributions.
  • NonLaborScheduleType; string; The type of nonlabor schedule (namely bill rate, burden, or transfer price) from the revenue method used to determine revenue amounts on revenue distributions.
  • PaDate; string; Indicates the date used for the project accounting.
  • PaPeriodName; string; Indicates the period name used for the project accounting.
  • PersonId; integer; Unique identifier of the Person related to the revenue distribution.
  • ProjectCurrencyCode; string; Indicates the currency code of the project.
  • ProjectCurrencyExchgDate; string; Indicates the currency conversion date used to convert the revenue distribution to the project currency.
  • ProjectCurrencyExchgRate; number; Indicates the currency conversion rate used to convert the revenue distribution to the project currency.
  • ProjectCurrencyRateType; string; Indicates the currency conversion rate type used to convert the revenue distribution to the project currency.
  • ProjectCurrencyRevenueAmount; number; Indicates the amount of the revenue distribution in the currency of the project.
  • ProjectLinkageId; integer; Unique identifier of the linkage used to identify the contract related to the revenue distribution.
  • ProjectName; string; The name assigned to a project recorded on the unprocessed revenue event.
  • ProjectNumber; string; Indicates the number for the project linked to the contract.
  • ProjectRateDateType; string; Indicates the currency conversion date type used to convert the revenue distribution to the project currency.
  • PrvdrLegalEntityId; integer; Unique identifier of the provider legal entity for intercompany revenue distributions.
  • Quantity; number; Indicates the quantity of the source expenditure item for revenue distributions created from expenditure items.
  • RecvrLegalEntityId; integer; Unique identifier of the receiver legal entity.
  • RevenueAmountCalculationCode; string; Indicates the code for the revenue amount calculation. Valid values are I - Indirect, O - Overrides, E - Extension, B - Bill rates, L - Labor Multiplier.
  • RevenueBurdenCompileSetId; integer; Unique identifier of the compiled set used to calculate a burden schedule.
  • RevenueCategoryCode; string; Indicates the revenue category code for the revenue distribution.
  • RevenueCategoryMeaning; string; 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.
  • RevenueCurrencyAmount; number; Indicates the revenue amount in the currency of the revenue distribution.
  • RevenueCurrencyCode; string; Indicates the code for the currency of the revenue distribution.
  • RevenueCurrencyConvType; string; 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.
  • RevenueCurrencyDateType; string; The revenue currency conversion date type used to calculate the revenue currency.
  • RevenueCurrencyExchgDate; string; The currency conversion exchange date used to calculate the revenue currency.
  • RevenueCurrencyExchgRate; number; 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.
  • RevenueCurrencyRateType; string; 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.
  • RevenueDiscountPercentage; number; Indicates a discount percentage, expressed as a proportion multiplied by 100, that is used to calculate the adjusted revenue and rate.
  • RevenueDiscountReasonCode; string; Reason code for discount override or rate override.
  • RevenueDistributionId; integer; Unique identifier of the revenue distribution.
  • RevenueIncrementalPercentage; number; Indicates the incremental percentage the revenue distribution.
  • RevenueLaborMultiplier; number; 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.
  • RevenueLaborRateTypeCode; string; Indicates the code of the type used to classify revenue labor rates.
  • RevenueNlRateTypeCode; string; Indicates the code for the revenue nonlabor rate type.
  • RevenuePlanId; integer; Unique identifier of the revenue plan.
  • RevenueRateSourceId; integer; 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.
  • RevenueRateSourceTypeCode; string; Indicates the code of the type used to classify the revenue rate sources.
  • RevenueRecognized; string; Indicates if the expenditure item or event is partially or fully recognized.
  • Reversed; string; Indicates whether this revenue distribution was reversed.
  • ReversedRevenueDistributionId; integer; Unique identifier of the reversed revenue distribution if the revenue distribution is a reversal distribution.
  • SlaEventId; integer; The system-generated number assigned to a subledger accounting event. You create accounting events for transactions that have a financial accounting impact.
  • TaskName; string; Indicates the name of the task for which the revenue distribution applies.
  • TaskNumber; string; The number assigned to a task associated with a contract line.
  • TpBaseAmount; number; Indicates the basis amount for the transfer price calculation from the transfer price rule used to create an intercompany revenue distribution.
  • TpRevenueRulePercentage; number; Indicates the applied percentage value from the transfer price rule used to create an intercompany revenue distribution.
  • TpRevenueSchLinePercentage; number; Indicates the applied percentage value from the transfer price schedule line used to create an intercompany revenue distribution.
  • TransactionCurrencyCode; string; 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.
  • TransactionCurrencyRevenueAmount; number; The amount of revenue in bill transaction currency.
  • TransactionDate; string; Indicates the expenditure item or event date when transaction occurs for this revenue
  • TransactionId; integer; Unique identifier of the expenditure item or event that is revenue distributed by the distribution line.
  • TransactionProjectId; integer; Unique identifier of project for the revenue distribution.
  • TransactionTaskId; integer; Unique identifier of transaction task for the revenue distribution.
  • TransactionType; string; Indicates whether the transaction that created a revenue distribution is an expenditure item or an event. Valid values include Expenditure Item or Event.
  • TransactionTypeId; integer; Unique identifier of Event Type or Expenditure Item Type for the revenue distribution.
  • Version; integer; Version number of contract when the revenue distribution was created.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context: string
  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".
• REST-Framework-Version: string
  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

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  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".
• REST-Framework-Version:
  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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{ "required":[ "count", "hasMore", "limit", "links", "offset" ], "type":"object", "properties":{ "totalResults":{ "type":"integer", "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included." }, "offset":{ "type":"integer", "description":"The offset value used in the current page." }, "count":{ "type":"integer", "description":"The number of resource instances returned in the current range." }, "hasMore":{ "type":"boolean", "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false." }, "limit":{ "type":"integer", "description":"The actual paging size used by the server." }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "items":{ "title":"Items", "type":"array", "description":"The items in the collection.", "items":{ "$ref":"#/components/schemas/projectContractRevenue-item-response" } } }, "x-hints":{ "usage":"BusinessObject" } }

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object projectContractRevenue-item-response

{ "title":"Items", "type":"array", "description":"The items in the collection.", "items":{ "$ref":"#/components/schemas/projectContractRevenue-item-response" } }

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }

Nested Schema : projectContractRevenue-item-response

Type: object

Show Source

• AssociatedTaskName: string
  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.
• AssociatedTaskNumber: string
  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.
• BillingResource: string
  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.
• BillingResourceId: integer (int64)
  Title: Billing Resource ID

  Read Only: true

  Unique identifier of resource breakdown structure element.
• BillingTypeCode: string
  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.
• BillJobId: integer (int64)
  Title: Bill Job ID

  Read Only: true

  Unique identifier of the bill job used when recording revenue for a labor item.
• BillRate: number
  Title: Bill Rate in Bill Transaction Currency

  Read Only: true

  Bill rate in the currency of the bill transaction.
• BillTransactionId: integer (int64)
  Title: Bill Transaction Number

  Read Only: true

  Number that uniquely identifies a billing transaction that is the source of this revenue distribution.
• BillTransactionTypeCode: string
  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.
• BusinessUnit: string
  Title: Business Unit

  Read Only: true

  Maximum Length: 240

  Name of the business unit associated with the revenue distribution.
• BusinessUnitId: integer (int64)
  Title: Business Unit ID

  Read Only: true

  Unique identifier of the business unit associated to the revenue distribution.
• ContCurrencyRevenueAmount: number
  Title: Revenue in Contract Currency

  Read Only: true

  Indicates the amount in the contract currency.
• ContCurrencyRevenueExchgDate: string (date)
  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.
• ContCurrencyRevenueExchgRate: number
  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.
• ContCurrencyRevenueRateType: string
  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.
• ContractCurrencyCode: string
  Title: Contract Currency

  Read Only: true

  Maximum Length: 30

  Indicates the code of the currency for the contract related to the revenue distribution.
• ContractId: integer (int64)
  Title: Contract ID

  Read Only: true

  Unique identifier of the contract for the revenue distribution.
• ContractLineId: integer (int64)
  Title: Contract Line ID

  Read Only: true

  Unique identifier of the contract line related to the revenue distribution.
• ContractLineNumber: string
  Title: Contract Line Number

  Read Only: true

  Maximum Length: 150

  Number that identifies the contract line related to the revenue distribution.
• ContractNumber: string
  Title: Contract Number

  Read Only: true

  Maximum Length: 120

  Number that uniquely identifies the contract for the revenue distribution.
• ContractRateDateType: string
  Title: Contract Currency Conversion Date Type

  Read Only: true

  Maximum Length: 30

  Indicates the date type of the contract currency.
• DenomBurdenCost: number
  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.
• DenomRawCost: number
  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.
• DocumentNumber: string
  Title: Document Number

  Read Only: true

  Maximum Length: 240

  Number that identifies a document on the revenue plan of a grants contract.
• EventNumber: integer (int64)
  Title: Event Number

  Read Only: true

  Number that identifies an event if the revenue distribution is based on a billing event.
• ExpenditureType: string
  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.
• GlDate: string (date)
  Title: Accounting Date

  Read Only: true

  The date within a General Ledger (GL) accounting period to which the revenue transactions are posted.
• GlPeriodName: string
  Title: Accounting Period

  Read Only: true

  Maximum Length: 30

  Name of the General Ledger (GL) period for the GL Date attribute.
• ICTpAmountTypeCode: string
  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.
• ICTpBaseCode: string
  Title: Intercompany Transfer Price Base

  Read Only: true

  Maximum Length: 30

  Indicates the intercompany transfer price base code of an intercompany transfer revenue distribution.
• InvLaborRateTypeCode: string
  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.
• InvNlRateTypeCode: string
  Title: Invoice Method Nonlabor Schedule Type

  Read Only: true

  Maximum Length: 30

  Indicates the invoice method for a nonlabor schedule type.
• InvoiceDate: string (date)
  Title: Invoice Date

  Read Only: true

  Indicates the invoice date for the invoice related to the revenue distribution.
• LaborScheduleType: string
  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.
• LedgerCurrencyCode: string
  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.
• LedgerCurrencyRevenueAmount: number
  Title: Revenue in Ledger Currency

  Read Only: true

  Indicates the revenue amount in the ledger currency.
• LedgerCurrencyRevenueExchgDate: string (date)
  Title: Ledger Currency Conversion Date

  Read Only: true

  Indicates the conversion date used to convert the revenue distribution to the ledger currency.
• LedgerCurrencyRevenueExchgRate: number
  Title: Ledger Currency Conversion Rate

  Read Only: true

  Indicates the conversion currency rate used to convert the revenue distribution to the ledger currency.
• LedgerCurrencyRevenueRateType: string
  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.
• LedgerId: integer (int64)
  Title: Ledger ID

  Read Only: true

  Unique identifier of the ledger associated to the revenue distribution.
• LedgerRateDateType: string
  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.
• LineNumber: integer (int64)
  Title: Line Number

  Read Only: true

  A line identifier on a revenue distribution.
• LineNumberReversed: string
  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.
• LinkedProjectId: integer (int64)
  Title: Associated Project ID

  Read Only: true

  Indicates the unique identifier of project that is linked to contract and related to the revenue distribution.
• LinkedTaskId: integer (int64)
  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: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocNumber: string
  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.
• NonLaborOrgId: integer (int64)
  Title: Nonlabor Organization ID

  Read Only: true

  Unique identifier for the organization related to nonlabor revenue distributions.
• NonLaborResourceId: integer (int64)
  Title: Nonlabor Resource ID

  Read Only: true

  Unique identifier for the resource related to nonlabor revenue distributions.
• NonLaborScheduleType: string
  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.
• PaDate: string (date)
  Title: Project Accounting Date

  Read Only: true

  Indicates the date used for the project accounting.
• PaPeriodName: string
  Title: Project Accounting Period

  Read Only: true

  Maximum Length: 30

  Indicates the period name used for the project accounting.
• PersonId: integer (int64)
  Title: Person ID

  Read Only: true

  Unique identifier of the Person related to the revenue distribution.
• ProjectCurrencyCode: string
  Title: Project Currency

  Read Only: true

  Maximum Length: 30

  Indicates the currency code of the project.
• ProjectCurrencyExchgDate: string (date)
  Title: Project Currency Conversion Date

  Read Only: true

  Indicates the currency conversion date used to convert the revenue distribution to the project currency.
• ProjectCurrencyExchgRate: number
  Title: Project Currency Conversion Rate

  Read Only: true

  Indicates the currency conversion rate used to convert the revenue distribution to the project currency.
• ProjectCurrencyRateType: string
  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.
• ProjectCurrencyRevenueAmount: number
  Title: Revenue in Project Currency

  Read Only: true

  Indicates the amount of the revenue distribution in the currency of the project.
• ProjectLinkageId: integer (int64)
  Title: Project Linkage ID

  Read Only: true

  Unique identifier of the linkage used to identify the contract related to the revenue distribution.
• ProjectName: string
  Title: Project Name

  Read Only: true

  Maximum Length: 240

  The name assigned to a project recorded on the unprocessed revenue event.
• ProjectNumber: string
  Title: Project Number

  Read Only: true

  Maximum Length: 25

  Indicates the number for the project linked to the contract.
• ProjectRateDateType: string
  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.
• PrvdrLegalEntityId: integer (int64)
  Title: Provider Legal Entity ID

  Read Only: true

  Unique identifier of the provider legal entity for intercompany revenue distributions.
• Quantity: number
  Title: Quantity

  Read Only: true

  Indicates the quantity of the source expenditure item for revenue distributions created from expenditure items.
• RecvrLegalEntityId: integer (int64)
  Title: Receiver Legal Entity ID

  Read Only: true

  Unique identifier of the receiver legal entity.
• RevenueAmountCalculationCode: string
  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.
• RevenueBurdenCompileSetId: integer (int64)
  Title: Revenue Burden Compile Set ID

  Read Only: true

  Unique identifier of the compiled set used to calculate a burden schedule.
• RevenueCategoryCode: string
  Title: Revenue Category Code

  Read Only: true

  Maximum Length: 30

  Indicates the revenue category code for the revenue distribution.
• RevenueCategoryMeaning: string
  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.
• RevenueCurrencyAmount: number
  Title: Revenue in Revenue Currency

  Read Only: true

  Indicates the revenue amount in the currency of the revenue distribution.
• RevenueCurrencyCode: string
  Title: Revenue Currency

  Read Only: true

  Maximum Length: 30

  Indicates the code for the currency of the revenue distribution.
• RevenueCurrencyConvType: string
  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.
• RevenueCurrencyDateType: string
  Title: Revenue Currency Conversion Date Type

  Read Only: true

  Maximum Length: 30

  The revenue currency conversion date type used to calculate the revenue currency.
• RevenueCurrencyExchgDate: string (date)
  Title: Revenue Currency Conversion Date

  Read Only: true

  The currency conversion exchange date used to calculate the revenue currency.
• RevenueCurrencyExchgRate: number
  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.
• RevenueCurrencyRateType: string
  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.
• RevenueDiscountPercentage: number
  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.
• RevenueDiscountReasonCode: string
  Title: Revenue Discount Reason Code

  Read Only: true

  Maximum Length: 30

  Reason code for discount override or rate override.
• RevenueDistributionId: integer (int64)
  Title: Revenue Distribution Number

  Read Only: true

  Unique identifier of the revenue distribution.
• RevenueIncrementalPercentage: number
  Title: Revenue Incremental Percentage

  Read Only: true

  Indicates the incremental percentage the revenue distribution.
• RevenueLaborMultiplier: number
  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.
• RevenueLaborRateTypeCode: string
  Title: Revenue Labor Rate Type Code

  Read Only: true

  Maximum Length: 30

  Indicates the code of the type used to classify revenue labor rates.
• RevenueNlRateTypeCode: string
  Title: Revenue Nonlabor Rate Type Code

  Read Only: true

  Maximum Length: 30

  Indicates the code for the revenue nonlabor rate type.
• RevenuePlanId: integer (int64)
  Title: Revenue Plan ID

  Read Only: true

  Unique identifier of the revenue plan.
• RevenueRateSourceId: integer (int64)
  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.
• RevenueRateSourceTypeCode: string
  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.
• RevenueRecognized: string
  Title: Revenue Recognized

  Read Only: true

  Maximum Length: 1

  Indicates if the expenditure item or event is partially or fully recognized.
• Reversed: string
  Title: Reversed

  Read Only: true

  Maximum Length: 1

  Indicates whether this revenue distribution was reversed.
• ReversedRevenueDistributionId: integer (int64)
  Title: Reversed Distribution Number

  Read Only: true

  Unique identifier of the reversed revenue distribution if the revenue distribution is a reversal distribution.
• SlaEventId: integer (int64)
  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.
• TaskName: string
  Title: Task Name

  Read Only: true

  Maximum Length: 255

  Indicates the name of the task for which the revenue distribution applies.
• TaskNumber: string
  Title: Task Number

  Read Only: true

  Maximum Length: 100

  The number assigned to a task associated with a contract line.
• TpBaseAmount: number
  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.
• TpRevenueRulePercentage: number
  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.
• TpRevenueSchLinePercentage: number
  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.
• TransactionCurrencyCode: string
  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.
• TransactionCurrencyRevenueAmount: number
  Title: Revenue in Bill Transaction Currency

  Read Only: true

  The amount of revenue in bill transaction currency.
• TransactionDate: string (date)
  Title: Transaction Date

  Read Only: true

  Indicates the expenditure item or event date when transaction occurs for this revenue
• TransactionId: integer (int64)
  Title: Transaction ID

  Read Only: true

  Unique identifier of the expenditure item or event that is revenue distributed by the distribution line.
• TransactionProjectId: integer (int64)
  Title: Transaction Project ID

  Read Only: true

  Unique identifier of project for the revenue distribution.
• TransactionTaskId: integer (int64)
  Title: Transaction Task ID

  Read Only: true

  Unique identifier of transaction task for the revenue distribution.
• TransactionType: string
  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.
• TransactionTypeId: integer (int64)
  Title: Transaction Type ID

  Read Only: true

  Unique identifier of Event Type or Expenditure Item Type for the revenue distribution.
• Version: integer (int64)
  Title: Version

  Read Only: true

  Version number of contract when the revenue distribution was created.

{ "type":"object", "properties":{ "SlaEventId":{ "title":"Subledger Accounting Event ID", "type":"integer", "description":"The system-generated number assigned to a subledger accounting event. You create accounting events for transactions that have a financial accounting impact.", "format":"int64", "nullable":true, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "PrvdrLegalEntityId":{ "title":"Provider Legal Entity ID", "type":"integer", "description":"Unique identifier of the provider legal entity for intercompany revenue distributions.", "format":"int64", "nullable":true, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "TpBaseAmount":{ "title":"Transfer Price Base Amount", "type":"number", "description":"Indicates the basis amount for the transfer price calculation from the transfer price rule used to create an intercompany revenue distribution.", "nullable":true, "readOnly":true, "x-queryable":true }, "RevenueNlRateTypeCode":{ "title":"Revenue Nonlabor Rate Type Code", "maxLength":30, "type":"string", "description":"Indicates the code for the revenue nonlabor rate type.", "nullable":true, "readOnly":true, "x-queryable":true }, "RevenueCurrencyDateType":{ "title":"Revenue Currency Conversion Date Type", "maxLength":30, "type":"string", "description":"The revenue currency conversion date type used to calculate the revenue currency.", "nullable":true, "readOnly":true, "x-queryable":true }, "RevenueCurrencyRateType":{ "title":"Revenue Currency Conversion Rate Type", "maxLength":30, "type":"string", "description":"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.", "nullable":true, "readOnly":true, "x-queryable":true }, "ProjectRateDateType":{ "title":"Project Currency Conversion Date Type", "maxLength":30, "type":"string", "description":"Indicates the currency conversion date type used to convert the revenue distribution to the project currency.", "nullable":true, "readOnly":true, "x-queryable":true }, "InvNlRateTypeCode":{ "title":"Invoice Method Nonlabor Schedule Type", "maxLength":30, "type":"string", "description":"Indicates the invoice method for a nonlabor schedule type.", "nullable":true, "readOnly":true, "x-queryable":true }, "ProjectCurrencyRateType":{ "title":"Project Currency Rate Type", "maxLength":30, "type":"string", "description":"Indicates the currency conversion rate type used to convert the revenue distribution to the project currency.", "nullable":true, "readOnly":true, "x-queryable":true }, "TransactionId":{ "title":"Transaction ID", "type":"integer", "description":"Unique identifier of the expenditure item or event that is revenue distributed by the distribution line.", "format":"int64", "nullable":false, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "BillTransactionTypeCode":{ "title":"Bill Transaction Type Code", "maxLength":30, "type":"string", "description":"Indicates the code used to classify the type of bill transaction. Valid values are EI - Expenditure Item or EVT - Billing Event.", "nullable":false, "readOnly":true, "x-queryable":true }, "ICTpAmountTypeCode":{ "title":"Intercompany Transfer Price Amount Type", "maxLength":30, "type":"string", "description":"Indicates the intercompany transfer price amount type of an intercompany transfer revenue distribution.", "nullable":true, "readOnly":true, "x-queryable":true }, "EventNumber":{ "title":"Event Number", "type":"integer", "description":"Number that identifies an event if the revenue distribution is based on a billing event.", "format":"int64", "nullable":true, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "LocNumber":{ "title":"LOC Number", "maxLength":240, "type":"string", "description":"Indicates the Letter of Credit Number when the revenue distribution is related to a grants contract bill plan.", "nullable":true, "readOnly":true, "x-queryable":true }, "RevenueCategoryMeaning":{ "title":"Revenue Category", "maxLength":80, "type":"string", "description":"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.", "nullable":false, "readOnly":true, "x-queryable":true }, "ExpenditureType":{ "title":"Expenditure Type Class", "maxLength":80, "type":"string", "description":"A classification of the expenditure type of the expenditure item that was recognized for revenue.", "nullable":false, "readOnly":true, "x-queryable":true }, "NonLaborResourceId":{ "title":"Nonlabor Resource ID", "type":"integer", "description":"Unique identifier for the resource related to nonlabor revenue distributions.", "format":"int64", "nullable":true, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "PersonId":{ "title":"Person ID", "type":"integer", "description":"Unique identifier of the Person related to the revenue distribution.", "format":"int64", "nullable":true, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "RevenueIncrementalPercentage":{ "title":"Revenue Incremental Percentage", "type":"number", "description":"Indicates the incremental percentage the revenue distribution.", "nullable":true, "readOnly":true, "x-queryable":true }, "BusinessUnit":{ "title":"Business Unit", "maxLength":240, "type":"string", "description":"Name of the business unit associated with the revenue distribution.", "nullable":true, "readOnly":true, "x-queryable":true }, "LineNumberReversed":{ "title":"Line Number Reversed", "maxLength":20, "type":"string", "description":"The line number of the original revenue distribution line being reversed by this revenue distribution line.", "nullable":true, "readOnly":true, "x-queryable":true }, "RecvrLegalEntityId":{ "title":"Receiver Legal Entity ID", "type":"integer", "description":"Unique identifier of the receiver legal entity.", "format":"int64", "nullable":true, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "ContractCurrencyCode":{ "title":"Contract Currency", "maxLength":30, "type":"string", "description":"Indicates the code of the currency for the contract related to the revenue distribution.", "nullable":true, "readOnly":true, "x-queryable":true }, "RevenueLaborMultiplier":{ "title":"Labor Multiplier", "type":"number", "description":"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.", "nullable":true, "readOnly":true, "x-queryable":true }, "PaPeriodName":{ "title":"Project Accounting Period", "maxLength":30, "type":"string", "description":"Indicates the period name used for the project accounting.", "nullable":true, "readOnly":true, "x-queryable":true }, "LinkedTaskId":{ "title":"Linked Task ID", "type":"integer", "description":"Indicates the unique identifier of task that is linked to contract and related to the revenue distribution.", "format":"int64", "nullable":true, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "ProjectName":{ "title":"Project Name", "maxLength":240, "type":"string", "description":"The name assigned to a project recorded on the unprocessed revenue event.", "nullable":false, "readOnly":true, "x-queryable":true }, "RevenueCurrencyCode":{ "title":"Revenue Currency", "maxLength":30, "type":"string", "description":"Indicates the code for the currency of the revenue distribution.", "nullable":true, "readOnly":true, "x-queryable":true }, "TransactionProjectId":{ "title":"Transaction Project ID", "type":"integer", "description":"Unique identifier of project for the revenue distribution.", "format":"int64", "nullable":true, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "NonLaborOrgId":{ "title":"Nonlabor Organization ID", "type":"integer", "description":"Unique identifier for the organization related to nonlabor revenue distributions.", "format":"int64", "nullable":true, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "LineNumber":{ "title":"Line Number", "type":"integer", "description":"A line identifier on a revenue distribution.", "format":"int64", "nullable":false, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "ProjectCurrencyExchgRate":{ "title":"Project Currency Conversion Rate", "type":"number", "description":"Indicates the currency conversion rate used to convert the revenue distribution to the project currency.", "nullable":true, "readOnly":true, "x-queryable":true }, "TransactionTaskId":{ "title":"Transaction Task ID", "type":"integer", "description":"Unique identifier of transaction task for the revenue distribution.", "format":"int64", "nullable":true, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "InvoiceDate":{ "title":"Invoice Date", "type":"string", "description":"Indicates the invoice date for the invoice related to the revenue distribution.", "format":"date", "nullable":true, "readOnly":true, "x-queryable":true }, "RevenueCategoryCode":{ "title":"Revenue Category Code", "maxLength":30, "type":"string", "description":"Indicates the revenue category code for the revenue distribution.", "nullable":true, "readOnly":true, "x-queryable":true }, "LedgerCurrencyRevenueExchgDate":{ "title":"Ledger Currency Conversion Date", "type":"string", "description":"Indicates the conversion date used to convert the revenue distribution to the ledger currency.", "format":"date", "nullable":true, "readOnly":true, "x-queryable":true }, "TpRevenueRulePercentage":{ "title":"Transfer Price Revenue Rule Percentage", "type":"number", "description":"Indicates the applied percentage value from the transfer price rule used to create an intercompany revenue distribution.", "nullable":true, "readOnly":true, "x-queryable":true }, "TransactionDate":{ "title":"Transaction Date", "type":"string", "description":"Indicates the expenditure item or event date when transaction occurs for this revenue", "format":"date", "nullable":true, "readOnly":true, "x-queryable":true }, "BillJobId":{ "title":"Bill Job ID", "type":"integer", "description":"Unique identifier of the bill job used when recording revenue for a labor item.", "format":"int64", "nullable":true, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "ProjectNumber":{ "title":"Project Number", "maxLength":25, "type":"string", "description":"Indicates the number for the project linked to the contract.", "nullable":false, "readOnly":true, "x-queryable":true }, "AssociatedTaskName":{ "title":"Associated Task Name", "maxLength":255, "type":"string", "description":"Name of the task that is linked to the contract line associated to the revenue distribution.", "nullable":false, "readOnly":true, "x-queryable":true }, "TaskNumber":{ "title":"Task Number", "maxLength":100, "type":"string", "description":"The number assigned to a task associated with a contract line.", "nullable":true, "readOnly":true, "x-queryable":true }, "DenomBurdenCost":{ "title":"Burdened Cost Amount in Bill Transaction Currency", "type":"number", "description":"Indicates the burdened cost in the ledger currency of the provider business unit for inter company revenue distributions.", "nullable":true, "readOnly":true, "x-queryable":true }, "GlDate":{ "title":"Accounting Date", "type":"string", "description":"The date within a General Ledger (GL) accounting period to which the revenue transactions are posted.", "format":"date", "nullable":true, "readOnly":true, "x-queryable":true }, "RevenueLaborRateTypeCode":{ "title":"Revenue Labor Rate Type Code", "maxLength":30, "type":"string", "description":"Indicates the code of the type used to classify revenue labor rates.", "nullable":true, "readOnly":true, "x-queryable":true }, "RevenueCurrencyConvType":{ "title":"Revenue Currency Conversion Rate Type", "maxLength":30, "type":"string", "description":"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.", "nullable":false, "readOnly":true, "x-queryable":true }, "DocumentNumber":{ "title":"Document Number", "maxLength":240, "type":"string", "description":"Number that identifies a document on the revenue plan of a grants contract.", "nullable":true, "readOnly":true, "x-queryable":true }, "TransactionCurrencyCode":{ "title":"Bill Transaction Currency", "maxLength":30, "type":"string", "description":"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.", "nullable":true, "readOnly":true, "x-queryable":true }, "ProjectCurrencyRevenueAmount":{ "title":"Revenue in Project Currency", "type":"number", "description":"Indicates the amount of the revenue distribution in the currency of the project.", "nullable":true, "readOnly":true, "x-queryable":true }, "RevenueRecognized":{ "title":"Revenue Recognized", "maxLength":1, "type":"string", "description":"Indicates if the expenditure item or event is partially or fully recognized.", "nullable":true, "readOnly":true, "x-queryable":true }, "LinkedProjectId":{ "title":"Associated Project ID", "type":"integer", "description":"Indicates the unique identifier of project that is linked to contract and related to the revenue distribution.", "format":"int64", "nullable":true, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "ICTpBaseCode":{ "title":"Intercompany Transfer Price Base", "maxLength":30, "type":"string", "description":"Indicates the intercompany transfer price base code of an intercompany transfer revenue distribution.", "nullable":true, "readOnly":true, "x-queryable":true }, "BillRate":{ "title":"Bill Rate in Bill Transaction Currency", "type":"number", "description":"Bill rate in the currency of the bill transaction.", "nullable":true, "readOnly":true, "x-queryable":true }, "RevenuePlanId":{ "title":"Revenue Plan ID", "type":"integer", "description":"Unique identifier of the revenue plan.", "format":"int64", "nullable":false, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "DenomRawCost":{ "title":"Raw Cost Amount in Bill Transaction Currency", "type":"number", "description":"Indicates the raw cost of the transaction in the ledger currency of the provider business unit for inter company revenue distributions.", "nullable":true, "readOnly":true, "x-queryable":true }, "ContractNumber":{ "title":"Contract Number", "maxLength":120, "type":"string", "description":"Number that uniquely identifies the contract for the revenue distribution.", "nullable":false, "readOnly":true, "x-queryable":true }, "RevenueDistributionId":{ "title":"Revenue Distribution Number", "type":"integer", "description":"Unique identifier of the revenue distribution.", "format":"int64", "nullable":false, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "LedgerCurrencyRevenueExchgRate":{ "title":"Ledger Currency Conversion Rate", "type":"number", "description":"Indicates the conversion currency rate used to convert the revenue distribution to the ledger currency.", "nullable":true, "readOnly":true, "x-queryable":true }, "ContractLineId":{ "title":"Contract Line ID", "type":"integer", "description":"Unique identifier of the contract line related to the revenue distribution.", "format":"int64", "nullable":false, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "ContCurrencyRevenueExchgRate":{ "title":"Contract Currency Conversion Rate", "type":"number", "description":"Indicates the rate used to convert the revenue distribution amounts from the transaction currency to the contract currency.", "nullable":true, "readOnly":true, "x-queryable":true }, "TransactionTypeId":{ "title":"Transaction Type ID", "type":"integer", "description":"Unique identifier of Event Type or Expenditure Item Type for the revenue distribution.", "format":"int64", "nullable":false, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "ProjectCurrencyCode":{ "title":"Project Currency", "maxLength":30, "type":"string", "description":"Indicates the currency code of the project.", "nullable":true, "readOnly":true, "x-queryable":true }, "Version":{ "title":"Version", "type":"integer", "description":"Version number of contract when the revenue distribution was created.", "format":"int64", "nullable":false, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "RevenueCurrencyAmount":{ "title":"Revenue in Revenue Currency", "type":"number", "description":"Indicates the revenue amount in the currency of the revenue distribution.", "nullable":true, "readOnly":true, "x-queryable":true }, "RevenueRateSourceTypeCode":{ "title":"Revenue Rate Source Type Code", "maxLength":30, "type":"string", "description":"Indicates the code of the type used to classify the revenue rate sources.", "nullable":true, "readOnly":true, "x-queryable":true }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "RevenueDiscountPercentage":{ "title":"Discount Percentage", "type":"number", "description":"Indicates a discount percentage, expressed as a proportion multiplied by 100, that is used to calculate the adjusted revenue and rate.", "nullable":true, "readOnly":true, "x-queryable":true }, "ProjectCurrencyExchgDate":{ "title":"Project Currency Conversion Date", "type":"string", "description":"Indicates the currency conversion date used to convert the revenue distribution to the project currency.", "format":"date", "nullable":true, "readOnly":true, "x-queryable":true }, "LedgerCurrencyRevenueRateType":{ "title":"Ledger Currency Conversion Rate Type", "maxLength":30, "type":"string", "description":"Indicates the conversion currency rate type used to convert the revenue distribution to the ledger currency.", "nullable":true, "readOnly":true, "x-queryable":true }, "LedgerCurrencyRevenueAmount":{ "title":"Revenue in Ledger Currency", "type":"number", "description":"Indicates the revenue amount in the ledger currency.", "nullable":true, "readOnly":true, "x-queryable":true }, "BillTransactionId":{ "title":"Bill Transaction Number", "type":"integer", "description":"Number that uniquely identifies a billing transaction that is the source of this revenue distribution.", "format":"int64", "nullable":false, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "PaDate":{ "title":"Project Accounting Date", "type":"string", "description":"Indicates the date used for the project accounting.", "format":"date", "nullable":true, "readOnly":true, "x-queryable":true }, "RevenueRateSourceId":{ "title":"Revenue Rate Source ID", "type":"integer", "description":"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.", "format":"int64", "nullable":true, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "BillingResource":{ "title":"Billing Resource", "maxLength":240, "type":"string", "description":"This is the name of the Billing Resource for the billing event or expenditure item from the billing event or expenditure item.", "nullable":false, "readOnly":true, "x-queryable":true }, "GlPeriodName":{ "title":"Accounting Period", "maxLength":30, "type":"string", "description":"Name of the General Ledger (GL) period for the GL Date attribute.", "nullable":true, "readOnly":true, "x-queryable":true }, "BusinessUnitId":{ "title":"Business Unit ID", "type":"integer", "description":"Unique identifier of the business unit associated to the revenue distribution.", "format":"int64", "nullable":false, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "RevenueCurrencyExchgDate":{ "title":"Revenue Currency Conversion Date", "type":"string", "description":"The currency conversion exchange date used to calculate the revenue currency.", "format":"date", "nullable":true, "readOnly":true, "x-queryable":true }, "ContCurrencyRevenueRateType":{ "title":"Contract Currency Conversion Rate Type", "maxLength":30, "type":"string", "description":"Indicates a classification of conversion rates used to convert the transaction amounts to the contract currency.", "nullable":true, "readOnly":true, "x-queryable":true }, "LedgerId":{ "title":"Ledger ID", "type":"integer", "description":"Unique identifier of the ledger associated to the revenue distribution.", "format":"int64", "nullable":true, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "NonLaborScheduleType":{ "title":"Revenue Method Nonlabor Schedule Type", "maxLength":80, "type":"string", "description":"The type of nonlabor schedule (namely bill rate, burden, or transfer price) from the revenue method used to determine revenue amounts on revenue distributions.", "nullable":false, "readOnly":true, "x-queryable":true }, "TransactionCurrencyRevenueAmount":{ "title":"Revenue in Bill Transaction Currency", "type":"number", "description":"The amount of revenue in bill transaction currency.", "nullable":true, "readOnly":true, "x-queryable":true }, "TaskName":{ "title":"Task Name", "maxLength":255, "type":"string", "description":"Indicates the name of the task for which the revenue distribution applies.", "nullable":false, "readOnly":true, "x-queryable":true }, "ReversedRevenueDistributionId":{ "title":"Reversed Distribution Number", "type":"integer", "description":"Unique identifier of the reversed revenue distribution if the revenue distribution is a reversal distribution.", "format":"int64", "nullable":true, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "ContCurrencyRevenueExchgDate":{ "title":"Contract Currency Conversion Date", "type":"string", "description":"Indicates the date used for the conversion of the rates on the contract used for the revenue distribution.", "format":"date", "nullable":true, "readOnly":true, "x-queryable":true }, "TransactionType":{ "title":"Transaction Type", "maxLength":80, "type":"string", "description":"Indicates whether the transaction that created a revenue distribution is an expenditure item or an event. Valid values include Expenditure Item or Event.", "nullable":false, "readOnly":true, "x-queryable":true }, "RevenueDiscountReasonCode":{ "title":"Revenue Discount Reason Code", "maxLength":30, "type":"string", "description":"Reason code for discount override or rate override.", "nullable":true, "readOnly":true, "x-queryable":true }, "AssociatedTaskNumber":{ "title":"Associated Task Number", "maxLength":100, "type":"string", "description":"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.", "nullable":true, "readOnly":true, "x-queryable":true }, "LedgerRateDateType":{ "title":"Ledger Currency Conversion Date Type", "maxLength":30, "type":"string", "description":"Indicates the currency conversion date type used to convert the revenue distribution to the ledger currency.", "nullable":true, "readOnly":true, "x-queryable":true }, "RevenueAmountCalculationCode":{ "title":"Revenue Amount Calculation Code", "maxLength":30, "type":"string", "description":"Indicates the code for the revenue amount calculation. Valid values are I - Indirect, O - Overrides, E - Extension, B - Bill rates, L - Labor Multiplier.", "nullable":true, "readOnly":true, "x-queryable":true }, "LedgerCurrencyCode":{ "title":"Ledger Currency", "maxLength":30, "type":"string", "description":"The currency used for accounting and reporting in a ledger, often referred to as the accounting currency, base currency, or functional currency.", "nullable":true, "readOnly":true, "x-queryable":true }, "RevenueBurdenCompileSetId":{ "title":"Revenue Burden Compile Set ID", "type":"integer", "description":"Unique identifier of the compiled set used to calculate a burden schedule.", "format":"int64", "nullable":true, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "InvLaborRateTypeCode":{ "title":"Invoice Method Labor Schedule Type", "maxLength":30, "type":"string", "description":"Indicates the code of the type used to classify invoice method labor schedule as defined on the related bill plan.", "nullable":true, "readOnly":true, "x-queryable":true }, "LaborScheduleType":{ "title":"Revenue Method Labor Schedule Type", "maxLength":80, "type":"string", "description":"The type of labor schedule (namely bill rate, burden, or transfer price) from the revenue method used to determine revenue amounts on revenue distributions.", "nullable":false, "readOnly":true, "x-queryable":true }, "Quantity":{ "title":"Quantity", "type":"number", "description":"Indicates the quantity of the source expenditure item for revenue distributions created from expenditure items.", "nullable":true, "readOnly":true, "x-queryable":true }, "ContractId":{ "title":"Contract ID", "type":"integer", "description":"Unique identifier of the contract for the revenue distribution.", "format":"int64", "nullable":false, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "BillingTypeCode":{ "title":"Billing Type Code", "maxLength":30, "type":"string", "description":"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.", "nullable":false, "readOnly":true, "x-queryable":true }, "ContractLineNumber":{ "title":"Contract Line Number", "maxLength":150, "type":"string", "description":"Number that identifies the contract line related to the revenue distribution.", "nullable":false, "readOnly":true, "x-queryable":true }, "ContractRateDateType":{ "title":"Contract Currency Conversion Date Type", "maxLength":30, "type":"string", "description":"Indicates the date type of the contract currency.", "nullable":true, "readOnly":true, "x-queryable":true }, "BillingResourceId":{ "title":"Billing Resource ID", "type":"integer", "description":"Unique identifier of resource breakdown structure element.", "format":"int64", "nullable":true, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "Reversed":{ "title":"Reversed", "maxLength":1, "type":"string", "description":"Indicates whether this revenue distribution was reversed.", "nullable":true, "readOnly":true, "x-queryable":true }, "ContCurrencyRevenueAmount":{ "title":"Revenue in Contract Currency", "type":"number", "description":"Indicates the amount in the contract currency.", "nullable":true, "readOnly":true, "x-queryable":true }, "ProjectLinkageId":{ "title":"Project Linkage ID", "type":"integer", "description":"Unique identifier of the linkage used to identify the contract related to the revenue distribution.", "format":"int64", "nullable":true, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "RevenueCurrencyExchgRate":{ "title":"Revenue Currency Conversion Rate", "type":"number", "description":"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.", "nullable":true, "readOnly":true, "x-queryable":true }, "TpRevenueSchLinePercentage":{ "title":"Transfer Price Revenue Schedule Line Percentage", "type":"number", "description":"Indicates the applied percentage value from the transfer price schedule line used to create an intercompany revenue distribution.", "nullable":true, "readOnly":true, "x-queryable":true } } }

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{ "type":"object", "properties":{ "kind":{ "title":"kind", "type":"string", "description":"The kind of the related resource.", "enum":[ "collection", "item", "describe", "other" ] }, "rel":{ "title":"relation", "type":"string", "description":"The name of the relation to the resource instance. Example: self.", "enum":[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ] }, "name":{ "title":"name", "type":"string", "description":"The name of the link to the related resource." }, "href":{ "title":"hyperlink reference", "type":"string", "description":"The URI to the related resource." }, "properties":{ "type":"object", "properties":{ "changeIndicator":{ "type":"string", "description":"Change indicator or the ETag value of the resource instance." } } } } }

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{ "type":"object", "properties":{ "changeIndicator":{ "type":"string", "description":"Change indicator or the ETag value of the resource instance." } } }

Back to Top

Examples

Example 1

The following example shows how to get all project contract revenues with a specific set of attributes by submitting a GET request on the REST resource using cURL.

Note:

It's recommended that you only select the required attributes to achieve better performance.

curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractRevenue?fields=BusinessUnit,ContractNumber,ContractLineNumber,ProjectName,ProjectNumber,TaskNumber,TaskName,BillTransactionTypeCode,TransactionId,ContCurrencyRevenueAmount,ContractCurrencyCode,TransactionDate,LedgerCurrencyRevenueAmount,LedgerCurrencyCode

Example 1 Response Body

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

{ "items": [ { "BusinessUnit": "Vision Operations", "ContractNumber": "zBI_revcon6", "ContractLineNumber": "Line1", "ProjectName": "zBI_Projrev-06", "ProjectNumber": "zBI_Projrev-06", "TaskNumber": "4.3.4", "TaskName": "Application Setup Phase 2", "BillTransactionTypeCode": "EVT", "TransactionId": 100000016853649, "ContCurrencyRevenueAmount": 5000, "ContractCurrencyCode": "USD", "TransactionDate": "2010-04-01", "LedgerCurrencyRevenueAmount": 5000, "LedgerCurrencyCode": "USD", "links": [ { "rel": "self", "href": "https://your_organization:port/fscmRestApi/resources/11.13.18.05/projectContractRevenue/100010033111687", "name": "projectContractRevenue", "kind": "item" }, { "rel": "canonical", "href": "https://your_organization:port/fscmRestApi/resources/11.13.18.05/projectContractRevenue/100010033111687", "name": "projectContractRevenue", "kind": "item" } ] }, { "BusinessUnit": "Vision Operations", "ContractNumber": "PJB_VOL_Contract", "ContractLineNumber": "1", "ProjectName": "PJB_VOL_Project", "ProjectNumber": "PJB_VOL_Project", "TaskNumber": "1.1", "TaskName": "Project Kickoff", "BillTransactionTypeCode": "EI", "TransactionId": 7687222, "ContCurrencyRevenueAmount": 400, "ContractCurrencyCode": "USD", "TransactionDate": "2011-04-24", "LedgerCurrencyRevenueAmount": 400, "LedgerCurrencyCode": "USD", "links": [ { "rel": "self", "href": "https://your_organization:port/fscmRestApi/resources/11.13.18.05/projectContractRevenue/100100037705976", "name": "projectContractRevenue", "kind": "item" }, { "rel": "canonical", "href": "https://your_organization:port/fscmRestApi/resources/11.13.18.05/projectContractRevenue/100100037705976", "name": "projectContractRevenue", "kind": "item" } ] } ], "count": 25, "hasMore": true, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://your_organization:port/fscmRestApi/resources/11.13.18.05/projectContractRevenue", "name": "projectContractRevenue", "kind": "collection" } ] }

Example 2

The following example shows how to get all burden schedules 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

Example 2 Response Body

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

{ "items": [ { "RevenueDistributionId": 100010033099998, "BusinessUnit": "Vision Corporation", "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