Get a project contract bill transaction

get

/fscmRestApi/resources/11.13.18.05/projectContractBillTransactions/{projectContractBillTransactionsUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Project Contract Bill Transactions resource and used to uniquely identify an instance of Project Contract Bill Transactions. The client should not generate the hash key value. Instead, the client should query on the Project Contract Bill Transactions collection resource in order to navigate to a specific instance of Project Contract Bill Transactions 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
  • This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
  • 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 : projectContractBillTransactions-item-response
Type: object
Show Source
  • Title: Amount to Bill in Contract Currency
    The outstanding amount to be billed in contract currency, also known as work in process or WIP.
  • Title: Amount to Bill in Invoice Currency
    The outstanding amount to be billed in invoice currency, also known as work in process or WIP.
  • Title: Amount to Bill in Transaction Currency
    The outstanding amount to be billed in transaction currency, also known as work in process or WIP.
  • Title: Process Applicability Code
    Maximum Length: 1
    A code which indicates whether a bill transaction is applicable for invoicing, revenue recognition, or both.
  • Title: Billing Event Id
    Read Only: true
    Unique identifier of the billing event associated with the transaction.
  • Title: Billing Job Code
    Read Only: true
    Maximum Length: 30
    Short code of the billing job associated with the transaction.
  • Title: Billing Job Id
    Read Only: true
    Unique identifier of the billing job associated with the transaction.
  • Title: Billing Job Name
    Read Only: true
    Maximum Length: 240
    Name of the billing job associated with the transaction.
  • Title: Billing Job Title Override
    Maximum Length: 80
    Override of the billing job name, if specified in the Job Title Overrides of the bill plan.
  • Title: Billing Person Id
    Read Only: true
    Unique identifier of the worker associated with the transaction.
  • Title: Billing Person Name
    Read Only: true
    Maximum Length: 255
    Name of the worker associated with the transaction.
  • Title: Billing Person Title Override
    Maximum Length: 80
    Override of the billing person name, if specified in the Job Assignment Overrides of the bill plan.
  • Title: Billing Resource Name
    Read Only: true
    Maximum Length: 240
    Name of the billing resource associated with the transaction.
  • Title: Billing Status
    Read Only: true
    Maximum Length: 80
    The billing status of a bill transaction. The billing status indicates where a bill transaction is within the billing lifecycle.
  • Title: Billing Status Code
    Maximum Length: 30
    The unique code of the billing status of a bill transaction. The billing status indicates where a bill transaction is within the billing lifecycle.
  • Title: Billing Type
    Read Only: true
    Maximum Length: 80
    The type of billing applicable for the transaction. For example, external customer billing versus internal intercompany billing.
  • Title: Billing Type Code
    Maximum Length: 30
    Identifier for the billing type, decoded using the lookup type PJB_BILLING_TYPE.
  • Title: Bill Plan Id
    Read Only: true
    Unique identifier for the bill plan associated with the transaction.
  • Title: Bill Plan Name
    Read Only: true
    Maximum Length: 30
    Bill plan name associated with the transaction.
  • Title: Transaction Currency Project Cost Bill Rate
    The rate at which project cost transactions are invoiced or recognize revenue, in bill transaction currency.
  • Title: Bill-to Customer
    Read Only: true
    Maximum Length: 360
    The customer who will be charged for the transaction, as per the bill plan associated with the contract line.
  • Title: Bill Transaction Id
    The unique identifier for project contract bill transactions.
  • Title: Invoice Concession Percentage
    The concession percentage applied to the transaction.
  • Title: Contract Business Unit Id
    Read Only: true
    Unique identifier of the business unit that owns the contract associated with the bill transaction.
  • Title: Contract Business Unit
    Read Only: true
    Maximum Length: 240
    Name of the business unit that owns the contract associated with the bill transaction.
  • Title: Contract Contribution Percentage
    The percentage of the bill transaction that will be billed against the contract, as defined in the billing setup of the contract.
  • Title: Contract Currency Code
    Maximum Length: 30
    The currency of the contract, as negotiated between the seller and the buyer (customer). This would be the currency of the negotiated price for fixed price contract lines, the currency of the funded amount by associated project and task for project-based fixed price contract lines, and the currency of all applicable hard limits for rate-based contract lines.
  • Title: Contract Currency Invoice Concession Amount
    The total amount of invoice concessions applied in contract currency.
  • Title: Contract Currency Invoice Amount
    The total amount that can be invoiced in contract currency, prior to the contract contribution percentage being applied or funds availability being checked.
  • Title: Contract Currency Invoice Credited Amount
    The total amount of invoice credits applied, other than concessions and write-offs, in contract currency.
  • Title: Contract Currency Invoiced Amount
    The total amount already invoiced to the customer in contract currency.
  • Title: Contract Currency Invoice Eligible Amount
    The amount that can be invoiced in contract currency, after the contract contribution percentage has been applied, but prior to funds availability being checked.
  • Title: Contract Currency Invoice Exchange Date
    The exchange rate date for conversions between contract and invoice currency.
  • Title: Contract Currency Invoice Exchange Rate
    The exchange rate for conversions between contract and invoice currency.
  • Title: Contract Currency Invoice Qualified Amount
    The eligible amount remaining to be invoiced to the customer in contract currency, taking into account the funds that are available.
  • Title: Contract Currency Invoice Rate Type
    Read Only: true
    Maximum Length: 30
    The name of the rate type used to convert between contract currency and invoice currency.
  • Title: Contract Currency Invoice Rate Type Code
    Maximum Length: 30
    Identifier for the rate type used to convert between contract currency and invoice currency.
  • Title: Contract Currency Revenue Amount
    The total amount of revenue that can be recognized in contract currency, prior to the contract contribution percentage being applied or funds availability being checked.
  • Title: Contract Currency Revenue Credited Amount
    The total amount of revenue credits applied in contract currency.
  • Title: Contract Currency Revenue Eligible Amount
    The amount of revenue that can be recognized in contract currency, after the contract contribution percentage has been applied, but prior to funds availability being checked.
  • Title: Contract Currency Revenue Exchange Date
    The exchange rate date for conversions between contract and revenue currency.
  • Title: Contract Currency Revenue Exchange Rate
    The exchange rate for conversions between contract and revenue currency.
  • Title: Contract Currency Revenue Qualified Amount
    The eligible amount of revenue remaining to be recognized in contract currency, taking into account the funds that are available.
  • Title: Contract Currency Revenue Rate Type
    Read Only: true
    Maximum Length: 30
    The name of the rate type used to convert between contract currency and revenue currency.
  • Title: Contract Currency Revenue Rate Type Code
    Maximum Length: 30
    Identifier for the rate type used to convert between contract currency and revenue currency.
  • Title: Contract Currency Revenue Recognized Amount
    The total amount of revenue already recognized in contract currency.
  • Title: Contract Currency Invoice Write-Off Amount
    The total amount of invoice write-offs applied in contract currency.
  • Title: Contract Id
    Read Only: true
    Unique identifier for the contract associated with the transaction.
  • Title: Contract Line Id
    Read Only: true
    Unique identifier for the contract line associated with the transaction.
  • Title: Contract Line Name
    Read Only: true
    Maximum Length: 1995
    Contract line name associated with the transaction.
  • Title: Contract Line Number
    Read Only: true
    Maximum Length: 150
    Contract line number associated with the transaction.
  • Title: Contract Major Version
    The major version of the contract associated with the bill transaction. The major version forms a composite key with contract-related keys such as Contract Id and Contract Line Id.
  • Title: Contract Name
    Read Only: true
    Maximum Length: 300
    Contract name associated with the transaction.
  • Title: Contract Number
    Read Only: true
    Maximum Length: 120
    Contract number associated with the transaction.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the transaction.
  • Title: Creation Date
    Read Only: true
    The date and time when the transaction was created.
  • Title: Customer Order Number
    Read Only: true
    Maximum Length: 50
    Customer purchase order (PO) number as per the contract line.
  • Title: Event Type Id
    Read Only: true
    Unique identifier of the event type for the billing event associated with the transaction.
  • Title: Event Type
    Read Only: true
    Maximum Length: 240
    Name of the billing event type for the billing event associated with the transaction.
  • Title: Expenditure Category Id
    Read Only: true
    Unique identifier of the expenditure category for the project cost associated with the transaction.
  • Title: Expenditure Category
    Read Only: true
    Maximum Length: 240
    Name of the expenditure category for the project cost associated with the transaction.
  • Title: Expenditure Type Id
    Read Only: true
    Unique identifier of the expenditure type for the project cost associated with the transaction.
  • Title: Expenditure Type
    Read Only: true
    Maximum Length: 240
    Name of the expenditure type for the project cost associated with the transaction.
  • Title: Inventory Item
    Read Only: true
    Maximum Length: 300
    The name of the inventory item associated with the transaction.
  • Title: Inventory Item Id
    Unique identifier for the inventory item associated with the transaction.
  • Title: Invoice Billed Percentage
    The cumulative percentage of the transaction that has been invoiced. If specified, the percentage is limited by the contribution percentage specified on the contract.
  • Title: Invoice Credited Quantity
    The total invoice quantity which has been credited, excluding concessions and write-offs.
  • Title: Invoice Currency Amount
    The total amount that can be invoiced in invoice currency, prior to the contract contribution percentage being applied or funds availability being checked.
  • Title: Invoice Currency Invoiced Amount
    The total amount already invoiced to the customer in invoice currency.
  • Title: Invoice Currency Code
    Maximum Length: 30
    The currency in which customer invoices will be denominated. The invoice currency is specified on the bill plan as either the bill transaction currency, the contract currency, or a specific currency preferred by the customer.
  • Title: Invoice Currency Concession Amount
    The total amount of invoice concessions applied in invoice currency.
  • Title: Invoice Currency Credited Amount
    The total amount of invoice credits applied, other than concessions and write-offs, in invoice currency.
  • Title: Invoice Currency Eligible Amount
    The amount that can be invoiced in invoice currency, after the contract contribution percentage has been applied, but prior to funds availability being checked.
  • Title: Invoice Currency Exchange Date
    The exchange rate date used to convert amounts to invoice currency. For example, transaction date.
  • Title: Invoice Currency Exchange Date Type Code
    Maximum Length: 30
    The identifier of the currency exchange date type used to convert amounts to invoice currency.
  • Title: Invoice Currency Exchange Rate
    The exchange rate used to convert amounts to invoice currency. For example, transaction date.
  • Title: Invoice Currency Qualified Amount
    The eligible amount remaining to be invoiced to the customer in invoice currency, taking into account the funds that are available.
  • Title: Invoice Currency Rate Type
    Read Only: true
    Maximum Length: 30
    The name of the currency rate type used to convert amounts to invoice currency.
  • Title: Invoice Currency Rate Type Code
    Maximum Length: 30
    The identifier of the currency rate type used to calculate amounts in invoice currency.
  • Title: Invoice Currency Write-Off Amount
    The total amount of invoice write-offs applied in invoice currency.
  • Title: Invoice Date
    The date of the customer invoice associated with the bill transaction.
  • Title: Invoice Discount Percent
    Percentage invoice discount, if specified on the bill plan.
  • Title: Invoice Discount Reason
    Read Only: true
    Maximum Length: 80
    The reason for an invoice rate discount, if specified on the bill plan. Also known as the Rate Change Reason.
  • Title: Invoice Discount Reason Code
    Maximum Length: 30
    Identifier for the invoice discount reason, decoded using the lookup type PJB_DISCOUNT_REASON.
  • Title: Invoice Distributed Code
    Maximum Length: 1
    Indicates whether an invoice distribution has been created for the qualified bill amount.
  • Title: Invoiced Quantity
    The total invoice quantity which has already been invoiced.
  • Title: Invoice Labor Multiplier
    Multiplier which scales labor invoice amounts, if specified on the bill plan.
  • Title: Invoice Markup Percent
    Percentage invoice markup, if specified on the source rate schedule (if applicable) or the bill plan.
  • Title: Invoice Method Classification Code
    Read Only: true
    Maximum Length: 30
    Unique identifier for the invoice method classification associated with the transaction.
  • Title: Invoice Method Id
    Read Only: true
    Unique identifier for the invoice method associated with the transaction.
  • Title: Invoice Net Zero Flag
    Indicates whether the transaction has been fully reversed for invoicing and therefore nets to zero.
  • Title: Invoice Qualified Quantity
    The remaining quantity eligible to be invoiced, taking into account the funds that are available.
  • Title: Invoice Quantity
    The total count of effort, products or services that can be invoiced to the customer. Context for the invoice quantity is provided by the unit of measure, for example, hours, days, miles.
  • Title: Invoice Rate Source Id
    Identifier for the invoice rate source associated with the transaction.
  • Title: Invoice Rate Source Type
    Read Only: true
    Maximum Length: 80
    Identifies the source of the rate for invoicing, for example a standard bill rate or an override.
  • Title: Invoice Rate Source Type Code
    Maximum Length: 30
    Identifier for the invoice rate source type, decoded using the lookup type PJB_RATE_SOURCE_TYPE_CODE.
  • Title: Invoice Transfer Price Rule Percentage
    The labor or nonlabor invoice markup or discount percentage of the transfer price rule associated with the transfer price schedule line. Only applies where the bill transaction is associated with a cross-charged project cost.
  • Title: Invoice Transfer Price Schedule Line Percentage
    The labor or nonlabor invoice markup or discount percentage of the transfer price schedule line. Only applies where the bill transaction is associated with a cross-charged project cost.
  • Title: Invoice Write-Off Percentage
    The write-off percentage applied to the transaction.
  • Title: Item Organization Id
    Unique identifier for the inventory item organization associated with the transaction.
  • Title: Last Update Date
    Read Only: true
    The date and time when the transaction was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the transaction.
  • Title: Linked Project Id
    Unique identifier of the project that's linked to the contract line associated with the transaction.
  • Title: Linked Project Name
    Read Only: true
    Maximum Length: 240
    Name of the project that's linked to the contract line associated with the transaction.
  • Title: Linked Project Number
    Read Only: true
    Maximum Length: 25
    Number of the project that's linked to the contract line associated with the transaction.
  • Title: Linked Task Id
    Unique identifier of the task (if any) that's linked to the contract line associated with the transaction.
  • Title: Linked Task Name
    Read Only: true
    Maximum Length: 255
    Name of the task that's linked to the contract line associated with the transaction.
  • Title: Linked Task Number
    Read Only: true
    Maximum Length: 100
    Number of the task that's linked to the contract line associated with the transaction.
  • Links
  • Title: Migration Flag
    Indicates whether the transaction was migrated from a legacy application.
  • Title: Net Credit Flag
    Identifies whether the transaction is subject to net credit invoicing. Requires the feature to be enabled using the administrator profile Net Credit Invoicing, and for net invoicing to be enabled on the contract.
  • Title: Nonlabor Resource
    Read Only: true
    Maximum Length: 240
    The name of the nonlabor resource associated with the transaction.
  • Title: Nonlabor Resource Id
    Read Only: true
    The identifier of the nonlabor resource associated with the transaction.
  • Title: Organization
    Read Only: true
    Maximum Length: 255
    The name of the organization associated with the transaction. For bill transactions associated with project costs, this will be the expenditure organization. For bill transactions associated with billing events, this will be the event organization.
  • Title: Organization Id
    The identifier of the organization associated with the transaction.
  • Title: Pending Invoice Adjustment Flag
    Indicates whether the transaction is pending an invoicing adjustment. For example, if a source project cost or event transaction has been adjusted.
  • Title: Pending Revenue Adjustment Flag
    Indicates whether the transaction is pending a revenue adjustment. For example, if a source project cost or event transaction has been adjusted.
  • Title: Project Id
    Unique identifier of the project associated with the transaction.
  • Title: Project Name
    Read Only: true
    Maximum Length: 240
    Name of the project associated with the transaction.
  • Title: Project Number
    Read Only: true
    Maximum Length: 25
    Number of the project associated with the transaction.
  • Title: Provider Legal Entity
    Read Only: true
    Maximum Length: 240
    The name of the legal entity to which the transaction belongs. For bill transactions associated with project costs, this would be the legal entity which owns the resource, also known as the provider legal entity.
  • Title: Provider Legal Entity Id
    Read Only: true
    Unique identifier of the legal entity to which the transaction belongs.
  • Title: Provider Legal Entity Identifier
    Read Only: true
    Maximum Length: 30
    A short name of the legal entity to which the transaction belongs.
  • Title: Billing Resource Element Id
    Unique identifier of the billing resource breakdown structure element.
  • Title: Recalculate Invoice Flag
    Indicates whether the transaction will be reprocessed when invoices are generated the next time.
  • Title: Recalculate Revenue Flag
    Indicates whether the transaction will be reprocessed when revenue is recognized the next time.
  • Title: Receiver Legal Entity
    Read Only: true
    Maximum Length: 240
    The name of the legal entity receiving the benefit of cross-charged project effort.
  • Title: Receiver Legal Entity Id
    Read Only: true
    Unique identifier of the receiver legal entity.
  • Title: Receiver Legal Entity Identifier
    Read Only: true
    Maximum Length: 30
    A short name of the legal entity receiving the benefit of cross-charged project effort.
  • Title: Revenue Category
    Read Only: true
    Maximum Length: 80
    The category of revenue recognized for the transaction, for example fixed price, labor costs, direct costs, fees.
  • Title: Revenue Category Code
    Maximum Length: 30
    Identifier for the revenue category, decoded using the lookup type PJF_REVENUE_CATEGORY.
  • Title: Revenue Currency Amount
    The total amount of revenue that can be recognized in revenue currency, prior to the contract contribution percentage being applied or funds availability being checked.
  • Title: Revenue Currency Credited Amount
    The total amount of revenue credits applied in revenue currency.
  • Title: Revenue Currency Eligible Amount
    The amount of revenue that can be recognized in revenue currency, after the contract contribution percentage has been applied, but prior to funds availability being checked.
  • Title: Revenue Currency Qualified Amount
    The eligible amount of remaining revenue that can be recognized in revenue currency, taking into account the funds that are available.
  • Title: Revenue Currency Recognized Amount
    The total amount of revenue already recognized in revenue currency.
  • Title: Revenue Discount Percent
    Percentage revenue discount, if specified on the revenue plan.
  • Title: Revenue Discount Reason
    Read Only: true
    Maximum Length: 80
    The reason for a revenue rate discount, if specified on the revenue plan. Also known as the Rate Change Reason.
  • Title: Revenue Discount Reason Code
    Maximum Length: 30
    Identifier for the revenue discount reason, decoded using the lookup type PJB_DISCOUNT_REASON.
  • Title: Revenue Labor Multiplier
    Multiplier which scales labor revenue amounts, if specified on the revenue plan.
  • Title: Revenue Markup Percent
    Percentage revenue markup, if specified on the source rate schedule (if applicable) or the revenue plan.
  • Title: Revenue Method Classification Code
    Read Only: true
    Maximum Length: 30
    Unique identifier for the revenue method classification associated with the transaction.
  • Title: Revenue Method Id
    Read Only: true
    Unique identifier for the revenue method associated with the transaction.
  • Title: Revenue Net Zero Flag
    Indicates whether the transaction has been fully reversed for revenue recognition and therefore nets to zero.
  • Title: Revenue Plan Id
    Read Only: true
    Unique identifier for the revenue plan associated with the transaction.
  • Title: Revenue Plan Name
    Read Only: true
    Maximum Length: 30
    Revenue plan name associated with the transaction.
  • Title: Revenue Qualified Quantity
    The remaining quantity eligible for revenue recognition, taking into account the funds that are available.
  • Title: Revenue Quantity
    The total count of effort, products or services for which revenue can be recognized. Context for the revenue quantity is provided by the unit of measure, for example, hours, days, miles.
  • Title: Revenue Rate Source Id
    Identifier for the revenue rate source associated with the transaction.
  • Title: Revenue Rate Source Type
    Read Only: true
    Maximum Length: 80
    Identifies the source of the rate for revenue recognition, for example a standard bill rate or an override.
  • Title: Revenue Rate Source Type Code
    Maximum Length: 30
    Identifier for the revenue rate source type, decoded using the lookup type PJB_RATE_SOURCE_TYPE_CODE.
  • Title: Revenue Recognized
    Read Only: true
    Maximum Length: 80
    Indicates whether revenue has been recognized for the transaction.
  • Title: Revenue Recognized Code
    Maximum Length: 1
    Identifier for whether revenue has been recognized for the transaction, decoded using the lookup type PJB_EVT_REVENUE_RECOGNZD.
  • Title: Revenue Recognized Date
    The date on which revenue was last recognized for the bill transaction.
  • Title: Revenue Recognized Percentage
    The cumulative percentage of revenue recognized for the transaction. If specified, the percentage is limited by the contribution percentage specified on the contract.
  • Title: Revenue Recognized Quantity
    The total revenue quantity which has already been recognized.
  • Title: Revenue Transfer Price Rule Percentage
    The labor or nonlabor revenue markup or discount percentage of the transfer price rule associated with the transfer price schedule line. Only applies where the bill transaction is associated with a cross-charged project cost.
  • Title: Revenue Transfer Price Schedule Line Percentage
    The labor or nonlabor revenue markup or discount percentage of the transfer price schedule line. Only applies where the bill transaction is associated with a cross-charged project cost.
  • Title: Source Transaction Id
    Unique identifier of the source transaction related to the bill transaction.
  • Title: Source Transaction Number
    Read Only: true
    Number of the source transaction related to the bill transaction.
  • Title: Source Transaction Type
    Read Only: true
    Maximum Length: 80
    Identifies the source transaction type, if applicable. For example, a project cost or billing event.
  • Title: Source Transaction Type Code
    Maximum Length: 30
    Identifier for the source transaction type, if applicable. Decoded using the lookup type PJB_BILL_TRANSACTION_TYPE.
  • Title: Task Id
    Unique identifier of the task associated with the transaction.
  • Title: Task Name
    Read Only: true
    Maximum Length: 255
    Name of the task associated with the transaction.
  • Title: Task Number
    Read Only: true
    Maximum Length: 100
    Number of the task associated with the transaction.
  • Title: Transaction Currency Invoiced Amount
    The total amount already invoiced to the customer in transaction currency.
  • Title: Transaction Currency Code
    Maximum Length: 30
    The currency in which bill rates are derived and bill amounts are initially calculated for source transactions. Where bill amounts are calculated as a markup or burden applied to project costs, this would be the currency of the cost transaction. Else, where bill amounts are derived from user-specified bill rates, the transaction currency would be the currency of the bill rate schedule or the currency of the bill rate override. Finally, where bill amounts are derived from rate-based billing events, the transaction currency would be the user-overridden currency defined on the billing event.
  • Title: Transaction Currency Invoice Concession Amount
    The total amount of invoice concessions applied in transaction currency.
  • Title: Transaction Currency Invoice Credited Amount
    The total amount of invoice credits applied, other than concessions and write-offs, in transaction currency.
  • Title: Transaction Currency Invoice Eligible Amount
    The amount that can be invoiced in transaction currency, after the contract contribution percentage has been applied, but prior to funds availability being checked.
  • Title: Transaction Currency Invoice Qualified Amount
    The eligible amount remaining to be invoiced to the customer in transaction currency, taking into account the funds that are available.
  • Title: Transaction Currency Invoice Amount
    The total amount that can be invoiced in transaction currency, prior to the contract contribution percentage being applied or funds availability being checked.
  • Title: Transaction Currency Invoice Unit Price
    The unit price of the effort, products or services that can be invoiced to the customer, in transaction currency. Only populated for item-based billing events or bill rate-based labor transactions.
  • Title: Transaction Currency Revenue Amount
    The total amount of revenue that can be recognized in transaction currency, prior to the contract contribution percentage being applied or funds availability being checked.
  • Title: Transaction Currency Revenue Credited Amount
    The total amount of revenue credits applied in transaction currency.
  • Title: Transaction Currency Revenue Eligible Amount
    The amount of revenue that can be recognized in transaction currency, after the contract contribution percentage has been applied, but prior to funds availability being checked.
  • Title: Transaction Currency Revenue Qualified Amount
    The eligible amount of remaining revenue that can be recognized in transaction currency, taking into account the funds that are available.
  • Title: Transaction Currency Revenue Recognized Amount
    The total amount of revenue already recognized in transaction currency.
  • Title: Transaction Currency Revenue Unit Price
    The unit price of the effort, products or services for which revenue can be recognized, in transaction currency. Only populated for item-based billing events or bill rate-based labor transactions.
  • Title: Transaction Currency Invoice Write-Off Amount
    The total amount of invoice write-offs applied in transaction currency.
  • Title: Transaction Date
    The date on which the transaction occurred. For example, the date on which time was worked on a billable project.
  • Title: Transfer Price Basis Amount
    Transfer price basis amount, which will either be the raw cost, burdened cost or external revenue amount depending on the transfer price rule basis. Only applies where the bill transaction is associated with a cross-charged project cost.
  • Title: Transfer Price Rule Basis
    Read Only: true
    Maximum Length: 80
    Specifies the basis method for transfer price amount calculation, for example transfer price is based on burdened cost, raw cost or external revenue. Only applies where the bill transaction is associated with a cross-charged project cost.
  • Title: Transfer Price Rule Basis Code
    Maximum Length: 30
    Identifier for the transfer price rule basis code, decoded using the lookup type PJF_TP_RULE_BASE_CODE.
  • Title: Transfer Price Schedule Amount Type
    Read Only: true
    Maximum Length: 80
    Indicates if the transfer price schedule line is a cost transfer or revenue transfer. Only applies where the bill transaction is associated with a cross-charged project cost.
  • Title: Transfer Price Schedule Amount Type Code
    Maximum Length: 30
    Identifier for the transfer price schedule amount type, decoded using the lookup type PJF_TP_AMT_TYPE_CODE.
  • Title: Unit of Measure
    Read Only: true
    Maximum Length: 80
    Name of the unit of measure associated with the transaction. The unit of measure provides context to the invoice and revenue quantity, for example hours, days, miles, each.
  • Title: Unit of Measure Code
    Maximum Length: 30
    Identifier of the unit of measure associated with the transaction.
  • Title: Unit Price in Contract Currency
    For transactions priced on a rate basis, the price per unit quantity in contract currency. For transactions which aren't priced on a rate basis, such as fixed price amounts, cost markups or discounts, the unit price equals the amount to bill in contract currency.
  • Title: Unit Price in Invoice Currency
    For transactions priced on a rate basis, the price per unit quantity in invoice currency. For transactions which aren't priced on a rate basis, such as fixed price amounts, cost markups or discounts, the unit price equals the amount to bill in invoice currency.
  • Title: Work Type
    Read Only: true
    Maximum Length: 240
    The work type associated with the transaction.
  • Title: Work Type Id
    Read Only: true
    Unique identifier of the work type associated with the transaction.
Back to Top

Examples

The following example shows how to get a project contract bill transaction 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/projectContractBillTransactions/100101517311777?fields=BillTransactionId,BillingType,TransactionDate,SourceTransactionType,SourceTransactionNumber,ContractNumber,ProjectNumber,BillingPersonName,BillingJobName,InvoiceQuantity,InvoicedQuantity,UnitOfMeasure,TransactionCurrencyCode,TransactionCurrencyInvoiceUnitPrice,TransactionCurrencyInvoiceEligibleAmount,TransactionCurrencyBilledAmount,InvoiceCurrencyCode,InvoiceCurrencyEligibleAmount,InvoiceCurrencyBilledAmount

Example of Response Body

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

{
    "BillTransactionId": 100101517311777,
    "BillingType": "External",
    "TransactionDate": "2022-02-03",
    "SourceTransactionType": "Expenditure item",
    "SourceTransactionNumber": 7960908,
    "ContractNumber": "2022_HILASSOC_1",
    "ProjectNumber": "2022_HILASSOC_1",
    "BillingPersonName": "Markum, Jenna",
    "BillingJobName": "PCN500.Principal Consultant",
    "InvoiceQuantity": 160,
    "InvoicedQuantity": null,
    "UnitOfMeasure": "Hours",
    "TransactionCurrencyCode": "USD",
    "TransactionCurrencyInvoiceUnitPrice": 45.12232,
    "TransactionCurrencyInvoiceEligibleAmount": 7219.57,
    "TransactionCurrencyBilledAmount": null,
    "InvoiceCurrencyCode": "USD",
    "InvoiceCurrencyEligibleAmount": 7219.57,
    "InvoiceCurrencyBilledAmount": null,
    "links": [
        {
            "rel": "self",
            "href": "https://your_organization.com: port/fscmRestApi/resources/11.13.18.05/projectContractBillTransactions/100101517311777",
            "name": "projectContractBillTransactions",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000678"
            }
        },
        {
            "rel": "canonical",
            "href": "https://your_organization.com: port/fscmRestApi/resources/11.13.18.05/projectContractBillTransactions/100101517311777",
            "name": "projectContractBillTransactions",
            "kind": "item"
        }
    ]
}
Back to Top