Update an invoice line for a project contract invoice
/fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/child/InvoiceLines/{InvoiceLineId}
Request
- InvoiceId(required): integer(int64) Unique identifier of the invoice.
- InvoiceLineId(required): integer(int64) Unique identifier of the invoice line.
- Metadata-Context: string If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version: string The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
- application/json
object- AssessableValue: number Title:
Assessable ValueAn optional value for an assessable value for the transaction line for estimated tax purposes. - IntendedUse: string Title:
Intended UseMaximum Length:240A classification of the products by tax authority for tax purposes. - IntendedUseClassifId: integer (int64) Title:
Intended Use Classification IDUnique identifier of the intended use classification. - InvoiceLineDff: array Invoice Line Descriptive Flexfields Title:
Invoice Line Descriptive FlexfieldsA listing of all the descriptive flexfields available for invoice lines. - InvoiceLineDistributions: array Invoice Line Distributions Title:
Invoice Line DistributionsThe Invoice Line Distributions resource is used to view the details of invoice line distributions. - InvoiceLineNumber: integer (int64) Title:
Invoice Line NumberNumber that identifies an invoice line. - LineDescription: string Title:
Invoice Line DescriptionMaximum Length:240Description of the invoice line. - OutputTaxClassCode: string Title:
Output Tax ClassificationMaximum Length:150A classification of output tax for the invoice line. - OutputTaxExempt: string Title:
Output tax exemptMaximum Length:1Indicates the use of Standard Exemption rules. Options include Standard, Exempt, or Required. The default is based on user tax setup. - OutputTaxExmtCertNumber: string Title:
Tax Exemption Certificate NumberMaximum Length:80Identifier of the exemption certificate for item lines that have the Output tax Exempt attribute set to E-exempt. - OutputTaxExmtReasonCode: string Title:
Tax Exemption ReasonMaximum Length:30Indicates the code for the reason for tax exemption on lines that have the Output tax Exempt attribute set to E-exempt. - ProductCategory: string Title:
Product CategoryMaximum Length:240A classification of products used for tax purposes. - ProductFcCategoryId: integer (int64) Title:
Product FC Category IDUnique identifier of the product fiscal classification category. - ProductFiscClassification: string Title:
Product Fiscal ClassificationMaximum Length:240A classification of the products based on the inventory item category by the tax authority for tax purposes. - ProductType: string Title:
Product TypeMaximum Length:240This value is another product related tax classification. The value of product type specifies whether the transaction line is for a good, or a service, or it is a memo line. - ShipToAccountNumber: string Title:
Ship-to Account NumberAccount number of the ship-to customer on the invoice line. - ShipToCustomerId: integer (int64) Title:
Ship-to CustomerUnique identifier of the customer account ship-to address that is the project customer's default work site for the project. - ShipToSiteId: integer (int64) Title:
Ship-to Site Use IDUnique identifier of the ship-to address used for taxation. This attribute is populated only if the invoice formats groups by work site and for events using the work site of the event task. - ShipToSiteName: string Title:
Ship-to SiteUnique identifier of the ship-to site on the invoice line. - TransactionBusinessCategory: string Title:
Transaction Business CategoryMaximum Length:240A classification or categorization of an invoice line for tax purposes as required by a tax authority. - TranslatedText: string Title:
Translated DescriptionMaximum Length:1000The translated text of the invoice line. This text is in the language defined in invoice header. - UserDefinedFiscalClass: string Title:
User-Defined Fiscal ClassificationMaximum Length:30Indicates the default taxation country.
arrayInvoice Line Descriptive FlexfieldsarrayInvoice Line Distributionsobject- __FLEX_Context: string Title:
Context PromptMaximum Length:30Context for flex fields. - __FLEX_Context_DisplayValue: string Title:
Context PromptContext Prompt
objectResponse
- application/json
Default Response
- 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.
object- ApTransferErrorCode: string Title:
Invoice AP Transfer Error CodeRead Only:trueMaximum Length:80Indicates the code related to transfer errors between project billing and Accounts Payable (AP). The Invoice Transfer Error Message attribute contains a description of the error. - ApTransferStatusCode: string Title:
Invoice Transfer Status to PayablesRead Only:trueMaximum Length:1Indicates the status of the transfer of the invoice to Accounts Payable (AP). Valid values are P - Pending, A - Accepted, and R - Rejected. - AssessableValue: number Title:
Assessable ValueAn optional value for an assessable value for the transaction line for estimated tax purposes. - BillPlanId: integer (int64) Title:
Bill Plan IDRead Only:trueUnique identifier of the bill plan related to the line. - BillSet: integer (int64) Title:
Bill SetRead Only:trueIdentifier of a set of invoices created together in the same run which must be released at the same time. - ContractCurrencyCode: string Title:
Contract CurrencyRead Only:trueMaximum Length:30Indicates the code of the currency for the contract related to the invoice line. - ContractCurrencyLineAmount: number Title:
Invoice Amount in Contract CurrencyRead Only:trueAmount in contract currency. - ContractLineId: integer (int64) Title:
Contract Line IDRead Only:trueUnique identifier of the contract line related to the invoice line. - ContractLineNumber: string Title:
Contract Line NumberRead Only:trueMaximum Length:150Number that identifies the contract line related to the invoice line if the line represents a single contract line. - CreditedInvoiceLineId: integer (int64) Title:
Credited Invoice Line IDRead Only:trueUnique identifier of the invoice line credited by this invoice line. - DocumentNumber: string Title:
Document NumberRead Only:trueMaximum Length:240Number that identifies a document on the bill plan of a grants contract. - Exception: string Title:
ExceptionRead Only:trueMaximum Length:1Indicates that exceptions have occurred for the invoice line. Valid values are E - Error, W - Warning, and N - No error. - ExpenditureOrgId: integer (int64) Title:
Expenditure Organization IDRead Only:trueUnique identifier of the expenditure organization related to the line. - ExpenditureTypeId: integer (int64) Title:
Expenditure Type IDRead Only:trueUnique identifier of the expenditure type for the invoice line. - IntendedUse: string Title:
Intended UseMaximum Length:240A classification of the products by tax authority for tax purposes. - IntendedUseClassifId: integer (int64) Title:
Intended Use Classification IDUnique identifier of the intended use classification. - InvoiceCurrencyCode: string Title:
Invoice CurrencyRead Only:trueMaximum Length:30Indicates the currency code for the invoice that is transferred to Oracle Receivables. - InvoiceCurrencyLineAmount: number Title:
Amount in Invoice CurrencyRead Only:trueDefault Value:0Amount of the invoice line in the invoice currency. - InvoiceFormatId: integer (int64) Title:
Invoice Format IDRead Only:trueUnique identifier of the invoice format. - InvoiceFormatName: string Title:
Invoice Format NameRead Only:trueMaximum Length:30Name of the invoice format. - InvoiceLineDff: array Invoice Line Descriptive Flexfields Title:
Invoice Line Descriptive FlexfieldsA listing of all the descriptive flexfields available for invoice lines. - InvoiceLineDistributions: array Invoice Line Distributions Title:
Invoice Line DistributionsThe Invoice Line Distributions resource is used to view the details of invoice line distributions. - InvoiceLineId: integer (int64) Title:
Invoice Line IDUnique identifier of the invoice line. - InvoiceLineNumber: integer (int64) Title:
Invoice Line NumberNumber that identifies an invoice line. - InvoiceLineType: string Title:
Invoice Line TypeRead Only:trueMaximum Length:30Default Value:STANDARDA classification of invoice credit that is assigned to an invoice line. Valid values are CONCESSION, WRITE_OFF, CANCEL, STANDARD, and CREDIT_MEMO. - InvoiceLineTypeMeaning: string Title:
Invoice Line Type MeaningRead Only:trueMaximum Length:80Meaning of the invoice line type. - LedgerCurrencyCode: string Title:
Ledger CurrencyRead Only:trueMaximum Length:30The currency used for accounting and reporting in a ledger, often referred to as the accounting currency, base currency, or functional currency. - LedgerCurrencyLineAmount: number Title:
Invoice Amount in Ledger CurrencyRead Only:trueAmount of the invoice line in the ledger currency. - LineDescription: string Title:
Invoice Line DescriptionMaximum Length:240Description of the invoice line. - LinkedProjectId: integer (int64) Title:
Associated Project IDRead Only:trueUnique identifier of the project associated to the related contract line or contract lines. This value is populated if Invoice Format grouping options are set to group distribution lines by Contract Line Project Name or Number. - LinkedProjectName: string Title:
Associated Project NameRead Only:trueMaximum Length:240Name of project that is linked to the contract line associated to the invoice line. This value is populated if Invoice Format grouping options are set to group distribution lines by Contract Line Project Name or Number. - LinkedProjectNumber: string Title:
Associated Project NumberRead Only:trueMaximum Length:25Number of project that is linked to the contract line associated to the invoice line. This value is populated if Invoice Format grouping options are set to group distribution lines by Contract Line Project Name or Number. - LinkedTaskId: integer (int64) Title:
Associated Task IDRead Only:trueUnique identifier of the project task associated to the related contract line or contract lines. This value is populated if a task is associated to the contract line and Invoice Format grouping options are set to group distribution lines by Contract Line Task Name or Number. - LinkedTaskName: string Title:
Associated Task NameRead Only:trueMaximum Length:255Name of the task that is linked to the contract line associated to the invoice line. This value is populated if a task is associated to the contract line and Invoice Format grouping options are set to group distribution lines by Contract Line Project Name or Number. - LinkedTaskNumber: string Title:
Associated Task NumberRead Only:trueMaximum Length:100Number of the task that is linked to the contract line associated to the invoice line. This value is populated if a task is associated to the contract line and Invoice Format grouping options are set to group distribution lines by Contract Line Project Name or Number. - links: array Links Title:
LinksThe link relations associated with the resource instance. - LocNumber: string Title:
LOC NumberRead Only:trueMaximum Length:240Number that identifies a letter of credit on the bill plan of a grants contract. - OutputTaxAmount: number Title:
Tax Amount in Invoice CurrencyRead Only:trueThe total tax amount in the invoice currency. - OutputTaxClassCode: string Title:
Output Tax ClassificationMaximum Length:150A classification of output tax for the invoice line. - OutputTaxExempt: string Title:
Output tax exemptMaximum Length:1Indicates the use of Standard Exemption rules. Options include Standard, Exempt, or Required. The default is based on user tax setup. - OutputTaxExmtCertNumber: string Title:
Tax Exemption Certificate NumberMaximum Length:80Identifier of the exemption certificate for item lines that have the Output tax Exempt attribute set to E-exempt. - OutputTaxExmtReasonCode: string Title:
Tax Exemption ReasonMaximum Length:30Indicates the code for the reason for tax exemption on lines that have the Output tax Exempt attribute set to E-exempt. - PaymentTermId: integer (int64) Title:
Payment Term IDRead Only:trueUnique identifier of the payment term for the receipt from Accounts Receivable (AR) which is applied against the agreement. - PaymentTermName: string Title:
Payment TermRead Only:trueMaximum Length:15Name of the payment term. - ProductCategory: string Title:
Product CategoryMaximum Length:240A classification of products used for tax purposes. - ProductFcCategoryId: integer (int64) Title:
Product FC Category IDUnique identifier of the product fiscal classification category. - ProductFiscClassification: string Title:
Product Fiscal ClassificationMaximum Length:240A classification of the products based on the inventory item category by the tax authority for tax purposes. - ProductType: string Title:
Product TypeMaximum Length:240This value is another product related tax classification. The value of product type specifies whether the transaction line is for a good, or a service, or it is a memo line. - ReceiverProjectId: integer (int64) Title:
Receiver Project IDRead Only:trueUnique identifier of the receiver project. - ReceiverTaskId: integer (int64) Title:
Receiver Task IDRead Only:trueUnique identifier of the receiver task. - ShipToAccountDescription: string Title:
Ship-to Account DescriptionRead Only:trueAccount description of the ship-to customer on the invoice line. - ShipToAccountNumber: string Title:
Ship-to Account NumberAccount number of the ship-to customer on the invoice line. - ShipToAddress: string Title:
Ship-to AddressRead Only:trueAddress of the ship-to customer on the invoice line. - ShipToContactId: integer (int64) Title:
Ship-to Contact IDRead Only:trueUnique identifier of the ship-to contact. A representative for the ship to customer of the project. - ShipToCustomerId: integer (int64) Title:
Ship-to CustomerUnique identifier of the customer account ship-to address that is the project customer's default work site for the project. - ShipToCustomerName: string Title:
Ship-to CustomerRead Only:trueName of the ship-to customer on the invoice line. - ShipToSiteId: integer (int64) Title:
Ship-to Site Use IDUnique identifier of the ship-to address used for taxation. This attribute is populated only if the invoice formats groups by work site and for events using the work site of the event task. - ShipToSiteName: string Title:
Ship-to SiteUnique identifier of the ship-to site on the invoice line. - TransactionBusinessCategory: string Title:
Transaction Business CategoryMaximum Length:240A classification or categorization of an invoice line for tax purposes as required by a tax authority. - TranslatedText: string Title:
Translated DescriptionMaximum Length:1000The translated text of the invoice line. This text is in the language defined in invoice header. - UserDefinedFiscalClass: string Title:
User-Defined Fiscal ClassificationMaximum Length:30Indicates the default taxation country. - WorkTypeId: integer (int64) Title:
Work Type IDRead Only:trueUnique identifier of the work type. - WorkTypeName: string Title:
Work TypeRead Only:trueMaximum Length:240Name of the work type.
arrayInvoice Line Descriptive FlexfieldsarrayInvoice Line DistributionsarrayLinksobject- __FLEX_Context: string Title:
Context PromptMaximum Length:30Context for flex fields. - __FLEX_Context_DisplayValue: string Title:
Context PromptContext Prompt - InvoiceLineId: integer (int64) Identifier of the invoice line.
- links: array Links Title:
LinksThe link relations associated with the resource instance.
arrayLinksobject- href: string Title:
hyperlink referenceThe URI to the related resource. - kind: string Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. - name: string Title:
nameThe name of the link to the related resource. - properties: object properties
- rel: string Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
object- changeIndicator: string Change indicator or the ETag value of the resource instance.
object- BillingExtensionId: integer (int64) Title:
Billing Extension IDRead Only:trueUnique identifier of billing extension used for the transaction. - BillingJobTitle: string Title:
Billing Job TitleRead Only:trueMaximum Length:80Indicates the title for the billing job. - BillingResourceId: integer (int64) Title:
Billing Resource IDRead Only:trueUnique identifier of resource breakdown structure element. - BillJobId: integer (int64) Title:
Bill Job IDRead Only:trueUnique identifier of the effective job used when invoicing a labor item as of the last time the expenditure item was invoiced. - BillPlanId: integer (int64) Title:
Bill Plan IDRead Only:trueUnique identifier of the bill plan for the invoice distribution. - BillRate: number Title:
Bill RateRead Only:trueBill rate used in deriving the transfer price if the transfer price was based on a rate defined in a bill rate schedule. - BillSet: integer (int64) Title:
Bill SetRead Only:trueNumber of the bill set which is defined in bill plan related to the invoice distribution. - BillTransactionTypeCode: string Title:
Billing Transaction Type CodeRead Only:trueMaximum Length:30Indicates the code used to classify the type of bill transaction. Valid values are EI - Expenditure Item or EVT - Billing Event and defined in the lookup PJB_BILL_TRANSACTION_TYPE. - ContractCurrencyBilledAmount: number Title:
Invoice Amount in Contract CurrencyRead Only:trueAmount billed in currency of the contract. - ContractCurrencyCode: string Title:
Contract CurrencyRead Only:trueMaximum Length:30Indicates the code of the currency for the contract related to the distribution. - ContractCurrencyInvDateType: string Title:
Contract Currency Invoice Date TypeRead Only:trueMaximum Length:30Indicates the currency conversion date type used to convert the contract to the invoice currency. - ContractCurrencyInvExchgDate: string (date) Title:
Contract Currency Invoice Conversion DateRead Only:trueIndicates the date used for the conversion of the rates on the contract for the invoice. - ContractCurrencyInvExchgRate: number Title:
Contract Currency Invoice Conversion RateRead Only:trueIndicates the rate used to convert the invoice amounts from the transaction currency to the contract currency. - ContractCurrencyInvRateType: string Title:
Contract Currency Rate Type CodeRead Only:trueMaximum Length:30Indicates the code for the contract currency rate type. - ContractLineId: integer (int64) Title:
Contract Line IDRead Only:trueUnique Identifier of the contract line for the invoice distribution. - ContractLineNumber: string Title:
Contract Line NumberRead Only:trueMaximum Length:150Number of the contract line for the invoice distribution. - CreditedDistributionId: integer (int64) Title:
Origin of AdjustmentRead Only:trueUnique identifier of distribution credited by this distribution. - CreditedInvoiceId: integer (int64) Title:
Credited Invoice IDRead Only:trueUnique identifier of invoice that is credited by this distribution. - CreditedInvoiceLineId: integer (int64) Title:
Credited Invoice Line IDRead Only:trueUnique identifier of invoice line that is credited by this distribution. - DocumentNumber: string Title:
Document NumberRead Only:trueMaximum Length:240Number that identifies a document on the bill plan of a grants contract. - EmployeeBillingTitle: string Title:
Employee Billing TitleRead Only:trueMaximum Length:80Employee billing title. - ICTpAmountTypeCode: string Title:
Intercompany Transfer Price Amount TypeRead Only:trueMaximum Length:30Amount type code used for an inter company price amount. - ICTpBaseCode: string Title:
Intercompany Transfer Price BaseRead Only:trueMaximum Length:30Indicates the intercompany transfer price base code of an intercompany transfer invoice. - IntendedUse: string Title:
Intended UseRead Only:trueMaximum Length:240A classification of the products by tax authority for tax purposes. - IntendedUseClassifId: integer (int64) Title:
Intended Use Classification IDRead Only:trueUnique identifier of the intended use classification. - InvBurdenCompileSetId: integer (int64) Title:
Invoice Burden Compile SetRead Only:trueUnique identifier of the compiled set used to calculate a burden schedule. This only applies to invoice distributions based on billing event detail. - InvDiscountReasonCode: string Title:
Rate Change ReasonRead Only:trueMaximum Length:30Reason code for discount override or rate override. - InvDistributionTypeCode: string Title:
Invoice Distribution TypeRead Only:trueMaximum Length:30Indicates the code of the type used to classify invoice distribution. Valid values are WRITE_OFF, CONCESSION, CANCEL, STANDARD, and CREDIT_MEMO. - InvLineDistNumber: integer (int64) Title:
Invoice Distribution NumberRead Only:trueNumber that identifies the invoice distribution. - InvoiceAmountCalculationCode: string Title:
Invoice Amount Calculation CodeRead Only:trueMaximum Length:30Indicates the code for the invoice amount calculation. Valid values are I - Indirect, O - Overrides, E - Extension, B - Bill rates, L - Labor Multiplier. - InvoiceCurrencyBilledAmount: number Title:
Invoice Amount in Invoice CurrencyRead Only:trueAmount billed in the Invoice currency amount. - InvoiceCurrencyCode: string Title:
Invoice CurrencyRead Only:trueMaximum Length:30Indicates the currency code for the invoice that is transferred to Oracle Receivables. - InvoiceCurrencyCreditAmount: number Title:
Invoice Currency Credit AmountRead Only:trueCredit amount in the invoice currency. - InvoiceCurrencyCreditPct: number Title:
Credit Percentage in Invoice CurrencyRead Only:trueIndicates the percent of credit in the invoice currency. - InvoiceCurrencyDateType: string Title:
Invoice Currency Conversion Date TypeRead Only:trueMaximum Length:30Date type of the invoice currency. - InvoiceCurrencyExchgDate: string (date) Title:
Invoice Currency Conversion DateRead Only:trueIndicates the exchange date for the conversion of the invoice currency. - InvoiceCurrencyExchgRate: number Title:
Invoice Currency Conversion RateRead Only:trueExchange rate used for the invoice currency. - InvoiceCurrencyRateType: string Title:
Invoice Currency Conversion Rate TypeRead Only:trueMaximum Length:30Rate type of the invoice currency. - InvoiceDate: string (date) Title:
DateRead Only:trueThe invoice date passed to Oracle Receivables, which is used to calculate the invoice due date. Upon release of the invoice, the default value is the released date. You can override the invoice date at the time of release. - InvoiceDiscountPercentage: number Title:
Discount PercentageRead Only:trueIndicates a discount percentage, expressed as a proportion multiplied by 100, that is used to calculate the adjusted invoice and rate. The percentage used is based on the markup defined in the bill rate schedule. - InvoiceDistId: integer (int64) Title:
Invoice Distribution IDUnique identifier of the invoice distribution. - InvoiceLaborMultiplier: number Title:
Labor MultiplierRead Only:trueA multiplier that is assigned to the contract line, and is used to calculate the invoice amount for labor items by applying the multipler to the raw cost of the labor items. - InvoiceMarkupPercentage: number Title:
Markup PercentageRead Only:trueIndicates the markup percentage used to calculate the adjusted invoice and rate. The percentage used is based on the markup defined in the bill rate schedule. - LedgerCurrencyBilledAmount: number Title:
Invoice Amount in Ledger CurrencyRead Only:trueAmount billed in the currency of the ledger. - LedgerCurrencyCode: string Title:
Ledger CurrencyRead Only:trueMaximum Length:30Ledger currency code. - LedgerCurrencyInvDateType: string Title:
Ledger Currency Invoice Date TypeRead Only:trueMaximum Length:30Date type of the ledger currency. - LedgerCurrencyInvExchgDate: string (date) Title:
Ledger Currency Conversion DateRead Only:trueIndicates the conversion date used to convert the invoice to the ledger currency. - LedgerCurrencyInvExchgRate: number Title:
Ledger Currency Conversion RateRead Only:trueIndicates the conversion currency rate used to convert the invoice to the ledger currency. - LedgerCurrencyInvRateType: string Title:
Ledger Currency Invoice Rate TypeRead Only:trueMaximum Length:30Indicates the conversion currency rate type used to convert the invoice to the ledger currency. - LinkedProjectId: integer (int64) Title:
Associated Project IDRead Only:trueUnique identifier of project that is linked to the contract line associated to the invoice distribution. - LinkedProjectName: string Title:
Associated Project NameRead Only:trueMaximum Length:240Name of the project that is linked to the contract line associated to the invoice distribution. - LinkedProjectNumber: string Title:
Associated Project NumberRead Only:trueMaximum Length:25Number of the project that is linked to the contract line associated to the invoice distribution. - LinkedTaskId: integer (int64) Title:
Associated Task IDRead Only:trueUnique identifier of the task that is linked to the contract line associated to the invoice distribution. - LinkedTaskName: string Title:
Associated Task NameRead Only:trueMaximum Length:255Name of the task that is linked to the contract line associated to the invoice distribution. - LinkedTaskNumber: string Title:
Associated Task NumberRead Only:trueMaximum Length:100Number of the project task that is linked to the contract line associated to the invoice distribution. - links: array Links Title:
LinksThe link relations associated with the resource instance. - LocNumber: string Title:
LOC NumberRead Only:trueMaximum Length:240Number that identifies a letter of credit on the bill plan of a grants contract. - ProductCategory: string Title:
Product CategoryRead Only:trueMaximum Length:240A classification of products used for tax purposes. - ProductFcCategoryId: integer (int64) Title:
Product FC Category IDRead Only:trueUnique identifier of the product fiscal classification category. - ProductFiscClassification: string Title:
Product Fiscal ClassificationRead Only:trueMaximum Length:240A classification of the products based on the inventory item category by the tax authority for tax purposes. - ProductType: string Title:
Product TypeRead Only:trueMaximum Length:240This value is another product related tax classification. The value of product type specifies whether the transaction line is for a good, or a service, or it is a memo line. - ProjectCurrencyBilledAmount: number Title:
Invoice Amount in Project CurrencyRead Only:trueAmount billed in the currency of the project. - ProjectCurrencyCode: string Title:
Project CurrencyRead Only:trueMaximum Length:30Indicates the currency code of the project. - ProjectCurrencyInvDateType: string Title:
Project Currency Invoice Date TypeRead Only:trueMaximum Length:30Date type used for conversion to the project currency. - ProjectCurrencyInvExchgDate: string (date) Title:
Project Currency Conversion DateRead Only:trueIndicates the currency conversion date used to convert the invoice distribution to the project currency. - ProjectCurrencyInvExchgRate: number Title:
Project Currency Conversion RateRead Only:trueIndicates the currency conversion rate used to convert the invoice currency to the project currency. - ProjectCurrencyInvRateType: string Title:
Project Currency Invoice Rate TypeRead Only:trueMaximum Length:30Indicates the currency conversion rate type used to convert the invoice to the project currency. - ProviderLegalEntityId: integer (int64) Title:
Provider Legal Entity IDRead Only:trueUnique identifier of the provider legal entity. - Quantity: integer Title:
QuantityRead Only:trueIndicates the quantity of the source expenditure item for invoice transactions created from expenditure items. - ReceiverLegalEntityId: integer (int64) Title:
Receiver Legal Entity IDRead Only:trueUnique identifier of the receiver legal entity. - TpInvRulePercentage: number Title:
Transfer Price Invoice Rule PercentageRead Only:trueIndicates the applied percentage value from the transfer price rule used to create an intercompany invoice. - TpInvSchLinePercentage: number Title:
Transfer Price Invoice Schedule Line PercentageRead Only:trueThe applied percentage value from the transfer price schedule line used to create an intercompany invoice. - TransactionBusinessCategory: string Title:
Transaction Business CategoryRead Only:trueMaximum Length:240A classification or categorization of a transaction for tax purposes as required by a tax authority. - TransactionCurrencyBilledAmount: number Title:
Billed Amount in Transaction CurrencyRead Only:trueBilled amount in the transaction currency. - TransactionCurrencyCode: string Title:
Transaction CurrencyRead Only:trueMaximum Length:30Transaction currency for the expenditure or events. - TransactionDate: string (date) Title:
Transaction DateRead Only:trueDate when transaction occurs. - TransactionId: integer (int64) Title:
Transaction IDRead Only:trueUnique identifier of the expenditure item or event related to the invoice distribution. - TransactionProjectId: integer (int64) Title:
Transaction Project IDRead Only:trueUnique identifier of the project related to the invoice distribution transaction. - TransactionProjectName: string Title:
Transaction Project NameRead Only:trueMaximum Length:240Name of the project related to the invoice distribution transaction. - TransactionProjectNumber: string Title:
Transaction Project NumberRead Only:trueMaximum Length:25Number of the project related to the invoice distribution transaction. - TransactionTaskId: integer (int64) Title:
Transaction Task IDRead Only:trueUnique identifier of the project task related to the invoice distribution transaction. - TransactionTaskName: string Title:
Transaction Task NameRead Only:trueMaximum Length:255Name of the project task related to the invoice distribution transaction. - TransactionTaskNumber: string Title:
Transaction Task NumberRead Only:trueMaximum Length:100Number of the project task related to the invoice distribution transaction. - TransactionTypeId: integer (int64) Title:
Transaction Type IDRead Only:trueUnique identifier of the Event Type or Expenditure Item Type related to the invoice distribution. - UserDefinedFiscalClass: string Title:
User-Defined Fiscal ClassificationRead Only:trueMaximum Length:240Indicates the default taxation country.
arrayLinks- InvoiceLineDff
- Parameters:
- InvoiceId:
$request.path.InvoiceId - InvoiceLineId:
$request.path.InvoiceLineId
A listing of all the descriptive flexfields available for invoice lines. - InvoiceId:
- InvoiceLineDistributions
- Parameters:
- InvoiceId:
$request.path.InvoiceId - InvoiceLineId:
$request.path.InvoiceLineId
The Invoice Line Distributions resource is used to view the details of invoice line distributions. - InvoiceId:
Examples
Example 1
The following example shows how to update an invoice line for a project contract invoice by submitting a PATCH request on the REST resource using cURL.
curl --user ppm_cloud_user -X PATCH -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501
Request Body Example
The following shows an example of the request body in JSON format.
{ "AssessableValue": 2600 } Response Body Example
The following shows an example of the response body in JSON format.
{ "LedgerCurrencyLineAmount": null, "LedgerCurrencyCode": null, "AssessableValue": 2600, "BillPlanId": null, "BillSet": 1, "ContractCurrencyCode": "USD", "ContractCurrencyLineAmount": 2500, "ContractLineId": null, "CreditedInvoiceLineId": null, "DocumentNumber": null, "Exception": "N", "ExpenditureOrgId": null, "ExpenditureTypeId": null, "ApTransferErrorCode": null, "ApTransferStatusCode": null, "IntendedUse": null, "IntendedUseClassifId": null, "InvoiceCurrencyLineAmount": 2500, "InvoiceCurrencyCode": "USD", "InvoiceFormatId": 100000011406001, "LineDescription": "SJS Donald Hours 50 Vision Corporation", "InvoiceLineId": 100101301565501, "InvoiceLineNumber": 1, "InvoiceLineType": "STANDARD", "LocNumber": null, "OutputTaxAmount": null, "OutputTaxClassCode": "NY - Sales Tax", "OutputTaxExempt": "S", "OutputTaxExmtCertNumber": null, "OutputTaxExmtReasonCode": null, "PaymentTermId": 100000012042191, "ProductFcCategoryId": null, "ProductCategory": null, "ProductFiscClassification": null, "ProductType": null, "ReceiverProjectId": null, "ReceiverTaskId": null, "ShipToContactId": null, "ShipToCustomerId": 1004, "ShipToSiteId": 1018, "TranslatedText": null, "TransactionBusinessCategory": "SALES_TRANSACTION", "UserDefinedFiscalClass": null, "WorkTypeId": null, "InvoiceLineTypeMeaning": "Standard invoice line", "ContractLineNumber": null, "InvoiceFormatName": "Employee Format", "PaymentTermName": "IMMEDIATE", "WorkTypeName": null, "LinkedProjectId": null, "LinkedTaskId": null, "LinkedTaskName": null, "LinkedTaskNumber": null, "LinkedProjectName": null, "LinkedProjectNumber": null, "ShipToSiteName": "Tulsa (OPS)", "ShipToAddress": "East Street South,OK", "ShipToAccountNumber": "1004", "ShipToAccountDescription": "Big Computers", "ShipToCustomerName": "Big Computers", "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501", "name": "InvoiceLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000D78" } }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501", "name": "InvoiceLines", "kind": "item" }, { "rel": "parent", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500", "name": "projectContractInvoices", "kind": "item" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501/lov/UserDefinedFiscClassLOVVA", "name": "UserDefinedFiscClassLOVVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501/lov/TaxExemptCertificateLOVVA", "name": "TaxExemptCertificateLOVVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501/lov/ShipToSiteUseLocationLOVVA", "name": "ShipToSiteUseLocationLOVVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501/lov/LineIntendedUseLOVVA", "name": "LineIntendedUseLOVVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501/lov/ProductTypesLOVVA", "name": "ProductTypesLOVVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501/lov/ProductCategoriesLOVVA", "name": "ProductCategoriesLOVVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501/lov/ProductFiscClassificationsLOVVA", "name": "ProductFiscClassificationsLOVVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501/lov/TaxExemptReasonCodesLOVVA", "name": "TaxExemptReasonCodesLOVVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501/lov/TransactionBizCategoriesLOVVA", "name": "TransactionBizCategoriesLOVVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501/lov/OutputTaxClassificationsLOVVA", "name": "OutputTaxClassificationsLOVVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501/lov/ShipToAcctNumberLOVVA", "name": "ShipToAcctNumberLOVVA", "kind": "collection" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501/child/InvoiceLineDff", "name": "InvoiceLineDff", "kind": "collection" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501/child/InvoiceLineDistributions", "name": "InvoiceLineDistributions", "kind": "collection" } ] } Example 2
The following example shows how to update an invoice line for a project contract invoice by submitting a PATCH request on the REST resource using cURL.
curl --user ppm_cloud_user -X PATCH -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501
Request Body Example
The following shows an example of the request body in JSON format.
{ "LineDescription": "TestLineDescription" } Response Body Example
The following shows an example of the response body in JSON format.
{ "LedgerCurrencyLineAmount": null, "LedgerCurrencyCode": null, "AssessableValue": 2600, "BillPlanId": null, "BillSet": 1, "ContractCurrencyCode": "USD", "ContractCurrencyLineAmount": 2500, "ContractLineId": null, "CreditedInvoiceLineId": null, "DocumentNumber": null, "Exception": "N", "ExpenditureOrgId": null, "ExpenditureTypeId": null, "ApTransferErrorCode": null, "ApTransferStatusCode": null, "IntendedUse": null, "IntendedUseClassifId": null, "InvoiceCurrencyLineAmount": 2500, "InvoiceCurrencyCode": "USD", "InvoiceFormatId": 100000011406001, "LineDescription": "TestLineDescription", "InvoiceLineId": 100101301565501, "InvoiceLineNumber": 1, "InvoiceLineType": "STANDARD", "LocNumber": null, "OutputTaxAmount": null, "OutputTaxClassCode": "NY - Sales Tax", "OutputTaxExempt": "S", "OutputTaxExmtCertNumber": null, "OutputTaxExmtReasonCode": null, "PaymentTermId": 100000012042191, "ProductFcCategoryId": null, "ProductCategory": null, "ProductFiscClassification": null, "ProductType": null, "ReceiverProjectId": null, "ReceiverTaskId": null, "ShipToContactId": null, "ShipToCustomerId": 1004, "ShipToSiteId": 1018, "TranslatedText": null, "TransactionBusinessCategory": "SALES_TRANSACTION", "UserDefinedFiscalClass": null, "WorkTypeId": null, "InvoiceLineTypeMeaning": "Standard invoice line", "ContractLineNumber": null, "InvoiceFormatName": "Employee Format", "PaymentTermName": "IMMEDIATE", "WorkTypeName": null, "LinkedProjectId": null, "LinkedTaskId": null, "LinkedTaskName": null, "LinkedTaskNumber": null, "LinkedProjectName": null, "LinkedProjectNumber": null, "ShipToSiteName": "Tulsa (OPS)", "ShipToAddress": "East Street South,OK", "ShipToAccountNumber": "1004", "ShipToAccountDescription": "Big Computers", "ShipToCustomerName": "Big Computers", "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501", "name": "InvoiceLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000E78" } }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501", "name": "InvoiceLines", "kind": "item" }, { "rel": "parent", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500", "name": "projectContractInvoices", "kind": "item" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501/lov/UserDefinedFiscClassLOVVA", "name": "UserDefinedFiscClassLOVVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501/lov/TaxExemptCertificateLOVVA", "name": "TaxExemptCertificateLOVVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501/lov/ShipToSiteUseLocationLOVVA", "name": "ShipToSiteUseLocationLOVVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501/lov/LineIntendedUseLOVVA", "name": "LineIntendedUseLOVVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501/lov/ProductTypesLOVVA", "name": "ProductTypesLOVVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501/lov/ProductCategoriesLOVVA", "name": "ProductCategoriesLOVVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501/lov/ProductFiscClassificationsLOVVA", "name": "ProductFiscClassificationsLOVVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501/lov/TaxExemptReasonCodesLOVVA", "name": "TaxExemptReasonCodesLOVVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501/lov/TransactionBizCategoriesLOVVA", "name": "TransactionBizCategoriesLOVVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501/lov/OutputTaxClassificationsLOVVA", "name": "OutputTaxClassificationsLOVVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501/lov/ShipToAcctNumberLOVVA", "name": "ShipToAcctNumberLOVVA", "kind": "collection" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501/child/InvoiceLineDff", "name": "InvoiceLineDff", "kind": "collection" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines/100101301565501/child/InvoiceLineDistributions", "name": "InvoiceLineDistributions", "kind": "collection" } ] }