Jump to

• Request
• Response
• Examples

Get an invoice line distribution

get

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

Request

Path Parameters

• InvoiceDistId(required): integer(int64)
  Unique identifier of the invoice distribution.
• InvoiceId(required): integer(int64)
  Unique identifier of the invoice.
• InvoiceLineId(required): integer(int64)
  Unique identifier of the invoice line.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• 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 Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : projectContractInvoices-InvoiceLines-InvoiceLineDistributions-item-response

Type: object

Show Source

• BillingExtensionId: integer (int64)
  Title: Billing Extension ID

  Read Only: true

  Unique identifier of billing extension used for the transaction.
• BillingJobTitle: string
  Title: Billing Job Title

  Read Only: true

  Maximum Length: 80

  Indicates the title for the billing job.
• BillingResourceId: integer (int64)
  Title: Billing Resource ID

  Read Only: true

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

  Read Only: true

  Unique identifier of the bill plan for the invoice distribution.
• BillRate: number
  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.
• BillSet: integer (int64)
  Title: Bill Set

  Read Only: true

  Number of the bill set which is defined in bill plan related to the invoice distribution.
• BillTransactionTypeCode: string
  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.
• ContractCurrencyBilledAmount: number
  Title: Invoice Amount in Contract Currency

  Read Only: true

  Amount billed in currency of the contract.
• ContractCurrencyCode: string
  Title: Contract Currency

  Read Only: true

  Maximum Length: 30

  Indicates the code of the currency for the contract related to the distribution.
• ContractCurrencyInvDateType: string
  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.
• ContractCurrencyInvExchgDate: string (date)
  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.
• ContractCurrencyInvExchgRate: number
  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.
• ContractCurrencyInvRateType: string
  Title: Contract Currency Rate Type Code

  Read Only: true

  Maximum Length: 30

  Indicates the code for the contract currency rate type.
• ContractLineId: integer (int64)
  Title: Contract Line ID

  Read Only: true

  Unique Identifier of the contract line for the invoice distribution.
• ContractLineNumber: string
  Title: Contract Line Number

  Read Only: true

  Maximum Length: 150

  Number of the contract line for the invoice distribution.
• CreditedDistributionId: integer (int64)
  Title: Origin of Adjustment

  Read Only: true

  Unique identifier of distribution credited by this distribution.
• CreditedInvoiceId: integer (int64)
  Title: Credited Invoice ID

  Read Only: true

  Unique identifier of invoice that is credited by this distribution.
• CreditedInvoiceLineId: integer (int64)
  Title: Credited Invoice Line ID

  Read Only: true

  Unique identifier of invoice line that is credited by this distribution.
• DocumentNumber: string
  Title: Document Number

  Read Only: true

  Maximum Length: 240

  Number that identifies a document on the bill plan of a grants contract.
• EmployeeBillingTitle: string
  Title: Employee Billing Title

  Read Only: true

  Maximum Length: 80

  Employee billing title.
• ICTpAmountTypeCode: string
  Title: Intercompany Transfer Price Amount Type

  Read Only: true

  Maximum Length: 30

  Amount type code used for an inter company price amount.
• ICTpBaseCode: string
  Title: Intercompany Transfer Price Base

  Read Only: true

  Maximum Length: 30

  Indicates the intercompany transfer price base code of an intercompany transfer invoice.
• IntendedUse: string
  Title: Intended Use

  Read Only: true

  Maximum Length: 240

  A classification of the products by tax authority for tax purposes.
• IntendedUseClassifId: integer (int64)
  Title: Intended Use Classification ID

  Read Only: true

  Unique identifier of the intended use classification.
• InvBurdenCompileSetId: integer (int64)
  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.
• InvDiscountReasonCode: string
  Title: Rate Change Reason

  Read Only: true

  Maximum Length: 30

  Reason code for discount override or rate override.
• InvDistributionTypeCode: string
  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.
• InvLineDistNumber: integer (int64)
  Title: Invoice Distribution Number

  Read Only: true

  Number that identifies the invoice distribution.
• InvoiceAmountCalculationCode: string
  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.
• InvoiceCurrencyBilledAmount: number
  Title: Invoice Amount in Invoice Currency

  Read Only: true

  Amount billed in the Invoice currency amount.
• InvoiceCurrencyCode: string
  Title: Invoice Currency

  Read Only: true

  Maximum Length: 30

  Indicates the currency code for the invoice that is transferred to Oracle Receivables.
• InvoiceCurrencyCreditAmount: number
  Title: Invoice Currency Credit Amount

  Read Only: true

  Credit amount in the invoice currency.
• InvoiceCurrencyCreditPct: number
  Title: Credit Percentage in Invoice Currency

  Read Only: true

  Indicates the percent of credit in the invoice currency.
• InvoiceCurrencyDateType: string
  Title: Invoice Currency Conversion Date Type

  Read Only: true

  Maximum Length: 30

  Date type of the invoice currency.
• InvoiceCurrencyExchgDate: string (date)
  Title: Invoice Currency Conversion Date

  Read Only: true

  Indicates the exchange date for the conversion of the invoice currency.
• InvoiceCurrencyExchgRate: number
  Title: Invoice Currency Conversion Rate

  Read Only: true

  Exchange rate used for the invoice currency.
• InvoiceCurrencyRateType: string
  Title: Invoice Currency Conversion Rate Type

  Read Only: true

  Maximum Length: 30

  Rate type of the invoice currency.
• InvoiceDate: string (date)
  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.
• InvoiceDiscountPercentage: number
  Title: Discount Percentage

  Read Only: true

  Indicates a discount percentage, expressed as a proportion multiplied by 100, that is used to calculate the adjusted invoice and rate. The percentage used is based on the markup defined in the bill rate schedule.
• InvoiceDistId: integer (int64)
  Title: Invoice Distribution ID

  Unique identifier of the invoice distribution.
• InvoiceLaborMultiplier: number
  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.
• InvoiceMarkupPercentage: number
  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.
• LedgerCurrencyBilledAmount: number
  Title: Invoice Amount in Ledger Currency

  Read Only: true

  Amount billed in the currency of the ledger.
• LedgerCurrencyCode: string
  Title: Ledger Currency

  Read Only: true

  Maximum Length: 30

  Ledger currency code.
• LedgerCurrencyInvDateType: string
  Title: Ledger Currency Invoice Date Type

  Read Only: true

  Maximum Length: 30

  Date type of the ledger currency.
• LedgerCurrencyInvExchgDate: string (date)
  Title: Ledger Currency Conversion Date

  Read Only: true

  Indicates the conversion date used to convert the invoice to the ledger currency.
• LedgerCurrencyInvExchgRate: number
  Title: Ledger Currency Conversion Rate

  Read Only: true

  Indicates the conversion currency rate used to convert the invoice to the ledger currency.
• LedgerCurrencyInvRateType: string
  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.
• LinkedProjectId: integer (int64)
  Title: Associated Project ID

  Read Only: true

  Unique identifier of project that is linked to the contract line associated to the invoice distribution.
• LinkedProjectName: string
  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.
• LinkedProjectNumber: string
  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.
• LinkedTaskId: integer (int64)
  Title: Associated Task ID

  Read Only: true

  Unique identifier of the task that is linked to the contract line associated to the invoice distribution.
• LinkedTaskName: string
  Title: Associated Task Name

  Read Only: true

  Maximum Length: 255

  Name of the task that is linked to the contract line associated to the invoice distribution.
• LinkedTaskNumber: string
  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: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocNumber: string
  Title: LOC Number

  Read Only: true

  Maximum Length: 240

  Number that identifies a letter of credit on the bill plan of a grants contract.
• ProductCategory: string
  Title: Product Category

  Read Only: true

  Maximum Length: 240

  A classification of products used for tax purposes.
• ProductFcCategoryId: integer (int64)
  Title: Product FC Category ID

  Read Only: true

  Unique identifier of the product fiscal classification category.
• ProductFiscClassification: string
  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.
• ProductType: string
  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.
• ProjectCurrencyBilledAmount: number
  Title: Invoice Amount in Project Currency

  Read Only: true

  Amount billed in the currency of the project.
• ProjectCurrencyCode: string
  Title: Project Currency

  Read Only: true

  Maximum Length: 30

  Indicates the currency code of the project.
• ProjectCurrencyInvDateType: string
  Title: Project Currency Invoice Date Type

  Read Only: true

  Maximum Length: 30

  Date type used for conversion to the project currency.
• ProjectCurrencyInvExchgDate: string (date)
  Title: Project Currency Conversion Date

  Read Only: true

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

  Read Only: true

  Indicates the currency conversion rate used to convert the invoice currency to the project currency.
• ProjectCurrencyInvRateType: string
  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.
• ProviderLegalEntityId: integer (int64)
  Title: Provider Legal Entity ID

  Read Only: true

  Unique identifier of the provider legal entity.
• Quantity: integer
  Title: Quantity

  Read Only: true

  Indicates the quantity of the source expenditure item for invoice transactions created from expenditure items.
• ReceiverLegalEntityId: integer (int64)
  Title: Receiver Legal Entity ID

  Read Only: true

  Unique identifier of the receiver legal entity.
• TpInvRulePercentage: number
  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.
• TpInvSchLinePercentage: number
  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.
• TransactionBusinessCategory: string
  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.
• TransactionCurrencyBilledAmount: number
  Title: Billed Amount in Transaction Currency

  Read Only: true

  Billed amount in the transaction currency.
• TransactionCurrencyCode: string
  Title: Transaction Currency

  Read Only: true

  Maximum Length: 30

  Transaction currency for the expenditure or events.
• TransactionDate: string (date)
  Title: Transaction Date

  Read Only: true

  Date when transaction occurs.
• TransactionId: integer (int64)
  Title: Transaction ID

  Read Only: true

  Unique identifier of the expenditure item or event related to the invoice distribution.
• TransactionProjectId: integer (int64)
  Title: Transaction Project ID

  Read Only: true

  Unique identifier of the project related to the invoice distribution transaction.
• TransactionProjectName: string
  Title: Transaction Project Name

  Read Only: true

  Maximum Length: 240

  Name of the project related to the invoice distribution transaction.
• TransactionProjectNumber: string
  Title: Transaction Project Number

  Read Only: true

  Maximum Length: 25

  Number of the project related to the invoice distribution transaction.
• TransactionTaskId: integer (int64)
  Title: Transaction Task ID

  Read Only: true

  Unique identifier of the project task related to the invoice distribution transaction.
• TransactionTaskName: string
  Title: Transaction Task Name

  Read Only: true

  Maximum Length: 255

  Name of the project task related to the invoice distribution transaction.
• TransactionTaskNumber: string
  Title: Transaction Task Number

  Read Only: true

  Maximum Length: 100

  Number of the project task related to the invoice distribution transaction.
• TransactionTypeId: integer (int64)
  Title: Transaction Type ID

  Read Only: true

  Unique identifier of the Event Type or Expenditure Item Type related to the invoice distribution.
• UserDefinedFiscalClass: string
  Title: User-Defined Fiscal Classification

  Read Only: true

  Maximum Length: 240

  Indicates the default taxation country.

{
    "type":"object",
    "properties":{
        "LedgerCurrencyBilledAmount":{
            "title":"Invoice Amount in Ledger Currency",
            "type":"number",
            "description":"Amount billed in the currency of the ledger.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LedgerCurrencyInvExchgRate":{
            "title":"Ledger Currency Conversion Rate",
            "type":"number",
            "description":"Indicates the conversion currency rate used to convert the invoice to the ledger currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceCurrencyCreditAmount":{
            "title":"Invoice Currency Credit Amount",
            "type":"number",
            "description":"Credit amount in the invoice currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractLineId":{
            "title":"Contract Line ID",
            "type":"integer",
            "description":"Unique Identifier of the contract line for the invoice distribution.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TransactionTypeId":{
            "title":"Transaction Type ID",
            "type":"integer",
            "description":"Unique identifier of the Event Type or Expenditure Item Type related to the invoice distribution.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TransactionProjectNumber":{
            "title":"Transaction Project Number",
            "maxLength":"25",
            "type":"string",
            "description":"Number of the project related to the invoice distribution transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillingJobTitle":{
            "title":"Billing Job Title",
            "maxLength":"80",
            "type":"string",
            "description":"Indicates the title for the billing job.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectCurrencyInvExchgDate":{
            "title":"Project Currency Conversion Date",
            "type":"string",
            "description":"Indicates the currency conversion date used to convert the invoice distribution to the project currency.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LedgerCurrencyInvDateType":{
            "title":"Ledger Currency Invoice Date Type",
            "maxLength":"30",
            "type":"string",
            "description":"Date type of the ledger currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceLaborMultiplier":{
            "title":"Labor Multiplier",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectCurrencyCode":{
            "title":"Project Currency",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the currency code of the project.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionTaskNumber":{
            "title":"Transaction Task Number",
            "maxLength":"100",
            "type":"string",
            "description":"Number of the project task related to the invoice distribution transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntendedUseClassifId":{
            "title":"Intended Use Classification ID",
            "type":"integer",
            "description":"Unique identifier of the intended use classification.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LinkedTaskName":{
            "title":"Associated Task Name",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the task that is linked to the contract line associated to the invoice distribution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmployeeBillingTitle":{
            "title":"Employee Billing Title",
            "maxLength":"80",
            "type":"string",
            "description":"Employee billing title.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillSet":{
            "title":"Bill Set",
            "type":"integer",
            "description":"Number of the bill set which is defined in bill plan related to the invoice distribution.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreditedInvoiceId":{
            "title":"Credited Invoice ID",
            "type":"integer",
            "description":"Unique identifier of invoice that is credited by this distribution.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TransactionProjectName":{
            "title":"Transaction Project Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the project related to the invoice distribution transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InvDistributionTypeCode":{
            "title":"Invoice Distribution Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the code of the type used to classify invoice distribution. Valid values are WRITE_OFF, CONCESSION, CANCEL, STANDARD, and CREDIT_MEMO.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceCurrencyDateType":{
            "title":"Invoice Currency Conversion Date Type",
            "maxLength":"30",
            "type":"string",
            "description":"Date type of the invoice currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditedDistributionId":{
            "title":"Origin of Adjustment",
            "type":"integer",
            "description":"Unique identifier of distribution credited by this distribution.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProviderLegalEntityId":{
            "title":"Provider Legal Entity ID",
            "type":"integer",
            "description":"Unique identifier of the provider legal entity.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InvoiceAmountCalculationCode":{
            "title":"Invoice Amount Calculation Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the code for the invoice amount calculation. Valid values are I - Indirect, O - Overrides, E - Extension, B - Bill rates, L - Labor Multiplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiverLegalEntityId":{
            "title":"Receiver Legal Entity ID",
            "type":"integer",
            "description":"Unique identifier of the receiver legal entity.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InvoiceCurrencyExchgDate":{
            "title":"Invoice Currency Conversion Date",
            "type":"string",
            "description":"Indicates the exchange date for the conversion of the invoice currency.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UserDefinedFiscalClass":{
            "title":"User-Defined Fiscal Classification",
            "maxLength":"240",
            "type":"string",
            "description":"Indicates the default taxation country.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductFcCategoryId":{
            "title":"Product FC Category ID",
            "type":"integer",
            "description":"Unique identifier of the product fiscal classification category.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProductType":{
            "title":"Product Type",
            "maxLength":"240",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectCurrencyBilledAmount":{
            "title":"Invoice Amount in Project Currency",
            "type":"number",
            "description":"Amount billed in the currency of the project.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectCurrencyInvExchgRate":{
            "title":"Project Currency Conversion Rate",
            "type":"number",
            "description":"Indicates the currency conversion rate used to convert the invoice currency to the project currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionCurrencyBilledAmount":{
            "title":"Billed Amount in Transaction Currency",
            "type":"number",
            "description":"Billed amount in the transaction currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkedTaskNumber":{
            "title":"Associated Task Number",
            "maxLength":"100",
            "type":"string",
            "description":"Number of the project task that is linked to the contract line associated to the invoice distribution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceDiscountPercentage":{
            "title":"Discount Percentage",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionTaskName":{
            "title":"Transaction Task Name",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the project task related to the invoice distribution transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionId":{
            "title":"Transaction ID",
            "type":"integer",
            "description":"Unique identifier of the expenditure item or event related to the invoice distribution.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BillTransactionTypeCode":{
            "title":"Billing Transaction Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the code used to classify the type of bill transaction. Valid values are EI - Expenditure Item or EVT - Billing Event and defined in the lookup PJB_BILL_TRANSACTION_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ICTpAmountTypeCode":{
            "title":"Intercompany Transfer Price Amount Type",
            "maxLength":"30",
            "type":"string",
            "description":"Amount type code used for an inter company price amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceCurrencyBilledAmount":{
            "title":"Invoice Amount in Invoice Currency",
            "type":"number",
            "description":"Amount billed in the Invoice currency amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractCurrencyInvRateType":{
            "title":"Contract Currency Rate Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the code for the contract currency rate type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocNumber":{
            "title":"LOC Number",
            "maxLength":"240",
            "type":"string",
            "description":"Number that identifies a letter of credit on the bill plan of a grants contract.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LedgerCurrencyInvExchgDate":{
            "title":"Ledger Currency Conversion Date",
            "type":"string",
            "description":"Indicates the conversion date used to convert the invoice to the ledger currency.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractCurrencyBilledAmount":{
            "title":"Invoice Amount in Contract Currency",
            "type":"number",
            "description":"Amount billed in currency of the contract.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductCategory":{
            "title":"Product Category",
            "maxLength":"240",
            "type":"string",
            "description":"A classification of products used for tax purposes.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceDistId":{
            "title":"Invoice Distribution ID",
            "type":"integer",
            "description":"Unique identifier of the invoice distribution.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ContractCurrencyInvExchgRate":{
            "title":"Contract Currency Invoice Conversion Rate",
            "type":"number",
            "description":"Indicates the rate used to convert the invoice amounts from the transaction currency to the contract currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TpInvSchLinePercentage":{
            "title":"Transfer Price Invoice Schedule Line Percentage",
            "type":"number",
            "description":"The applied percentage value from the transfer price schedule line used to create an intercompany invoice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractCurrencyInvDateType":{
            "title":"Contract Currency Invoice Date Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the currency conversion date type used to convert the contract to the invoice currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractCurrencyCode":{
            "title":"Contract Currency",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the code of the currency for the contract related to the distribution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceCurrencyCode":{
            "title":"Invoice Currency",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the currency code for the invoice that is transferred to Oracle Receivables.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TpInvRulePercentage":{
            "title":"Transfer Price Invoice Rule Percentage",
            "type":"number",
            "description":"Indicates the applied percentage value from the transfer price rule used to create an intercompany invoice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkedTaskId":{
            "title":"Associated Task ID",
            "type":"integer",
            "description":"Unique identifier of the task that is linked to the contract line associated to the invoice distribution.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreditedInvoiceLineId":{
            "title":"Credited Invoice Line ID",
            "type":"integer",
            "description":"Unique identifier of invoice line that is credited by this distribution.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProjectCurrencyInvDateType":{
            "title":"Project Currency Invoice Date Type",
            "maxLength":"30",
            "type":"string",
            "description":"Date type used for conversion to the project currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionProjectId":{
            "title":"Transaction Project ID",
            "type":"integer",
            "description":"Unique identifier of the project related to the invoice distribution transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InvoiceMarkupPercentage":{
            "title":"Markup Percentage",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkedProjectNumber":{
            "title":"Associated Project Number",
            "maxLength":"25",
            "type":"string",
            "description":"Number of the project that is linked to the contract line associated to the invoice distribution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IntendedUse":{
            "title":"Intended Use",
            "maxLength":"240",
            "type":"string",
            "description":"A classification of the products by tax authority for tax purposes.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceCurrencyExchgRate":{
            "title":"Invoice Currency Conversion Rate",
            "type":"number",
            "description":"Exchange rate used for the invoice currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceCurrencyRateType":{
            "title":"Invoice Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"Rate type of the invoice currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionTaskId":{
            "title":"Transaction Task ID",
            "type":"integer",
            "description":"Unique identifier of the project task related to the invoice distribution transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProjectCurrencyInvRateType":{
            "title":"Project Currency Invoice Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the currency conversion rate type used to convert the invoice to the project currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LedgerCurrencyCode":{
            "title":"Ledger Currency",
            "maxLength":"30",
            "type":"string",
            "description":"Ledger currency code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceDate":{
            "title":"Date",
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionDate":{
            "title":"Transaction Date",
            "type":"string",
            "description":"Date when transaction occurs.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillJobId":{
            "title":"Bill Job ID",
            "type":"integer",
            "description":"Unique identifier of the effective job used when invoicing a labor item as of the last time the expenditure item was invoiced.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InvLineDistNumber":{
            "title":"Invoice Distribution Number",
            "type":"integer",
            "description":"Number that identifies the invoice distribution.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BillPlanId":{
            "title":"Bill Plan ID",
            "type":"integer",
            "description":"Unique identifier of the bill plan for the invoice distribution.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"integer",
            "description":"Indicates the quantity of the source expenditure item for invoice transactions created from expenditure items.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentNumber":{
            "title":"Document Number",
            "maxLength":"240",
            "type":"string",
            "description":"Number that identifies a document on the bill plan of a grants contract.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionCurrencyCode":{
            "title":"Transaction Currency",
            "maxLength":"30",
            "type":"string",
            "description":"Transaction currency for the expenditure or events.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillingExtensionId":{
            "title":"Billing Extension ID",
            "type":"integer",
            "description":"Unique identifier of billing extension used for the transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TransactionBusinessCategory":{
            "title":"Transaction Business Category",
            "maxLength":"240",
            "type":"string",
            "description":"A classification or categorization of a transaction for tax purposes as required by a tax authority.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LedgerCurrencyInvRateType":{
            "title":"Ledger Currency Invoice Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the conversion currency rate type used to convert the invoice to the ledger currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillingResourceId":{
            "title":"Billing Resource ID",
            "type":"integer",
            "description":"Unique identifier of resource breakdown structure element.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ContractLineNumber":{
            "title":"Contract Line Number",
            "maxLength":"150",
            "type":"string",
            "description":"Number of the contract line for the invoice distribution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceCurrencyCreditPct":{
            "title":"Credit Percentage in Invoice Currency",
            "type":"number",
            "description":"Indicates the percent of credit in the invoice currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductFiscClassification":{
            "title":"Product Fiscal Classification",
            "maxLength":"240",
            "type":"string",
            "description":"A classification of the products based on the inventory item category by the tax authority for tax purposes.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkedProjectId":{
            "title":"Associated Project ID",
            "type":"integer",
            "description":"Unique identifier of project that is linked to the contract line associated to the invoice distribution.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InvBurdenCompileSetId":{
            "title":"Invoice Burden Compile Set",
            "type":"integer",
            "description":"Unique identifier of the compiled set used to calculate a burden schedule. This only applies to invoice distributions based on billing event detail.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ICTpBaseCode":{
            "title":"Intercompany Transfer Price Base",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the intercompany transfer price base code of an intercompany transfer invoice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillRate":{
            "title":"Bill Rate",
            "type":"number",
            "description":"Bill rate used in deriving the transfer price if the transfer price was based on a rate defined in a bill rate schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractCurrencyInvExchgDate":{
            "title":"Contract Currency Invoice Conversion Date",
            "type":"string",
            "description":"Indicates the date used for the conversion of the rates on the contract for the invoice.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvDiscountReasonCode":{
            "title":"Rate Change Reason",
            "maxLength":"30",
            "type":"string",
            "description":"Reason code for discount override or rate override.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkedProjectName":{
            "title":"Associated Project Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the project that is linked to the contract line associated to the invoice distribution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

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

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

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

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

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

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

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

Nested Schema : properties

Type: object

Show Source

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

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

Back to Top

Examples

The following example shows how to get all invoice line distributions 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/projectContractInvoices/100100085970023/child/InvoiceLines/100100085970024/child/InvoiceLineDistributions/100100085970021

Example of Response Body

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

{
"items": [
  {
"EmployeeBillingTitle": null,
"BillingJobTitle": null,
"BillJobId": null,
"BillPlanId": 300100169214485,
"BillRate": 0,
"BillSet": 1,
"BillTransactionTypeCode": "EVT",
"BillingExtensionId": null,
"ContractCurrencyBilledAmount": 2500,
"ContractCurrencyInvDateType": null,
"ContractCurrencyInvExchgDate": null,
"ContractCurrencyInvExchgRate": 1,
"ContractCurrencyInvRateType": null,
"ContractCurrencyCode": "USD",
"ContractLineId": 300100169214487,
"CreditedDistributionId": null,
"CreditedInvoiceId": null,
"CreditedInvoiceLineId": null,
"DocumentNumber": null,
"ICTpAmountTypeCode": null,
"ICTpBaseCode": null,
"IntendedUse": null,
"IntendedUseClassifId": null,
"InvDiscountReasonCode": null,
"InvDistributionTypeCode": "STANDARD",
"InvLineDistNumber": 1,
"InvoiceAmountCalculationCode": null,
"InvoiceCurrencyBilledAmount": 2500,
"InvoiceCurrencyCreditAmount": null,
"InvoiceCurrencyCreditPct": null,
"InvoiceCurrencyDateType": null,
"InvoiceCurrencyExchgDate": null,
"InvoiceCurrencyExchgRate": 1,
"InvoiceCurrencyRateType": null,
"InvoiceCurrencyCode": "USD",
"InvoiceDate": "2018-09-17",
"InvoiceDiscountPercentage": null,
"InvoiceDistId": 100100085970021,
"InvoiceLaborMultiplier": null,
"InvoiceMarkupPercentage": null,
"LedgerCurrencyBilledAmount": null,
"LedgerCurrencyInvDateType": null,
"LedgerCurrencyInvExchgDate": null,
"LedgerCurrencyInvExchgRate": null,
"LedgerCurrencyInvRateType": null,
"LedgerCurrencyCode": null,
"LinkedProjectId": 300100169214449,
"LinkedTaskId": 100100085968379,
"LocNumber": null,
"ProductFcCategoryId": null,
"ProductCategory": null,
"ProductFiscClassification": null,
"ProductType": null,
"ProjectCurrencyInvDateType": null,
"ProjectCurrencyBilledAmount": null,
"ProjectCurrencyInvExchgDate": null,
"ProjectCurrencyInvExchgRate": null,
"ProjectCurrencyInvRateType": null,
"ProjectCurrencyCode": null,
"ProviderLegalEntityId": null,
"BillingResourceId": 300100084601044,
"ReceiverLegalEntityId": null,
"TpInvRulePercentage": null,
"TpInvSchLinePercentage": null,
"TransactionDate": "2017-01-01",
"TransactionId": 300100169214498,
"TransactionProjectId": 300100169214449,
"TransactionTaskId": 100100085968379,
"TransactionTypeId": 10096,
"TransactionCurrencyBilledAmount": 2500,
"TransactionCurrencyCode": "USD",
"TransactionBusinessCategory": "SALES_TRANSACTION",
"UserDefinedFiscalClass": null,
"Quantity": null,
"ContractLineNumber": "1",
"TransactionProjectName": "PJB Bug 28128344",
"LinkedProjectName": "PJB Bug 28128344",
"TransactionTaskName": "Fixture Install",
"LinkedTaskName": "Fixture Install",
"InvBurdenCompileSetId": null,
"TransactionProjectNumber": "PJB Bug 28128344",
"LinkedProjectNumber": "PJB Bug 28128344",
"TransactionTaskNumber": "2.3",
"LinkedTaskNumber": "2.3"
}

Back to Top