Get many project contract bill transactions
get
/fscmRestApi/resources/11.13.18.05/projectContractBillTransactions
Request
Query Parameters
-
effectiveDate: string
This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
-
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 a project contract bill transaction using the primary key.
Finder Variables- BillTransactionId; integer; The primary key for project contract bill transactions.
- PrimaryKey Finds a project contract bill transaction using the primary key.
-
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:- BillPlanId; integer; Unique identifier for the bill plan associated with the transaction.
- BillPlanName; string; Bill plan name associated with the transaction.
- BillRate; number; The rate at which project cost transactions are invoiced or recognize revenue, in bill transaction currency.
- BillTransactionId; integer; The unique identifier for project contract bill transactions.
- BillingEventId; integer; Unique identifier of the billing event associated with the transaction.
- BillingJobCode; string; Short code of the billing job associated with the transaction.
- BillingJobId; integer; Unique identifier of the billing job associated with the transaction.
- BillingJobName; string; Name of the billing job associated with the transaction.
- BillingJobTitleOverride; string; Override of the billing job name, if specified in the Job Title Overrides of the bill plan.
- BillingPersonId; integer; Unique identifier of the worker associated with the transaction.
- BillingPersonName; string; Name of the worker associated with the transaction.
- BillingPersonTitleOverride; string; Override of the billing person name, if specified in the Job Assignment Overrides of the bill plan.
- BillingResourceName; string; Name of the billing resource associated with the transaction.
- BillingType; string; The type of billing applicable for the transaction. For example, external customer billing versus internal intercompany billing.
- BillingTypeCode; string; Identifier for the billing type, decoded using the lookup type PJB_BILLING_TYPE.
- ConcessionPercentage; number; The concession percentage applied to the transaction.
- ContractBusinessUnitId; integer; Unique identifier of the business unit that owns the contract associated with the bill transaction.
- ContractBusinessUnitName; string; Name of the business unit that owns the contract associated with the bill transaction.
- ContractContributionPercentage; number; The percentage of the bill transaction that will be billed against the contract, as defined in the billing setup of the contract.
- ContractCurrencyCode; string; 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.
- ContractCurrencyConcessionAmount; number; The total amount of invoice concessions applied in contract currency.
- ContractCurrencyInvoiceAmount; number; The total amount that can be invoiced in contract currency, prior to the contract contribution percentage being applied or funds availability being checked.
- ContractCurrencyInvoiceCreditAmount; number; The total amount of invoice credits applied, other than concessions and write-offs, in contract currency.
- ContractCurrencyInvoiceEligibleAmount; number; The amount that can be invoiced in contract currency, after the contract contribution percentage has been applied, but prior to funds availability being checked.
- ContractCurrencyInvoiceExchangeDate; string; The exchange rate date for conversions between contract and invoice currency.
- ContractCurrencyInvoiceExchangeRate; number; The exchange rate for conversions between contract and invoice currency.
- ContractCurrencyInvoiceQualifiedAmount; number; The eligible amount remaining to be invoiced to the customer in contract currency, taking into account the funds that are available.
- ContractCurrencyInvoiceRateType; string; The name of the rate type used to convert between contract currency and invoice currency.
- ContractCurrencyInvoiceRateTypeCode; string; Identifier for the rate type used to convert between contract currency and invoice currency.
- ContractCurrencyInvoicedAmount; number; The total amount already invoiced to the customer in contract currency.
- ContractCurrencyRevenueAmount; number; 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.
- ContractCurrencyRevenueCreditedAmount; number; The total amount of revenue credits applied in contract currency.
- ContractCurrencyRevenueEligibleAmount; number; 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.
- ContractCurrencyRevenueExchangeDate; string; The exchange rate date for conversions between contract and revenue currency.
- ContractCurrencyRevenueExchangeRate; number; The exchange rate for conversions between contract and revenue currency.
- ContractCurrencyRevenueQualifiedAmount; number; The eligible amount of revenue remaining to be recognized in contract currency, taking into account the funds that are available.
- ContractCurrencyRevenueRateType; string; The name of the rate type used to convert between contract currency and revenue currency.
- ContractCurrencyRevenueRateTypeCode; string; Identifier for the rate type used to convert between contract currency and revenue currency.
- ContractCurrencyRevenueRecognizedAmount; number; The total amount of revenue already recognized in contract currency.
- ContractCurrencyWriteoffAmount; number; The total amount of invoice write-offs applied in contract currency.
- ContractId; integer; Unique identifier for the contract associated with the transaction.
- ContractLineId; integer; Unique identifier for the contract line associated with the transaction.
- ContractLineName; string; Contract line name associated with the transaction.
- ContractLineNumber; string; Contract line number associated with the transaction.
- ContractMajorVersion; integer; 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.
- ContractName; string; Contract name associated with the transaction.
- ContractNumber; string; Contract number associated with the transaction.
- CreatedBy; string; The user who created the transaction.
- CreationDate; string; The date and time when the transaction was created.
- CustomerPONumber; string; Customer purchase order (PO) number as per the contract line.
- EventTypeId; integer; Unique identifier of the event type for the billing event associated with the transaction.
- EventTypeName; string; Name of the billing event type for the billing event associated with the transaction.
- ExpenditureCategoryId; integer; Unique identifier of the expenditure category for the project cost associated with the transaction.
- ExpenditureCategoryName; string; Name of the expenditure category for the project cost associated with the transaction.
- ExpenditureTypeName; string; Name of the expenditure type for the project cost associated with the transaction.
- InventoryItem; string; The name of the inventory item associated with the transaction.
- InventoryItemId; integer; Unique identifier for the inventory item associated with the transaction.
- InvoiceBilledPercentage; number; The cumulative percentage of the transaction that has been invoiced. If specified, the percentage is limited by the contribution percentage specified on the contract.
- InvoiceCreditedQuantity; number; The total invoice quantity which has been credited, excluding concessions and write-offs.
- InvoiceCurrencyAmount; number; The total amount that can be invoiced in invoice currency, prior to the contract contribution percentage being applied or funds availability being checked.
- InvoiceCurrencyBilledAmount; number; The total amount already invoiced to the customer in invoice currency.
- InvoiceCurrencyCode; string; 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.
- InvoiceCurrencyConcessionAmount; number; The total amount of invoice concessions applied in invoice currency.
- InvoiceCurrencyCreditedAmount; number; The total amount of invoice credits applied, other than concessions and write-offs, in invoice currency.
- InvoiceCurrencyEligibleAmount; number; The amount that can be invoiced in invoice currency, after the contract contribution percentage has been applied, but prior to funds availability being checked.
- InvoiceCurrencyExchangeDate; string; The exchange rate date used to convert amounts to invoice currency. For example, transaction date.
- InvoiceCurrencyExchangeDateTypeCode; string; The identifier of the currency exchange date type used to convert amounts to invoice currency.
- InvoiceCurrencyExchangeRate; number; The exchange rate used to convert amounts to invoice currency. For example, transaction date.
- InvoiceCurrencyQualifiedAmount; number; The eligible amount remaining to be invoiced to the customer in invoice currency, taking into account the funds that are available.
- InvoiceCurrencyRateType; string; The name of the currency rate type used to convert amounts to invoice currency.
- InvoiceCurrencyRateTypeCode; string; The identifier of the currency rate type used to calculate amounts in invoice currency.
- InvoiceCurrencyWriteoffAmount; number; The total amount of invoice write-offs applied in invoice currency.
- InvoiceDate; string; The date of the customer invoice associated with the bill transaction.
- InvoiceDiscountPercentage; number; Percentage invoice discount, if specified on the bill plan.
- InvoiceDiscountReason; string; The reason for an invoice rate discount, if specified on the bill plan. Also known as the Rate Change Reason.
- InvoiceDiscountReasonCode; string; Identifier for the invoice discount reason, decoded using the lookup type PJB_DISCOUNT_REASON.
- InvoiceDistributedCode; string; Indicates whether an invoice distribution has been created for the qualified bill amount.
- InvoiceLaborMultiplier; number; Multiplier which scales labor invoice amounts, if specified on the bill plan.
- InvoiceMarkupPercentage; number; Percentage invoice markup, if specified on the source rate schedule (if applicable) or the bill plan.
- InvoiceMethodClassificationCode; string; Unique identifier for the invoice method classification associated with the transaction.
- InvoiceMethodId; integer; Unique identifier for the invoice method associated with the transaction.
- InvoiceQualifiedQuantity; number; The remaining quantity eligible to be invoiced, taking into account the funds that are available.
- InvoiceQuantity; number; 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.
- InvoiceRateSourceId; integer; Identifier for the invoice rate source associated with the transaction.
- InvoiceRateSourceType; string; Identifies the source of the rate for invoicing, for example a standard bill rate or an override.
- InvoiceRateSourceTypeCode; string; Identifier for the invoice rate source type, decoded using the lookup type PJB_RATE_SOURCE_TYPE_CODE.
- InvoiceTransferPriceRulePercentage; number; 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.
- InvoiceTransferPriceScheduleLinePercentage; number; 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.
- InvoiceWriteoffPercentage; number; The write-off percentage applied to the transaction.
- InvoicedQuantity; number; The total invoice quantity which has already been invoiced.
- ItemOrganizationId; integer; Unique identifier for the inventory item organization associated with the transaction.
- LastUpdateDate; string; The date and time when the transaction was last updated.
- LastUpdatedBy; string; The user who last updated the transaction.
- LinkedProjectId; integer; Unique identifier of the project that's linked to the contract line associated with the transaction.
- LinkedProjectName; string; Name of the project that's linked to the contract line associated with the transaction.
- LinkedProjectNumber; string; Number of the project that's linked to the contract line associated with the transaction.
- LinkedTaskId; integer; Unique identifier of the task (if any) that's linked to the contract line associated with the transaction.
- LinkedTaskName; string; Name of the task that's linked to the contract line associated with the transaction.
- LinkedTaskNumber; string; Number of the task that's linked to the contract line associated with the transaction.
- NetCreditFlag; boolean; 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.
- NonlaborResource; string; The name of the nonlabor resource associated with the transaction.
- NonlaborResourceId; integer; The identifier of the nonlabor resource associated with the transaction.
- OrganizationId; integer; The identifier of the organization associated with the transaction.
- PendingInvoiceAdjustmentFlag; boolean; Indicates whether the transaction is pending an invoicing adjustment. For example, if a source project cost or event transaction has been adjusted.
- ProjectId; integer; Unique identifier of the project associated with the transaction.
- ProjectName; string; Name of the project associated with the transaction.
- ProjectNumber; string; Number of the project associated with the transaction.
- ProviderLegalEntity; string; 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.
- ProviderLegalEntityId; integer; Unique identifier of the legal entity to which the transaction belongs.
- ProviderLegalEntityIdentifier; string; A short name of the legal entity to which the transaction belongs.
- RBSElementId; integer; Unique identifier of the billing resource breakdown structure element.
- RecalculateInvoiceFlag; boolean; Indicates whether the transaction will be reprocessed when invoices are generated the next time.
- RecalculateRevenueFlag; boolean; Indicates whether the transaction will be reprocessed when revenue is recognized the next time.
- ReceiverLegalEntity; string; The name of the legal entity receiving the benefit of cross-charged project effort.
- ReceiverLegalEntityId; integer; Unique identifier of the receiver legal entity.
- ReceiverLegalEntityIdentifier; string; A short name of the legal entity receiving the benefit of cross-charged project effort.
- RevenueCategory; string; The category of revenue recognized for the transaction, for example fixed price, labor costs, direct costs, fees.
- RevenueCategoryCode; string; Identifier for the revenue category, decoded using the lookup type PJF_REVENUE_CATEGORY.
- RevenueCurrencyAmount; number; 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.
- RevenueCurrencyCreditedAmount; string; The total amount of revenue credits applied in revenue currency.
- RevenueCurrencyEligibleAmount; number; 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.
- RevenueCurrencyQualifiedAmount; number; The eligible amount of remaining revenue that can be recognized in revenue currency, taking into account the funds that are available.
- RevenueCurrencyRecognizedAmount; number; The total amount of revenue already recognized in revenue currency.
- RevenueDiscountPercentage; number; Percentage revenue discount, if specified on the revenue plan.
- RevenueDiscountReason; string; The reason for a revenue rate discount, if specified on the revenue plan. Also known as the Rate Change Reason.
- RevenueDiscountReasonCode; string; Identifier for the revenue discount reason, decoded using the lookup type PJB_DISCOUNT_REASON.
- RevenueLaborMultiplier; number; Multiplier which scales labor revenue amounts, if specified on the revenue plan.
- RevenueMarkupPercentage; number; Percentage revenue markup, if specified on the source rate schedule (if applicable) or the revenue plan.
- RevenueMethodClassificationCode; string; Unique identifier for the revenue method classification associated with the transaction.
- RevenueMethodId; integer; Unique identifier for the revenue method associated with the transaction.
- RevenuePlanId; integer; Unique identifier for the revenue plan associated with the transaction.
- RevenuePlanName; string; Revenue plan name associated with the transaction.
- RevenueQualifiedQuantity; number; The remaining quantity eligible for revenue recognition, taking into account the funds that are available.
- RevenueQuantity; number; 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.
- RevenueRateSourceId; integer; Identifier for the revenue rate source associated with the transaction.
- RevenueRateSourceType; string; Identifies the source of the rate for revenue recognition, for example a standard bill rate or an override.
- RevenueRateSourceTypeCode; string; Identifier for the revenue rate source type, decoded using the lookup type PJB_RATE_SOURCE_TYPE_CODE.
- RevenueRecognized; string; Indicates whether revenue has been recognized for the transaction.
- RevenueRecognizedCode; string; Identifier for whether revenue has been recognized for the transaction, decoded using the lookup type PJB_EVT_REVENUE_RECOGNZD.
- RevenueRecognizedDate; string; The date on which revenue was last recognized for the bill transaction.
- RevenueRecognizedPercentage; number; The cumulative percentage of revenue recognized for the transaction. If specified, the percentage is limited by the contribution percentage specified on the contract.
- RevenueRecognizedQuantity; number; The total revenue quantity which has already been recognized.
- RevenueTransferPriceRulePercentage; number; 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.
- RevenueTransferPriceScheduleLinePercentage; number; 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.
- SourceTransactionId; integer; Unique identifier of the source transaction related to the bill transaction.
- SourceTransactionType; string; Identifies the source transaction type, if applicable. For example, a project cost or billing event.
- SourceTransactionTypeCode; string; Identifier for the source transaction type, if applicable. Decoded using the lookup type PJB_BILL_TRANSACTION_TYPE.
- TaskId; integer; Unique identifier of the task associated with the transaction.
- TaskName; string; Name of the task associated with the transaction.
- TaskNumber; string; Number of the task associated with the transaction.
- TransactionCurrencyBilledAmount; number; The total amount already invoiced to the customer in transaction currency.
- TransactionCurrencyCode; string; 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.
- TransactionCurrencyConcessionAmount; number; The total amount of invoice concessions applied in transaction currency.
- TransactionCurrencyInvoiceCreditAmount; number; The total amount of invoice credits applied, other than concessions and write-offs, in transaction currency.
- TransactionCurrencyInvoiceEligibleAmount; number; The amount that can be invoiced in transaction currency, after the contract contribution percentage has been applied, but prior to funds availability being checked.
- TransactionCurrencyInvoiceQualifiedAmount; number; The eligible amount remaining to be invoiced to the customer in transaction currency, taking into account the funds that are available.
- TransactionCurrencyInvoiceTransactionAmount; number; The total amount that can be invoiced in transaction currency, prior to the contract contribution percentage being applied or funds availability being checked.
- TransactionCurrencyInvoiceUnitPrice; number; The unit price of the effort, products or services that can be invoiced to the customer, in transaction currency.
- TransactionCurrencyRevenueAmount; number; 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.
- TransactionCurrencyRevenueCreditedAmount; number; The total amount of revenue credits applied in transaction currency.
- TransactionCurrencyRevenueEligibleAmount; number; 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.
- TransactionCurrencyRevenueQualifiedAmount; number; The eligible amount of remaining revenue that can be recognized in transaction currency, taking into account the funds that are available.
- TransactionCurrencyRevenueRecognizedAmount; number; The total amount of revenue already recognized in transaction currency.
- TransactionCurrencyRevenueUnitPrice; number; The unit price of the effort, products or services for which revenue can be recognized, in transaction currency.
- TransactionCurrencyWriteoffAmount; number; The total amount of invoice write-offs applied in transaction currency.
- TransactionDate; string; The date on which the transaction occurred. For example, the date on which time was worked on a billable project.
- TransferPriceBaseAmount; number; 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.
- TransferPriceRuleBasis; string; 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.
- TransferPriceRuleBasisCode; string; Identifier for the transfer price rule basis code, decoded using the lookup type PJF_TP_RULE_BASE_CODE.
- TransferPriceScheduleAmountType; string; 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.
- TransferPriceScheduleAmountTypeCode; string; Identifier for the transfer price schedule amount type, decoded using the lookup type PJF_TP_AMT_TYPE_CODE.
- UnitOfMeasure; string; 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.
- UnitOfMeasureCode; string; Identifier of the unit of measure associated with the transaction.
- WorkType; string; The work type associated with the transaction.
- WorkTypeId; integer; Unique identifier of the work type associated with the transaction.
-
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
-
Effective-Of:
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. -
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : projectContractBillTransactions
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectContractBillTransactions-item-response
Type:
Show Source
object
-
BillingEventId: integer
(int64)
Title:
Billing Event Id
Read Only:true
Unique identifier of the billing event associated with the transaction. -
BillingJobCode: string
Title:
Billing Job Code
Read Only:true
Maximum Length:30
Short code of the billing job associated with the transaction. -
BillingJobId: integer
(int64)
Title:
Billing Job Id
Read Only:true
Unique identifier of the billing job associated with the transaction. -
BillingJobName: string
Title:
Billing Job Name
Read Only:true
Maximum Length:240
Name of the billing job associated with the transaction. -
BillingJobTitleOverride: string
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. -
BillingPersonId: integer
(int64)
Title:
Billing Person Id
Read Only:true
Unique identifier of the worker associated with the transaction. -
BillingPersonName: string
Title:
Billing Person Name
Read Only:true
Maximum Length:255
Name of the worker associated with the transaction. -
BillingPersonTitleOverride: string
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. -
BillingResourceName: string
Title:
Billing Resource Name
Read Only:true
Maximum Length:240
Name of the billing resource associated with the transaction. -
BillingType: string
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. -
BillingTypeCode: string
Title:
Billing Type Code
Maximum Length:30
Identifier for the billing type, decoded using the lookup type PJB_BILLING_TYPE. -
BillPlanId: integer
(int64)
Title:
Bill Plan Id
Read Only:true
Unique identifier for the bill plan associated with the transaction. -
BillPlanName: string
Title:
Bill Plan Name
Read Only:true
Maximum Length:30
Bill plan name associated with the transaction. -
BillRate: number
Title:
Transaction Currency Project Cost Bill Rate
The rate at which project cost transactions are invoiced or recognize revenue, in bill transaction currency. -
BillTransactionId: integer
(int64)
Title:
Bill Transaction Id
The unique identifier for project contract bill transactions. -
ConcessionPercentage: number
Title:
Invoice Concession Percentage
The concession percentage applied to the transaction. -
ContractBusinessUnitId: integer
(int64)
Title:
Contract Business Unit Id
Read Only:true
Unique identifier of the business unit that owns the contract associated with the bill transaction. -
ContractBusinessUnitName: string
Title:
Contract Business Unit
Read Only:true
Maximum Length:240
Name of the business unit that owns the contract associated with the bill transaction. -
ContractContributionPercentage: number
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. -
ContractCurrencyCode: string
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. -
ContractCurrencyConcessionAmount: number
Title:
Contract Currency Invoice Concession Amount
The total amount of invoice concessions applied in contract currency. -
ContractCurrencyInvoiceAmount: number
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. -
ContractCurrencyInvoiceCreditAmount: number
Title:
Contract Currency Invoice Credited Amount
The total amount of invoice credits applied, other than concessions and write-offs, in contract currency. -
ContractCurrencyInvoicedAmount: number
Title:
Contract Currency Invoiced Amount
The total amount already invoiced to the customer in contract currency. -
ContractCurrencyInvoiceEligibleAmount: number
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. -
ContractCurrencyInvoiceExchangeDate: string
(date)
Title:
Contract Currency Invoice Exchange Date
The exchange rate date for conversions between contract and invoice currency. -
ContractCurrencyInvoiceExchangeRate: number
Title:
Contract Currency Invoice Exchange Rate
The exchange rate for conversions between contract and invoice currency. -
ContractCurrencyInvoiceQualifiedAmount: number
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. -
ContractCurrencyInvoiceRateType: string
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. -
ContractCurrencyInvoiceRateTypeCode: string
Title:
Contract Currency Invoice Rate Type Code
Maximum Length:30
Identifier for the rate type used to convert between contract currency and invoice currency. -
ContractCurrencyRevenueAmount: number
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. -
ContractCurrencyRevenueCreditedAmount: number
Title:
Contract Currency Revenue Credited Amount
The total amount of revenue credits applied in contract currency. -
ContractCurrencyRevenueEligibleAmount: number
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. -
ContractCurrencyRevenueExchangeDate: string
(date)
Title:
Contract Currency Revenue Exchange Date
The exchange rate date for conversions between contract and revenue currency. -
ContractCurrencyRevenueExchangeRate: number
Title:
Contract Currency Revenue Exchange Rate
The exchange rate for conversions between contract and revenue currency. -
ContractCurrencyRevenueQualifiedAmount: number
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. -
ContractCurrencyRevenueRateType: string
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. -
ContractCurrencyRevenueRateTypeCode: string
Title:
Contract Currency Revenue Rate Type Code
Maximum Length:30
Identifier for the rate type used to convert between contract currency and revenue currency. -
ContractCurrencyRevenueRecognizedAmount: number
Title:
Contract Currency Revenue Recognized Amount
The total amount of revenue already recognized in contract currency. -
ContractCurrencyWriteoffAmount: number
Title:
Contract Currency Invoice Write-Off Amount
The total amount of invoice write-offs applied in contract currency. -
ContractId: integer
(int64)
Title:
Contract Id
Read Only:true
Unique identifier for the contract associated with the transaction. -
ContractLineId: integer
(int64)
Title:
Contract Line Id
Read Only:true
Unique identifier for the contract line associated with the transaction. -
ContractLineName: string
Title:
Contract Line Name
Read Only:true
Maximum Length:1995
Contract line name associated with the transaction. -
ContractLineNumber: string
Title:
Contract Line Number
Read Only:true
Maximum Length:150
Contract line number associated with the transaction. -
ContractMajorVersion: integer
(int64)
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. -
ContractName: string
Title:
Contract Name
Read Only:true
Maximum Length:300
Contract name associated with the transaction. -
ContractNumber: string
Title:
Contract Number
Read Only:true
Maximum Length:120
Contract number associated with the transaction. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the transaction. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the transaction was created. -
CustomerPONumber: string
Title:
Customer Order Number
Read Only:true
Maximum Length:50
Customer purchase order (PO) number as per the contract line. -
EventTypeId: integer
(int64)
Title:
Event Type Id
Read Only:true
Unique identifier of the event type for the billing event associated with the transaction. -
EventTypeName: string
Title:
Event Type
Read Only:true
Maximum Length:240
Name of the billing event type for the billing event associated with the transaction. -
ExpenditureCategoryId: integer
(int64)
Title:
Expenditure Category Id
Read Only:true
Unique identifier of the expenditure category for the project cost associated with the transaction. -
ExpenditureCategoryName: string
Title:
Expenditure Category
Read Only:true
Maximum Length:240
Name of the expenditure category for the project cost associated with the transaction. -
ExpenditureTypeId: integer
(int64)
Title:
Expenditure Type Id
Read Only:true
Unique identifier of the expenditure type for the project cost associated with the transaction. -
ExpenditureTypeName: string
Title:
Expenditure Type
Read Only:true
Maximum Length:240
Name of the expenditure type for the project cost associated with the transaction. -
InventoryItem: string
Title:
Inventory Item
Read Only:true
Maximum Length:300
The name of the inventory item associated with the transaction. -
InventoryItemId: integer
(int64)
Title:
Inventory Item Id
Unique identifier for the inventory item associated with the transaction. -
InvoiceBilledPercentage: number
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. -
InvoiceCreditedQuantity: number
Title:
Invoice Credited Quantity
The total invoice quantity which has been credited, excluding concessions and write-offs. -
InvoiceCurrencyAmount: number
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. -
InvoiceCurrencyBilledAmount: number
Title:
Invoice Currency Invoiced Amount
The total amount already invoiced to the customer in invoice currency. -
InvoiceCurrencyCode: string
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. -
InvoiceCurrencyConcessionAmount: number
Title:
Invoice Currency Concession Amount
The total amount of invoice concessions applied in invoice currency. -
InvoiceCurrencyCreditedAmount: number
Title:
Invoice Currency Credited Amount
The total amount of invoice credits applied, other than concessions and write-offs, in invoice currency. -
InvoiceCurrencyEligibleAmount: number
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. -
InvoiceCurrencyExchangeDate: string
(date)
Title:
Invoice Currency Exchange Date
The exchange rate date used to convert amounts to invoice currency. For example, transaction date. -
InvoiceCurrencyExchangeDateTypeCode: string
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. -
InvoiceCurrencyExchangeRate: number
Title:
Invoice Currency Exchange Rate
The exchange rate used to convert amounts to invoice currency. For example, transaction date. -
InvoiceCurrencyQualifiedAmount: number
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. -
InvoiceCurrencyRateType: string
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. -
InvoiceCurrencyRateTypeCode: string
Title:
Invoice Currency Rate Type Code
Maximum Length:30
The identifier of the currency rate type used to calculate amounts in invoice currency. -
InvoiceCurrencyWriteoffAmount: number
Title:
Invoice Currency Write-Off Amount
The total amount of invoice write-offs applied in invoice currency. -
InvoiceDate: string
(date)
Title:
Invoice Date
The date of the customer invoice associated with the bill transaction. -
InvoiceDiscountPercentage: number
Title:
Invoice Discount Percent
Percentage invoice discount, if specified on the bill plan. -
InvoiceDiscountReason: string
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. -
InvoiceDiscountReasonCode: string
Title:
Invoice Discount Reason Code
Maximum Length:30
Identifier for the invoice discount reason, decoded using the lookup type PJB_DISCOUNT_REASON. -
InvoiceDistributedCode: string
Title:
Invoice Distributed Code
Maximum Length:1
Indicates whether an invoice distribution has been created for the qualified bill amount. -
InvoicedQuantity: number
Title:
Invoiced Quantity
The total invoice quantity which has already been invoiced. -
InvoiceLaborMultiplier: number
Title:
Invoice Labor Multiplier
Multiplier which scales labor invoice amounts, if specified on the bill plan. -
InvoiceMarkupPercentage: number
Title:
Invoice Markup Percent
Percentage invoice markup, if specified on the source rate schedule (if applicable) or the bill plan. -
InvoiceMethodClassificationCode: string
Title:
Invoice Method Classification Code
Read Only:true
Maximum Length:30
Unique identifier for the invoice method classification associated with the transaction. -
InvoiceMethodId: integer
(int64)
Title:
Invoice Method Id
Read Only:true
Unique identifier for the invoice method associated with the transaction. -
InvoiceNetZeroFlag: boolean
Title:
Invoice Net Zero Flag
Indicates whether the transaction has been fully reversed for invoicing and therefore nets to zero. -
InvoiceQualifiedQuantity: number
Title:
Invoice Qualified Quantity
The remaining quantity eligible to be invoiced, taking into account the funds that are available. -
InvoiceQuantity: number
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. -
InvoiceRateSourceId: integer
(int64)
Title:
Invoice Rate Source Id
Identifier for the invoice rate source associated with the transaction. -
InvoiceRateSourceType: string
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. -
InvoiceRateSourceTypeCode: string
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. -
InvoiceTransferPriceRulePercentage: number
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. -
InvoiceTransferPriceScheduleLinePercentage: number
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. -
InvoiceWriteoffPercentage: number
Title:
Invoice Write-Off Percentage
The write-off percentage applied to the transaction. -
ItemOrganizationId: integer
(int64)
Title:
Item Organization Id
Unique identifier for the inventory item organization associated with the transaction. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the transaction was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the transaction. -
LinkedProjectId: integer
(int64)
Title:
Linked Project Id
Unique identifier of the project that's linked to the contract line associated with the transaction. -
LinkedProjectName: string
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. -
LinkedProjectNumber: string
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. -
LinkedTaskId: integer
(int64)
Title:
Linked Task Id
Unique identifier of the task (if any) that's linked to the contract line associated with the transaction. -
LinkedTaskName: string
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. -
LinkedTaskNumber: string
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
MigrationFlag: boolean
Title:
Migration Flag
Indicates whether the transaction was migrated from a legacy application. -
NetCreditFlag: boolean
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. -
NonlaborResource: string
Title:
Nonlabor Resource
Read Only:true
Maximum Length:240
The name of the nonlabor resource associated with the transaction. -
NonlaborResourceId: integer
(int64)
Title:
Nonlabor Resource Id
Read Only:true
The identifier of the nonlabor resource associated with the transaction. -
Organization: string
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. -
OrganizationId: integer
Title:
Organization Id
The identifier of the organization associated with the transaction. -
PendingInvoiceAdjustmentFlag: boolean
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. -
PendingRevenueAdjustmentFlag: boolean
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. -
ProjectId: integer
(int64)
Title:
Project Id
Unique identifier of the project associated with the transaction. -
ProjectName: string
Title:
Project Name
Read Only:true
Maximum Length:240
Name of the project associated with the transaction. -
ProjectNumber: string
Title:
Project Number
Read Only:true
Maximum Length:25
Number of the project associated with the transaction. -
ProviderLegalEntity: string
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. -
ProviderLegalEntityId: integer
(int64)
Title:
Provider Legal Entity Id
Read Only:true
Unique identifier of the legal entity to which the transaction belongs. -
ProviderLegalEntityIdentifier: string
Title:
Provider Legal Entity Identifier
Read Only:true
Maximum Length:30
A short name of the legal entity to which the transaction belongs. -
RBSElementId: integer
(int64)
Title:
Billing Resource Element Id
Unique identifier of the billing resource breakdown structure element. -
RecalculateInvoiceFlag: boolean
Title:
Recalculate Invoice Flag
Indicates whether the transaction will be reprocessed when invoices are generated the next time. -
RecalculateRevenueFlag: boolean
Title:
Recalculate Revenue Flag
Indicates whether the transaction will be reprocessed when revenue is recognized the next time. -
ReceiverLegalEntity: string
Title:
Receiver Legal Entity
Read Only:true
Maximum Length:240
The name of the legal entity receiving the benefit of cross-charged project effort. -
ReceiverLegalEntityId: integer
(int64)
Title:
Receiver Legal Entity Id
Read Only:true
Unique identifier of the receiver legal entity. -
ReceiverLegalEntityIdentifier: string
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. -
RevenueCategory: string
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. -
RevenueCategoryCode: string
Title:
Revenue Category Code
Maximum Length:30
Identifier for the revenue category, decoded using the lookup type PJF_REVENUE_CATEGORY. -
RevenueCurrencyAmount: number
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. -
RevenueCurrencyCreditedAmount: string
Title:
Revenue Currency Credited Amount
The total amount of revenue credits applied in revenue currency. -
RevenueCurrencyEligibleAmount: number
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. -
RevenueCurrencyQualifiedAmount: number
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. -
RevenueCurrencyRecognizedAmount: number
Title:
Revenue Currency Recognized Amount
The total amount of revenue already recognized in revenue currency. -
RevenueDiscountPercentage: number
Title:
Revenue Discount Percent
Percentage revenue discount, if specified on the revenue plan. -
RevenueDiscountReason: string
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. -
RevenueDiscountReasonCode: string
Title:
Revenue Discount Reason Code
Maximum Length:30
Identifier for the revenue discount reason, decoded using the lookup type PJB_DISCOUNT_REASON. -
RevenueLaborMultiplier: number
Title:
Revenue Labor Multiplier
Multiplier which scales labor revenue amounts, if specified on the revenue plan. -
RevenueMarkupPercentage: number
Title:
Revenue Markup Percent
Percentage revenue markup, if specified on the source rate schedule (if applicable) or the revenue plan. -
RevenueMethodClassificationCode: string
Title:
Revenue Method Classification Code
Read Only:true
Maximum Length:30
Unique identifier for the revenue method classification associated with the transaction. -
RevenueMethodId: integer
(int64)
Title:
Revenue Method Id
Read Only:true
Unique identifier for the revenue method associated with the transaction. -
RevenueNetZeroFlag: boolean
Title:
Revenue Net Zero Flag
Indicates whether the transaction has been fully reversed for revenue recognition and therefore nets to zero. -
RevenuePlanId: integer
(int64)
Title:
Revenue Plan Id
Read Only:true
Unique identifier for the revenue plan associated with the transaction. -
RevenuePlanName: string
Title:
Revenue Plan Name
Read Only:true
Maximum Length:30
Revenue plan name associated with the transaction. -
RevenueQualifiedQuantity: number
Title:
Revenue Qualified Quantity
The remaining quantity eligible for revenue recognition, taking into account the funds that are available. -
RevenueQuantity: number
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. -
RevenueRateSourceId: integer
(int64)
Title:
Revenue Rate Source Id
Identifier for the revenue rate source associated with the transaction. -
RevenueRateSourceType: string
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. -
RevenueRateSourceTypeCode: string
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. -
RevenueRecognized: string
Title:
Revenue Recognized
Read Only:true
Maximum Length:80
Indicates whether revenue has been recognized for the transaction. -
RevenueRecognizedCode: string
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. -
RevenueRecognizedDate: string
(date)
Title:
Revenue Recognized Date
The date on which revenue was last recognized for the bill transaction. -
RevenueRecognizedPercentage: number
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. -
RevenueRecognizedQuantity: number
Title:
Revenue Recognized Quantity
The total revenue quantity which has already been recognized. -
RevenueTransferPriceRulePercentage: number
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. -
RevenueTransferPriceScheduleLinePercentage: number
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. -
SourceTransactionId: integer
(int64)
Title:
Source Transaction Id
Unique identifier of the source transaction related to the bill transaction. -
SourceTransactionNumber: integer
(int64)
Title:
Source Transaction Number
Read Only:true
Number of the source transaction related to the bill transaction. -
SourceTransactionType: string
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. -
SourceTransactionTypeCode: string
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. -
TaskId: integer
(int64)
Title:
Task Id
Unique identifier of the task associated with the transaction. -
TaskName: string
Title:
Task Name
Read Only:true
Maximum Length:255
Name of the task associated with the transaction. -
TaskNumber: string
Title:
Task Number
Read Only:true
Maximum Length:100
Number of the task associated with the transaction. -
TransactionCurrencyBilledAmount: number
Title:
Transaction Currency Invoiced Amount
The total amount already invoiced to the customer in transaction currency. -
TransactionCurrencyCode: string
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. -
TransactionCurrencyConcessionAmount: number
Title:
Transaction Currency Invoice Concession Amount
The total amount of invoice concessions applied in transaction currency. -
TransactionCurrencyInvoiceCreditAmount: number
Title:
Transaction Currency Invoice Credited Amount
The total amount of invoice credits applied, other than concessions and write-offs, in transaction currency. -
TransactionCurrencyInvoiceEligibleAmount: number
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. -
TransactionCurrencyInvoiceQualifiedAmount: number
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. -
TransactionCurrencyInvoiceTransactionAmount: number
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. -
TransactionCurrencyInvoiceUnitPrice: number
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. -
TransactionCurrencyRevenueAmount: number
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. -
TransactionCurrencyRevenueCreditedAmount: number
Title:
Transaction Currency Revenue Credited Amount
The total amount of revenue credits applied in transaction currency. -
TransactionCurrencyRevenueEligibleAmount: number
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. -
TransactionCurrencyRevenueQualifiedAmount: number
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. -
TransactionCurrencyRevenueRecognizedAmount: number
Title:
Transaction Currency Revenue Recognized Amount
The total amount of revenue already recognized in transaction currency. -
TransactionCurrencyRevenueUnitPrice: number
Title:
Transaction Currency Revenue Unit Price
The unit price of the effort, products or services for which revenue can be recognized, in transaction currency. -
TransactionCurrencyWriteoffAmount: number
Title:
Transaction Currency Invoice Write-Off Amount
The total amount of invoice write-offs applied in transaction currency. -
TransactionDate: string
(date)
Title:
Transaction Date
The date on which the transaction occurred. For example, the date on which time was worked on a billable project. -
TransferPriceBaseAmount: number
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. -
TransferPriceRuleBasis: string
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. -
TransferPriceRuleBasisCode: string
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. -
TransferPriceScheduleAmountType: string
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. -
TransferPriceScheduleAmountTypeCode: string
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. -
UnitOfMeasure: string
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. -
UnitOfMeasureCode: string
Title:
Unit of Measure Code
Maximum Length:30
Identifier of the unit of measure associated with the transaction. -
WorkType: string
Title:
Work Type
Read Only:true
Maximum Length:240
The work type associated with the transaction. -
WorkTypeId: integer
(int64)
Title:
Work Type Id
Read Only:true
Unique identifier of the work type associated with the transaction.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
The following example shows how to get many project contract bill transactions 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?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.
{ "items": [ { "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" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://your_organization.com: port/fscmRestApi/resources/11.13.18.05/projectContractBillTransactions", "name": "projectContractBillTransactions", "kind": "collection" } ] }