Get an invoice distribution

get

/fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceDistributions/{InvoiceDistributionId}

Request

Path Parameters
  • The unique identifier for the invoice distribution that is generated while creating an invoice distribution.
  • This is the hash key of the attributes which make up the composite key for the Invoice Lines resource and used to uniquely identify an instance of Invoice Lines. The client should not generate the hash key value. Instead, the client should query on the Invoice Lines collection resource in order to navigate to a specific instance of Invoice Lines to get the hash key.
  • This is the hash key of the attributes which make up the composite key for the Invoices resource and used to uniquely identify an instance of Invoices. The client should not generate the hash key value. Instead, the client should query on the Invoices collection resource in order to navigate to a specific instance of Invoices to get the hash key.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : invoices-invoiceLines-invoiceDistributions-item-response
Type: object
Show Source
  • The date when the invoice distribution is to be accounted. The value can either be provided while creating an invoice distribution or populated by default from the parent invoice line.
  • Title: Accounting Status
    Read Only: true
    Maximum Length: 80
    The option that indicates whether invoice distribution line has been accounted. The default value is set to Unprocessed.
  • Title: Distribution Line Number
    Read Only: true
    Indicates the invoice distribution line number to which the current distribution is allocated.
  • Read Only: true
    Indicates the invoice line number to which the current distribution is allocated.
  • Title: Asset Book
    Maximum Length: 30
    The asset book candidate for transfer to Oracle Fusion Assets.
  • Read Only: true
    Maximum Length: 255
    The other distribution line that is related to the current distribution.
  • Read Only: true
    The invoice distribution amount in the ledger currency.
  • Budgetary Calendar Period Date applicable for funds check.
  • Title: Canceled
    Maximum Length: 255
    Indicates whether an invoice distribution is canceled. The default value is false. If the value if true, then it indicates the invoice distribution is canceled.
  • Read Only: true
    Indicates the distribution line to which the freight or miscellaneous related distribution is allocated.
  • Title: Consumption Advice Line
    Read Only: true
    The line number of the consignment advice associated with the invoice distribution.
  • Title: Consumption Advice
    Read Only: true
    Maximum Length: 20
    The number of the consignment advice associated with the invoice distribution.
  • Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Read Only: true
    The date when the record was created.
  • Maximum Length: 240
    The description of the invoice description. The value can be provided while creating an invoice distribution or populated by default from the parent invoice line.
  • Title: Invoice Distribution Amount
    The amount on invoice distribution. The value must be provided while creating an invoice distribution.
  • The accounting flexfield for account associated with a distribution. The value can be provided while creating an invoice distribution or populated by default from the parent invoice line.
  • Title: Distribution Line Number
    The line number associated with the invoice distribution. The value must be provided while creating an invoice distribution and cannot be updated once the invoice distribution is created.
  • Maximum Length: 255
    The type of invoice line. The value must be provided while creating an invoice distribution. The valid values are Item, Freight and Miscellaneous. A list of accepted values is defined in the lookup type INVOICE DISTRIBUTION TYPE and can be reviewed using the Setup and Maintenance work area, and the Manage Payables Lookups task.
  • Read Only: true
    Maximum Length: 1
    Indicates if an invoice is the last one being matched to a purchase order, making the purchase order no longer available for matching to other invoices.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Indicator to check and reserve funds for the invoice distribution.
  • Title: Income Tax Region
    Maximum Length: 10
    The reporting region for invoice line for 1099 supplier. The value can be provided while creating an invoice distribution or populated by default from the parent invoice line.
  • Title: Income Tax Type
    Maximum Length: 10
    The payments of type 1099 made to a supplier. A 1099 supplier may receive payments of more than one type. The value can either be provided while creating an invoice distribution or populated by default from the parent invoice line.
  • Maximum Length: 240
    A tax driver used to determine and calculate the applicable taxes. The value can either be provided while creating an invoice line or populated by default from source document or from the respective entity setup. When passing the attribute value in the payload, ensure that you are passing a value for the intended use code attribute as well.
  • The user-entered intended use code that helps to uniquely identify an intended use.
  • Invoice Distributions Descriptive Flexfields
    Title: Invoice Distributions Descriptive Flexfields
    The payables invoice distributions descriptive flexfields resource is used to manage details about the descriptive flexfield references for an invoice distribution.
  • Invoice Distributions Global Descriptive Flexfields
    Title: Invoice Distributions Global Descriptive Flexfields
    The payables invoice distributions global descriptive flexfields resource is used to manage details about the global descriptive flexfield references for an invoice distribution.
  • Read Only: true
    The unique identifier for the invoice distribution that is generated while creating an invoice distribution.
  • Invoice Distributions Project Descriptive Flexfields
    Title: Invoice Distributions Project Descriptive Flexfields
    The payables invoice distribution project descriptive flexfields resource is used to manage details about the project information for an invoice distribution.
  • Read Only: true
    The quantity that was invoiced.
  • Read Only: true
    The date when the record was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Read Only: true
    Maximum Length: 32
    The session login associated to the user who last updated the record.
  • Links
  • Title: Matched
    Read Only: true
    Maximum Length: 80
    The option that indicates whether the invoice distribution is generated for a purchase order matched line. The default value is set to Not Matched.
  • The accrual account used in multiperiod accounting to accrue deferred expenses.
  • Title: Multiperiod Accounting End Date
    The multiperiod accounting end date on the invoice distribution.
  • Title: Multiperiod Accounting Start Date
    The multiperiod accounting start date on the invoice distribution.
  • The amount of the prepayment that can still be applied to an invoice.
  • Read Only: true
    Maximum Length: 255
    The prepayment distribution line number related to the prepayment line.
  • Read Only: true
    Maximum Length: 255
    The prepayment invoice line number that's applied to the invoice.
  • Read Only: true
    Maximum Length: 255
    The prepayment invoice number that's applied to the invoice.
  • Title: Distribution
    Read Only: true
    The purchase order distribution line number that is matched to the invoice distribution.
  • Title: Line
    Read Only: true
    The purchase order line number that is matched to the invoice distribution.
  • Title: Order
    Read Only: true
    Maximum Length: 30
    The purchase order document number that is matched to the invoice distribution.
  • Title: Schedule
    Read Only: true
    The purchase order schedule line number that is matched to the invoice distribution.
  • Read Only: true
    The line number of the receipt number associated with the invoice distribution.
  • Read Only: true
    Maximum Length: 30
    The number of the receipt of material associated with the invoice distribution.
  • Title: Reversed
    Maximum Length: 255
    Default Value: false
    Indicates whether a distribution is part of a reversal pair. The default value is false. If the value if true, then it indicates the distribution is part of a reversal pair.
  • Read Only: true
    Maximum Length: 255
    The name of the classification of a charge imposed by a government through a fiscal or tax authority.
  • Read Only: true
    Maximum Length: 30
    The rate specified for a tax status for an effective time period. A tax rate can be expressed as a percentage or a value per unit quantity.
  • Read Only: true
    Maximum Length: 150
    A unique code for a tax rate.
  • Read Only: true
    Maximum Length: 1
    Allows the full or partial recovery of a tax, after completion of a specified task defined by the statute.
  • Read Only: true
    Maximum Length: 255
    The name of the set of tax rules that determines the treatment of one or more taxes administered by a tax authority.
  • Read Only: true
    Maximum Length: 30
    A mechanism to administer the recovery process for a specific tax.
  • Title: Track as Asset
    Maximum Length: 255
    Indicates if the item should be transferred to Oracle Fusion Assets. The value can either be provided while creating an invoice distribution or populated by default from parent invoice line or populated by default to true if an asset account is provided in the distribution combination. If the value is true, then it indicates that the item should be transferred to Oracle Fusion Assets.
  • Read Only: true
    The price charged per unit of a good or service.
  • Read Only: true
    Maximum Length: 25
    The unit of measure used for the quantity invoiced during matching of this distribution.
  • Title: Validation
    The option that indicates whether an invoice has passed validation and all invoice holds have been released. The default value is set to Not Validated.
Nested Schema : Invoice Distributions Descriptive Flexfields
Type: array
Title: Invoice Distributions Descriptive Flexfields
The payables invoice distributions descriptive flexfields resource is used to manage details about the descriptive flexfield references for an invoice distribution.
Show Source
Nested Schema : Invoice Distributions Global Descriptive Flexfields
Type: array
Title: Invoice Distributions Global Descriptive Flexfields
The payables invoice distributions global descriptive flexfields resource is used to manage details about the global descriptive flexfield references for an invoice distribution.
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "FVxUSAPInvoiceDistributions":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsGdf_view_DistributionRestGdfFVxUSAPInvoiceDistributionsVO-item-response", "JExPLInvoiceDistributions":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsGdf_view_DistributionRestGdfJExPLInvoiceDistributionsVO-item-response", "JExRUInvoiceDistributions":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsGdf_view_DistributionRestGdfJExRUInvoiceDistributionsVO-item-response", "JLxCOInvoiceDistributions":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsGdf_view_DistributionRestGdfJLxCOInvoiceDistributionsVO-item-response" } }
Nested Schema : Invoice Distributions Project Descriptive Flexfields
Type: array
Title: Invoice Distributions Project Descriptive Flexfields
The payables invoice distribution project descriptive flexfields resource is used to manage details about the project information for an invoice distribution.
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "AP_Distribution_Sets":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsPJC_view_PJCDFFAP__5FDistribution__5FSetsVO-item-response", "AP_Invoice_Distribution":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsPJC_view_PJCDFFAP__5FInvoice__5FDistributionVO-item-response", "AP_Invoice_Line":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsPJC_view_PJCDFFAP__5FInvoice__5FLineVO-item-response", "EXM_Expense_Report":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsPJC_view_PJCDFFEXM__5FExpense__5FReportVO-item-response", "EXM_Expense_Report_Line":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsPJC_view_PJCDFFEXM__5FExpense__5FReport__5FLineVO-item-response", "INV_Misc_Transactions":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsPJC_view_PJCDFFINV__5FMisc__5FTransactionsVO-item-response", "OM_Sales_Order":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsPJC_view_PJCDFFOM__5FSales__5FOrderVO-item-response", "PJC_All":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsPJC_view_PJCDFFPJC__5FAllVO-item-response", "PJC_Expenditure_Batch":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsPJC_view_PJCDFFPJC__5FExpenditure__5FBatchVO-item-response", "POR_Requisition":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsPJC_view_PJCDFFPOR__5FRequisitionVO-item-response", "POR_User_Preferences":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsPJC_view_PJCDFFPOR__5FUser__5FPreferencesVO-item-response", "PO_Purchase_Order":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsPJC_view_PJCDFFPO__5FPurchase__5FOrderVO-item-response", "PO_Purchase_Order_Line":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsPJC_view_PJCDFFPO__5FPurchase__5FOrder__5FLineVO-item-response", "PO_Purchase_Order_Schedule":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsPJC_view_PJCDFFPO__5FPurchase__5FOrder__5FScheduleVO-item-response" } }
Nested Schema : invoices-invoiceLines-invoiceDistributions-invoiceDistributionDff-item-response
Type: object
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsGdf_view_DistributionRestGdfFVxUSAPInvoiceDistributionsVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsGdf_view_DistributionRestGdfJExPLInvoiceDistributionsVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsGdf_view_DistributionRestGdfJExRUInvoiceDistributionsVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsGdf_view_DistributionRestGdfJLxCOInvoiceDistributionsVO-item-response
Type: object
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsPJC_view_PJCDFFAP__5FDistribution__5FSetsVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsPJC_view_PJCDFFAP__5FInvoice__5FDistributionVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsPJC_view_PJCDFFAP__5FInvoice__5FLineVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsPJC_view_PJCDFFEXM__5FExpense__5FReportVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsPJC_view_PJCDFFEXM__5FExpense__5FReport__5FLineVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsPJC_view_PJCDFFINV__5FMisc__5FTransactionsVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsPJC_view_PJCDFFOM__5FSales__5FOrderVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsPJC_view_PJCDFFPJC__5FAllVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsPJC_view_PJCDFFPJC__5FExpenditure__5FBatchVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsPJC_view_PJCDFFPOR__5FRequisitionVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsPJC_view_PJCDFFPOR__5FUser__5FPreferencesVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsPJC_view_PJCDFFPO__5FPurchase__5FOrderVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsPJC_view_PJCDFFPO__5FPurchase__5FOrder__5FLineVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_distributionsPJC_view_PJCDFFPO__5FPurchase__5FOrder__5FScheduleVO-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to retrieve an invoice distribution for an invoice line:
  • Get all the invoice lines for an invoice.
  • Use the self URI of the specific invoice line.
  • Get all the invoice distributions of the invoice line.
  • Use the self URI of the specific invoice distribution.

Here's the cURL command to retrieve all the invoice lines:

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100175278474/child/invoiceLines

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "items": [
        {
            "LineNumber": 1,
            "LineAmount": 2212.75,
            "AccountingDate": "2018-11-01",
            "UOM": null,
            ...
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100175278474/child/invoiceLines/00020000000EACED00057708000110F08458318A0000000AACED0005770400000001",
                    "name": "invoiceLines",
                    "kind": "item",
                    "properties": {
                                     "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                                  }
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100175278474/child/invoiceLines/00020000000EACED00057708000110F08458318A0000000AACED0005770400000001/child/invoiceLineGdf",
                    "name": "invoiceLineGdf",
                    "kind": "collection"
                },
                ...
            ]
        },
        ...
    ],
    "count": 15,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100175278474/child/invoiceLines",
            "name": "invoiceLines",
            "kind": "collection"
        }
    ]
}

A hash key of InvoiceId and LineNumber identifies an invoice line.

Here's the cURL command that uses the hash key in the self URI to retrieve the invoice line:

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100175278474/child/invoiceLines/00020000000EACED00057708000110F08458318A0000000AACED0005770400000001

Here's the cURL command that uses the child URI of the invoice line to retrieve all the invoice distributions:

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100175278474/child/invoiceLines/00020000000EACED00057708000110F08458318A0000000AACED0005770400000001/child/invoiceDistributions

Here's the cURL command that uses the self URI to retrieve the invoice distribution:

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100175278474/child/invoiceLines/00020000000EACED00057708000110F08458318A0000000AACED0005770400000001/child/invoiceDistributions/1928204

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "InvoiceDistributionId": 1928204,
    "DistributionLineNumber": 1,
    "DistributionLineType": "Item",
    "IncomeTaxType": "INDE/P",
    ...
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100175278474/child/invoiceLines/00020000000EACED00057708000110F08458318A0000000AACED0005770400000001/child/invoiceDistributions/1928204",
            "name": "invoiceDistributions",
            "kind": "item",
            "properties": {
                             "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                          }
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100175278474/child/invoiceLines/00020000000EACED00057708000110F08458318A0000000AACED0005770400000001/child/invoiceDistributions/1928204/child/invoiceDistributionDff",
            "name": "invoiceDistributionDff",
            "kind": "collection"
        },
        ...
    ]
}
Back to Top