1. REST API for Oracle Fusion Cloud Project Management
  2. Tasks
  3. Project Contract Invoices
  4. Invoice Lines

Update an invoice line for a project contract invoice

patch

/fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/child/InvoiceLines/{InvoiceLineId}

Request

Path Parameters
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Invoice Line Descriptive Flexfields
Type: array
Title: Invoice Line Descriptive Flexfields
A listing of all the descriptive flexfields available for invoice lines.
Show Source
Nested Schema : Invoice Line Distributions
Type: array
Title: Invoice Line Distributions
The Invoice Line Distributions resource is used to view the details of invoice line distributions.
Show Source
Nested Schema : projectContractInvoices-InvoiceLines-InvoiceLineDff-item-patch-request
Type: object
Show Source
Nested Schema : projectContractInvoices-InvoiceLines-InvoiceLineDistributions-item-patch-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : projectContractInvoices-InvoiceLines-item-response
Type: object
Show Source
  • Title: Invoice AP Transfer Error Code
    Read Only: true
    Maximum Length: 80
    Indicates 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.
  • Title: Invoice Transfer Status to Payables
    Read Only: true
    Maximum Length: 1
    Indicates the status of the transfer of the invoice to Accounts Payable (AP). Valid values are P - Pending, A - Accepted, and R - Rejected.
  • Title: Assessable Value
    An optional value for an assessable value for the transaction line for estimated tax purposes.
  • Title: Bill Plan ID
    Read Only: true
    Unique identifier of the bill plan related to the line.
  • Title: Bill Set
    Read Only: true
    Identifier of a set of invoices created together in the same run which must be released at the same time.
  • Title: Contract Currency
    Read Only: true
    Maximum Length: 30
    Indicates the code of the currency for the contract related to the invoice line.
  • Title: Invoice Amount in Contract Currency
    Read Only: true
    Amount in contract currency.
  • Title: Contract Line ID
    Read Only: true
    Unique identifier of the contract line related to the invoice line.
  • Title: Contract Line Number
    Read Only: true
    Maximum Length: 150
    Number that identifies the contract line related to the invoice line if the line represents a single contract line.
  • Title: Credited Invoice Line ID
    Read Only: true
    Unique identifier of the invoice line credited by this invoice line.
  • Title: Document Number
    Read Only: true
    Maximum Length: 240
    Number that identifies a document on the bill plan of a grants contract.
  • Title: Exception
    Read Only: true
    Maximum Length: 1
    Indicates that exceptions have occurred for the invoice line. Valid values are E - Error, W - Warning, and N - No error.
  • Title: Expenditure Organization ID
    Read Only: true
    Unique identifier of the expenditure organization related to the line.
  • Title: Expenditure Type ID
    Read Only: true
    Unique identifier of the expenditure type for the invoice line.
  • Title: Intended Use
    Maximum Length: 240
    A classification of the products by tax authority for tax purposes.
  • Title: Intended Use Classification ID
    Unique identifier of the intended use classification.
  • Title: Invoice Currency
    Read Only: true
    Maximum Length: 30
    Indicates the currency code for the invoice that is transferred to Oracle Receivables.
  • Title: Amount in Invoice Currency
    Read Only: true
    Default Value: 0
    Amount of the invoice line in the invoice currency.
  • Title: Invoice Format ID
    Read Only: true
    Unique identifier of the invoice format.
  • Title: Invoice Format Name
    Read Only: true
    Maximum Length: 30
    Name of the invoice format.
  • Invoice Line Descriptive Flexfields
    Title: Invoice Line Descriptive Flexfields
    A listing of all the descriptive flexfields available for invoice lines.
  • Invoice Line Distributions
    Title: Invoice Line Distributions
    The Invoice Line Distributions resource is used to view the details of invoice line distributions.
  • Title: Invoice Line ID
    Unique identifier of the invoice line.
  • Title: Invoice Line Number
    Number that identifies an invoice line.
  • Title: Invoice Line Type
    Read Only: true
    Maximum Length: 30
    Default Value: STANDARD
    A classification of invoice credit that is assigned to an invoice line. Valid values are CONCESSION, WRITE_OFF, CANCEL, STANDARD, and CREDIT_MEMO.
  • Title: Invoice Line Type Meaning
    Read Only: true
    Maximum Length: 80
    Meaning of the invoice line type.
  • Title: Ledger Currency
    Read Only: true
    Maximum Length: 30
    The currency used for accounting and reporting in a ledger, often referred to as the accounting currency, base currency, or functional currency.
  • Title: Invoice Amount in Ledger Currency
    Read Only: true
    Amount of the invoice line in the ledger currency.
  • Title: Invoice Line Description
    Maximum Length: 240
    Description of the invoice line.
  • Title: Associated Project ID
    Read Only: true
    Unique 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.
  • Title: Associated Project Name
    Read Only: true
    Maximum Length: 240
    Name 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.
  • Title: Associated Project Number
    Read Only: true
    Maximum Length: 25
    Number 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.
  • Title: Associated Task ID
    Read Only: true
    Unique 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.
  • Title: Associated Task Name
    Read Only: true
    Maximum Length: 255
    Name 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.
  • Title: Associated Task Number
    Read Only: true
    Maximum Length: 100
    Number 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
  • Title: LOC Number
    Read Only: true
    Maximum Length: 240
    Number that identifies a letter of credit on the bill plan of a grants contract.
  • Title: Tax Amount in Invoice Currency
    Read Only: true
    The total tax amount in the invoice currency.
  • Title: Output Tax Classification
    Maximum Length: 150
    A classification of output tax for the invoice line.
  • Title: Output tax exempt
    Maximum Length: 1
    Indicates the use of Standard Exemption rules. Options include Standard, Exempt, or Required. The default is based on user tax setup.
  • Title: Tax Exemption Certificate Number
    Maximum Length: 80
    Identifier of the exemption certificate for item lines that have the Output tax Exempt attribute set to E-exempt.
  • Title: Tax Exemption Reason
    Maximum Length: 30
    Indicates the code for the reason for tax exemption on lines that have the Output tax Exempt attribute set to E-exempt.
  • Title: Payment Term ID
    Read Only: true
    Unique identifier of the payment term for the receipt from Accounts Receivable (AR) which is applied against the agreement.
  • Title: Payment Term
    Read Only: true
    Maximum Length: 15
    Name of the payment term.
  • Title: Product Category
    Maximum Length: 240
    A classification of products used for tax purposes.
  • Title: Product FC Category ID
    Unique identifier of the product fiscal classification category.
  • Title: Product Fiscal Classification
    Maximum Length: 240
    A classification of the products based on the inventory item category by the tax authority for tax purposes.
  • Title: Product Type
    Maximum Length: 240
    This 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.
  • Title: Receiver Project ID
    Read Only: true
    Unique identifier of the receiver project.
  • Title: Receiver Task ID
    Read Only: true
    Unique identifier of the receiver task.
  • Title: Ship-to Account Description
    Read Only: true
    Account description of the ship-to customer on the invoice line.
  • Title: Ship-to Account Number
    Account number of the ship-to customer on the invoice line.
  • Title: Ship-to Address
    Read Only: true
    Address of the ship-to customer on the invoice line.
  • Title: Ship-to Contact ID
    Read Only: true
    Unique identifier of the ship-to contact. A representative for the ship to customer of the project.
  • Title: Ship-to Customer
    Unique identifier of the customer account ship-to address that is the project customer's default work site for the project.
  • Title: Ship-to Customer
    Read Only: true
    Name of the ship-to customer on the invoice line.
  • Title: Ship-to Site Use ID
    Unique 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.
  • Title: Ship-to Site
    Unique identifier of the ship-to site on the invoice line.
  • Title: Transaction Business Category
    Maximum Length: 240
    A classification or categorization of an invoice line for tax purposes as required by a tax authority.
  • Title: Translated Description
    Maximum Length: 1000
    The translated text of the invoice line. This text is in the language defined in invoice header.
  • Title: User-Defined Fiscal Classification
    Maximum Length: 30
    Indicates the default taxation country.
  • Title: Work Type ID
    Read Only: true
    Unique identifier of the work type.
  • Title: Work Type
    Read Only: true
    Maximum Length: 240
    Name of the work type.
Nested Schema : Invoice Line Descriptive Flexfields
Type: array
Title: Invoice Line Descriptive Flexfields
A listing of all the descriptive flexfields available for invoice lines.
Show Source
Nested Schema : Invoice Line Distributions
Type: array
Title: Invoice Line Distributions
The Invoice Line Distributions resource is used to view the details of invoice line distributions.
Show Source
Nested Schema : projectContractInvoices-InvoiceLines-InvoiceLineDff-item-response
Type: object
Show Source
Nested Schema : projectContractInvoices-InvoiceLines-InvoiceLineDistributions-item-response
Type: object
Show Source
  • Title: Billing Extension ID
    Read Only: true
    Unique identifier of billing extension used for the transaction.
  • Title: Billing Job Title
    Read Only: true
    Maximum Length: 80
    Indicates the title for the billing job.
  • Title: Billing Resource ID
    Read Only: true
    Unique identifier of resource breakdown structure element.
  • Title: Bill Job ID
    Read Only: true
    Unique identifier of the effective job used when invoicing a labor item as of the last time the expenditure item was invoiced.
  • Title: Bill Plan ID
    Read Only: true
    Unique identifier of the bill plan for the invoice distribution.
  • Title: Bill Rate
    Read Only: true
    Bill rate used in deriving the transfer price if the transfer price was based on a rate defined in a bill rate schedule.
  • Title: Bill Set
    Read Only: true
    Number of the bill set which is defined in bill plan related to the invoice distribution.
  • Title: Billing Transaction Type Code
    Read Only: true
    Maximum Length: 30
    Indicates the code used to classify the type of bill transaction. Valid values are EI - Expenditure Item or EVT - Billing Event and defined in the lookup PJB_BILL_TRANSACTION_TYPE.
  • Title: Invoice Amount in Contract Currency
    Read Only: true
    Amount billed in currency of the contract.
  • Title: Contract Currency
    Read Only: true
    Maximum Length: 30
    Indicates the code of the currency for the contract related to the distribution.
  • Title: Contract Currency Invoice Date Type
    Read Only: true
    Maximum Length: 30
    Indicates the currency conversion date type used to convert the contract to the invoice currency.
  • Title: Contract Currency Invoice Conversion Date
    Read Only: true
    Indicates the date used for the conversion of the rates on the contract for the invoice.
  • Title: Contract Currency Invoice Conversion Rate
    Read Only: true
    Indicates the rate used to convert the invoice amounts from the transaction currency to the contract currency.
  • Title: Contract Currency Rate Type Code
    Read Only: true
    Maximum Length: 30
    Indicates the code for the contract currency rate type.
  • Title: Contract Line ID
    Read Only: true
    Unique Identifier of the contract line for the invoice distribution.
  • Title: Contract Line Number
    Read Only: true
    Maximum Length: 150
    Number of the contract line for the invoice distribution.
  • Title: Origin of Adjustment
    Read Only: true
    Unique identifier of distribution credited by this distribution.
  • Title: Credited Invoice ID
    Read Only: true
    Unique identifier of invoice that is credited by this distribution.
  • Title: Credited Invoice Line ID
    Read Only: true
    Unique identifier of invoice line that is credited by this distribution.
  • Title: Document Number
    Read Only: true
    Maximum Length: 240
    Number that identifies a document on the bill plan of a grants contract.
  • Title: Employee Billing Title
    Read Only: true
    Maximum Length: 80
    Employee billing title.
  • Title: Intercompany Transfer Price Amount Type
    Read Only: true
    Maximum Length: 30
    Amount type code used for an inter company price amount.
  • Title: Intercompany Transfer Price Base
    Read Only: true
    Maximum Length: 30
    Indicates the intercompany transfer price base code of an intercompany transfer invoice.
  • Title: Intended Use
    Read Only: true
    Maximum Length: 240
    A classification of the products by tax authority for tax purposes.
  • Title: Intended Use Classification ID
    Read Only: true
    Unique identifier of the intended use classification.
  • Title: Invoice Burden Compile Set
    Read Only: true
    Unique identifier of the compiled set used to calculate a burden schedule. This only applies to invoice distributions based on billing event detail.
  • Title: Rate Change Reason
    Read Only: true
    Maximum Length: 30
    Reason code for discount override or rate override.
  • Title: Invoice Distribution Type
    Read Only: true
    Maximum Length: 30
    Indicates the code of the type used to classify invoice distribution. Valid values are WRITE_OFF, CONCESSION, CANCEL, STANDARD, and CREDIT_MEMO.
  • Title: Invoice Distribution Number
    Read Only: true
    Number that identifies the invoice distribution.
  • Title: Invoice Amount Calculation Code
    Read Only: true
    Maximum Length: 30
    Indicates the code for the invoice amount calculation. Valid values are I - Indirect, O - Overrides, E - Extension, B - Bill rates, L - Labor Multiplier.
  • Title: Invoice Amount in Invoice Currency
    Read Only: true
    Amount billed in the Invoice currency amount.
  • Title: Invoice Currency
    Read Only: true
    Maximum Length: 30
    Indicates the currency code for the invoice that is transferred to Oracle Receivables.
  • Title: Invoice Currency Credit Amount
    Read Only: true
    Credit amount in the invoice currency.
  • Title: Credit Percentage in Invoice Currency
    Read Only: true
    Indicates the percent of credit in the invoice currency.
  • Title: Invoice Currency Conversion Date Type
    Read Only: true
    Maximum Length: 30
    Date type of the invoice currency.
  • Title: Invoice Currency Conversion Date
    Read Only: true
    Indicates the exchange date for the conversion of the invoice currency.
  • Title: Invoice Currency Conversion Rate
    Read Only: true
    Exchange rate used for the invoice currency.
  • Title: Invoice Currency Conversion Rate Type
    Read Only: true
    Maximum Length: 30
    Rate type of the invoice currency.
  • Title: Date
    Read Only: true
    The 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.
  • Title: Discount Percentage
    Read Only: true
    Indicates 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.
  • Title: Invoice Distribution ID
    Unique identifier of the invoice distribution.
  • Title: Labor Multiplier
    Read Only: true
    A 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.
  • Title: Markup Percentage
    Read Only: true
    Indicates 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.
  • Title: Invoice Amount in Ledger Currency
    Read Only: true
    Amount billed in the currency of the ledger.
  • Title: Ledger Currency
    Read Only: true
    Maximum Length: 30
    Ledger currency code.
  • Title: Ledger Currency Invoice Date Type
    Read Only: true
    Maximum Length: 30
    Date type of the ledger currency.
  • Title: Ledger Currency Conversion Date
    Read Only: true
    Indicates the conversion date used to convert the invoice to the ledger currency.
  • Title: Ledger Currency Conversion Rate
    Read Only: true
    Indicates the conversion currency rate used to convert the invoice to the ledger currency.
  • Title: Ledger Currency Invoice Rate Type
    Read Only: true
    Maximum Length: 30
    Indicates the conversion currency rate type used to convert the invoice to the ledger currency.
  • Title: Associated Project ID
    Read Only: true
    Unique identifier of project that is linked to the contract line associated to the invoice distribution.
  • Title: Associated Project Name
    Read Only: true
    Maximum Length: 240
    Name of the project that is linked to the contract line associated to the invoice distribution.
  • Title: Associated Project Number
    Read Only: true
    Maximum Length: 25
    Number of the project that is linked to the contract line associated to the invoice distribution.
  • Title: Associated Task ID
    Read Only: true
    Unique identifier of the task that is linked to the contract line associated to the invoice distribution.
  • Title: Associated Task Name
    Read Only: true
    Maximum Length: 255
    Name of the task that is linked to the contract line associated to the invoice distribution.
  • Title: Associated Task Number
    Read Only: true
    Maximum Length: 100
    Number of the project task that is linked to the contract line associated to the invoice distribution.
  • Links
  • Title: LOC Number
    Read Only: true
    Maximum Length: 240
    Number that identifies a letter of credit on the bill plan of a grants contract.
  • Title: Product Category
    Read Only: true
    Maximum Length: 240
    A classification of products used for tax purposes.
  • Title: Product FC Category ID
    Read Only: true
    Unique identifier of the product fiscal classification category.
  • Title: Product Fiscal Classification
    Read Only: true
    Maximum Length: 240
    A classification of the products based on the inventory item category by the tax authority for tax purposes.
  • Title: Product Type
    Read Only: true
    Maximum Length: 240
    This 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.
  • Title: Invoice Amount in Project Currency
    Read Only: true
    Amount billed in the currency of the project.
  • Title: Project Currency
    Read Only: true
    Maximum Length: 30
    Indicates the currency code of the project.
  • Title: Project Currency Invoice Date Type
    Read Only: true
    Maximum Length: 30
    Date type used for conversion to the project currency.
  • Title: Project Currency Conversion Date
    Read Only: true
    Indicates the currency conversion date used to convert the invoice distribution to the project currency.
  • Title: Project Currency Conversion Rate
    Read Only: true
    Indicates the currency conversion rate used to convert the invoice currency to the project currency.
  • Title: Project Currency Invoice Rate Type
    Read Only: true
    Maximum Length: 30
    Indicates the currency conversion rate type used to convert the invoice to the project currency.
  • Title: Provider Legal Entity ID
    Read Only: true
    Unique identifier of the provider legal entity.
  • Title: Quantity
    Read Only: true
    Indicates the quantity of the source expenditure item for invoice transactions created from expenditure items.
  • Title: Receiver Legal Entity ID
    Read Only: true
    Unique identifier of the receiver legal entity.
  • Title: Transfer Price Invoice Rule Percentage
    Read Only: true
    Indicates the applied percentage value from the transfer price rule used to create an intercompany invoice.
  • Title: Transfer Price Invoice Schedule Line Percentage
    Read Only: true
    The applied percentage value from the transfer price schedule line used to create an intercompany invoice.
  • Title: Transaction Business Category
    Read Only: true
    Maximum Length: 240
    A classification or categorization of a transaction for tax purposes as required by a tax authority.
  • Title: Billed Amount in Transaction Currency
    Read Only: true
    Billed amount in the transaction currency.
  • Title: Transaction Currency
    Read Only: true
    Maximum Length: 30
    Transaction currency for the expenditure or events.
  • Title: Transaction Date
    Read Only: true
    Date when transaction occurs.
  • Title: Transaction ID
    Read Only: true
    Unique identifier of the expenditure item or event related to the invoice distribution.
  • Title: Transaction Project ID
    Read Only: true
    Unique identifier of the project related to the invoice distribution transaction.
  • Title: Transaction Project Name
    Read Only: true
    Maximum Length: 240
    Name of the project related to the invoice distribution transaction.
  • Title: Transaction Project Number
    Read Only: true
    Maximum Length: 25
    Number of the project related to the invoice distribution transaction.
  • Title: Transaction Task ID
    Read Only: true
    Unique identifier of the project task related to the invoice distribution transaction.
  • Title: Transaction Task Name
    Read Only: true
    Maximum Length: 255
    Name of the project task related to the invoice distribution transaction.
  • Title: Transaction Task Number
    Read Only: true
    Maximum Length: 100
    Number of the project task related to the invoice distribution transaction.
  • Title: Transaction Type ID
    Read Only: true
    Unique identifier of the Event Type or Expenditure Item Type related to the invoice distribution.
  • Title: User-Defined Fiscal Classification
    Read Only: true
    Maximum Length: 240
    Indicates the default taxation country.
Links
InvoiceLineDff
Parameters:
  • InvoiceId: $request.path.InvoiceId
  • InvoiceLineId: $request.path.InvoiceLineId
A listing of all the descriptive flexfields available for invoice lines.
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.
Back to Top

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"
        }
    ]
}
Back to Top