REST API for Oracle Fusion Cloud SCM

Update a landed cost charge

patch

/fscmRestApi/resources/11.13.18.05/invoicesForLandedCostCharges/{invoicesForLandedCostChargesUniqID}

Request

Path Parameters

invoicesForLandedCostChargesUniqID(required): string

This is the hash key of the attributes which make up the composite key for the Invoices for Landed Cost Charges resource and used to uniquely identify an instance of Invoices for Landed Cost Charges. The client should not generate the hash key value. Instead, the client should query on the Invoices for Landed Cost Charges collection resource in order to navigate to a specific instance of Invoices for Landed Cost Charges to get the hash key.

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.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

ChargeBUId: integer (int64)

Title: Charge Business Unit ID

Value that uniquely identifies the business unit associated with the trade operation charge.
ChargeId: integer (int64)

Title: Charge ID

Value that uniquely identifies the trade operation charge.
landedCostChargeReferencesForInvoiceLines: array References

Title: References

The References for Landed Cost Charges manages the charge references on the charge used for invoice association.

{
    "type":"object",
    "properties":{
        "ChargeId":{
            "title":"Charge ID",
            "type":"integer",
            "description":"Value that uniquely identifies the trade operation charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "fnd:APPLCORE_SETID_DETERMINANT_ATTR":"PrcBuId"
            }
        },
        "ChargeBUId":{
            "title":"Charge Business Unit ID",
            "type":"integer",
            "description":"Value that uniquely identifies the business unit associated with the trade operation charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "fnd:APPLCORE_SETID_DETERMINANT_TYPE":"BU"
            }
        },
        "landedCostChargeReferencesForInvoiceLines":{
            "title":"References",
            "type":"array",
            "description":"The References for Landed Cost Charges manages the charge references on the charge used for invoice association.",
            "items":{
                "$ref":"#/components/schemas/invoicesForLandedCostCharges-landedCostChargeReferencesForInvoiceLines-item-patch-request"
            }
        }
    }
}

Nested Schema : References

Type: array

Title: References

The References for Landed Cost Charges manages the charge references on the charge used for invoice association.

Show Source

Array of: object schema

{
    "title":"References",
    "type":"array",
    "description":"The References for Landed Cost Charges manages the charge references on the charge used for invoice association.",
    "items":{
        "$ref":"#/components/schemas/invoicesForLandedCostCharges-landedCostChargeReferencesForInvoiceLines-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

ChargeReferenceDataType: string

Title: Reference Data Type

Value that identifies the type of input data for charge references.
ChargeReferenceName: string

Title: Charge Reference Name

Name of the charge reference type.
ChargeReferenceTypeId: integer (int64)

Title: Charge Reference Type ID

Value that uniquely identifies the type of charge reference.
InvoiceChargeReferenceId: integer (int64)

Title: Invoice Charge Reference ID

Value that uniquely identifies the invoice charge reference.
ProcurementBUId: integer (int64)

Title: Procurement Business Unit ID

Value that uniquely identifies the procurement business unit.
ReferenceValueDate: string (date-time)

Title: Date Reference

Date value of the charge reference.
ReferenceValueNumber: number

Title: Numeric Reference

Number that identifies the charge reference.
ReferenceValueText: string

Title: Alphanumeric Reference

Maximum Length: 64

Text of the charge reference.
UserComment: string

Title: Comments

Maximum Length: 240

Comments added by the user for the charge reference.

{
    "type":"object",
    "properties":{
        "ChargeReferenceTypeId":{
            "title":"Charge Reference Type ID",
            "type":"integer",
            "description":"Value that uniquely identifies the type of charge reference.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:APPLCORE_SETID_DETERMINANT_ATTR":"PrcBuId"
            }
        },
        "ProcurementBUId":{
            "title":"Procurement Business Unit ID",
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ChargeReferenceDataType":{
            "title":"Reference Data Type",
            "type":"string",
            "description":"Value that identifies the type of input data for charge references.",
            "nullable":true,
            "x-queryable":false
        },
        "ReferenceValueText":{
            "title":"Alphanumeric Reference",
            "maxLength":"64",
            "type":"string",
            "description":"Text of the charge reference.",
            "nullable":true
        },
        "ReferenceValueNumber":{
            "title":"Numeric Reference",
            "type":"number",
            "description":"Number that identifies the charge reference.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "UserComment":{
            "title":"Comments",
            "maxLength":"240",
            "type":"string",
            "description":"Comments added by the user for the charge reference.",
            "nullable":true
        },
        "InvoiceChargeReferenceId":{
            "title":"Invoice Charge Reference ID",
            "type":"integer",
            "description":"Value that uniquely identifies the invoice charge reference.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ChargeReferenceName":{
            "title":"Charge Reference Name",
            "type":"string",
            "description":"Name of the charge reference type.",
            "nullable":true
        },
        "ReferenceValueDate":{
            "title":"Date Reference",
            "type":"string",
            "description":"Date value of the charge reference.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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.

Root Schema : invoicesForLandedCostCharges-item-response

Type: object

Show Source

AssociationMode: string

Title: Association Mode

Read Only: true

Maximum Length: 255

Mode by which the invoice line is associated with the charge line. Valid values include Automatic and Manual.
AssociationModeCode: number

Title: Association Mode Code

Read Only: true

Value that identifies the mode of invoice association.
AssociationStatus: string

Title: Association Status

Read Only: true

Maximum Length: 80

Abbreviation that uniquely identifies the status of the invoice association with the charge line. Valid values include Needs Review, Deleted, Rejected, and Associated.
ChargeBU: string

Title: Charge BU

Read Only: true

Maximum Length: 240

Value that indicates the requisitioning business unit that incurs the charge.
ChargeBUId: integer (int64)

Title: Charge Business Unit ID

Value that uniquely identifies the business unit associated with the trade operation charge.
ChargeCode: string

Title: Charge Code

Read Only: true

Maximum Length: 30

Abbreviation that identifies the landed cost charge.
ChargeId: integer (int64)

Title: Charge ID

Value that uniquely identifies the trade operation charge.
ChargeName: string

Title: Charge Name

Read Only: true

Maximum Length: 80

Name of the charge given on the invoice line.
InvoiceAmount: number

Title: Amount

Read Only: true

Amount on the invoice distribution.
InvoiceCreationDate: string (date-time)

Title: Invoice Date

Read Only: true

Date when the supplier raised the invoice.
InvoiceCurrency: string

Title: Currency Name

Read Only: true

Maximum Length: 80

Currency on the invoice.
InvoiceCurrencyCode: string

Title: Currency Code

Read Only: true

Maximum Length: 15

Abbreviation that identifies the invoice currency.
InvoiceId: integer (int64)

Title: Invoice ID

Read Only: true

Value that uniquely identifies the invoice.
InvoiceLineNumber: string

Title: Invoice Line Number

Read Only: true

Maximum Length: 40

Number that identifies a line on the invoice.
InvoiceLineType: string

Title: Line Type

Read Only: true

Maximum Length: 30

Value that identifies the type of invoice such as Standard Invoice, Credit memo, Debit memo, and so on.
InvoiceNonrecoverableTaxAmount: number

Title: Nonrecoverable Tax

Read Only: true

Amount of non-recoverable tax on the invoice distribution.
InvoiceNumber: string

Title: Invoice Number

Read Only: true

Maximum Length: 50

Number that identifies the invoice.
landedCostChargeReferencesForInvoiceLines: array References

Title: References

The References for Landed Cost Charges manages the charge references on the charge used for invoice association.
links: array Links

Title: Links

The link relations associated with the resource instance.
MissingChargeReferences: string

Title: Show Only Invoices Missing Reference Types

Read Only: true

Maximum Length: 255

Contains one of the following values: true or false. If true, then invoice lines are missing charge references. If false, then invoice lines contain charge references. The default value is null.
ProcurementBU: string

Title: Procurement BU

Read Only: true

Maximum Length: 240

Value that indicates the procurement business unit on the invoice line.
ProcurementBUId: integer (int64)

Title: Procurement Business Unit ID

Read Only: true

Value that uniquely identifies the procurement business unit.
Supplier: string

Title: Supplier

Read Only: true

Maximum Length: 360

Value that indicates the supplier on the invoice.
SupplierId: integer (int64)

Title: Supplier ID

Read Only: true

Value that uniquely identifies the supplier rendering the service.
SupplierSite: string

Title: Supplier Site

Read Only: true

Maximum Length: 240

Value that indicates the supplier site on the charge line.
SupplierSiteId: integer (int64)

Title: Supplier Site ID

Read Only: true

Value that uniquely identifies the supplier site rendering the service.
TradeOperationName: string

Title: Trade Operation Name

Read Only: true

Maximum Length: 80

Name of the trade operation associated with the charge invoice.
TradeOperationNumber: string

Title: Trade Operation Number

Read Only: true

Maximum Length: 40

Number that indicates the trade operation associated with the charge invoice.

{
    "type":"object",
    "properties":{
        "InvoiceLineNumber":{
            "title":"Invoice Line Number",
            "maxLength":"40",
            "type":"string",
            "description":"Number that identifies a line on the invoice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceCreationDate":{
            "title":"Invoice Date",
            "type":"string",
            "description":"Date when the supplier raised the invoice.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceLineType":{
            "title":"Line Type",
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the type of invoice such as Standard Invoice, Credit memo, Debit memo, and so on.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceAmount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount on the invoice distribution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceId":{
            "title":"Invoice ID",
            "type":"integer",
            "description":"Value that uniquely identifies the invoice.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssociationModeCode":{
            "title":"Association Mode Code",
            "type":"number",
            "description":"Value that identifies the mode of invoice association.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "ChargeBU":{
            "title":"Charge BU",
            "maxLength":"240",
            "type":"string",
            "description":"Value that indicates the requisitioning business unit that incurs the charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "title":"Supplier Site ID",
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site rendering the service.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Supplier":{
            "title":"Supplier",
            "maxLength":"360",
            "type":"string",
            "description":"Value that indicates the supplier on the invoice.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceNumber":{
            "title":"Invoice Number",
            "maxLength":"50",
            "type":"string",
            "description":"Number that identifies the invoice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociationStatus":{
            "title":"Association Status",
            "maxLength":"80",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the status of the invoice association with the charge line. Valid values include Needs Review, Deleted, Rejected, and Associated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceCurrency":{
            "title":"Currency Name",
            "maxLength":"80",
            "type":"string",
            "description":"Currency on the invoice.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MissingChargeReferences":{
            "title":"Show Only Invoices Missing Reference Types",
            "maxLength":"255",
            "type":"string",
            "description":"Contains one of the following values: true or false. If true, then invoice lines are missing charge references. If false, then invoice lines contain charge references. The default value is null.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBU":{
            "title":"Procurement BU",
            "maxLength":"240",
            "type":"string",
            "description":"Value that indicates the procurement business unit on the invoice line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBUId":{
            "title":"Procurement Business Unit ID",
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssociationMode":{
            "title":"Association Mode",
            "maxLength":"255",
            "type":"string",
            "description":"Mode by which the invoice line is associated with the charge line. Valid values include Automatic and Manual.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeName":{
            "title":"Charge Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the charge given on the invoice line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "landedCostChargeReferencesForInvoiceLines":{
            "title":"References",
            "type":"array",
            "description":"The References for Landed Cost Charges manages the charge references on the charge used for invoice association.",
            "items":{
                "$ref":"#/components/schemas/invoicesForLandedCostCharges-landedCostChargeReferencesForInvoiceLines-item-response"
            }
        },
        "TradeOperationNumber":{
            "title":"Trade Operation Number",
            "maxLength":"40",
            "type":"string",
            "description":"Number that indicates the trade operation associated with the charge invoice.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeBUId":{
            "title":"Charge Business Unit ID",
            "type":"integer",
            "description":"Value that uniquely identifies the business unit associated with the trade operation charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "fnd:APPLCORE_SETID_DETERMINANT_TYPE":"BU"
            },
            "x-queryable":true
        },
        "InvoiceNonrecoverableTaxAmount":{
            "title":"Nonrecoverable Tax",
            "type":"number",
            "description":"Amount of non-recoverable tax on the invoice distribution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeCode":{
            "title":"Charge Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the landed cost charge.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierId":{
            "title":"Supplier ID",
            "type":"integer",
            "description":"Value that uniquely identifies the supplier rendering the service.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "maxLength":"240",
            "type":"string",
            "description":"Value that indicates the supplier site on the charge line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TradeOperationName":{
            "title":"Trade Operation Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the trade operation associated with the charge invoice.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeId":{
            "title":"Charge ID",
            "type":"integer",
            "description":"Value that uniquely identifies the trade operation charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "fnd:APPLCORE_SETID_DETERMINANT_ATTR":"PrcBuId"
            },
            "x-queryable":true
        },
        "InvoiceCurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the invoice currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : References

Type: array

Title: References

The References for Landed Cost Charges manages the charge references on the charge used for invoice association.

Show Source

Array of: object invoicesForLandedCostCharges-landedCostChargeReferencesForInvoiceLines-item-response

{
    "title":"References",
    "type":"array",
    "description":"The References for Landed Cost Charges manages the charge references on the charge used for invoice association.",
    "items":{
        "$ref":"#/components/schemas/invoicesForLandedCostCharges-landedCostChargeReferencesForInvoiceLines-item-response"
    }
}

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 : invoicesForLandedCostCharges-landedCostChargeReferencesForInvoiceLines-item-response

Type: object

Show Source

ChargeReferenceDataType: string

Title: Reference Data Type

Value that identifies the type of input data for charge references.
ChargeReferenceName: string

Title: Charge Reference Name

Name of the charge reference type.
ChargeReferencePredefined: string

Title: Predefined

Read Only: true

Maximum Length: 255

Contains one of the following values: true or false. If true, then the reference type is predefined in the default charge references setup. If false, then the reference type is not predefined. The default value is false.
ChargeReferenceTypeId: integer (int64)

Title: Charge Reference Type ID

Value that uniquely identifies the type of charge reference.
ChargeReferenceValueDataType: string

Title: Reference Data Type

Read Only: true

Maximum Length: 80

Value that identifies the type of input data for charge references.
InvoiceChargeReferenceId: integer (int64)

Title: Invoice Charge Reference ID

Value that uniquely identifies the invoice charge reference.
links: array Links

Title: Links

The link relations associated with the resource instance.
ProcurementBU: string

Title: Procurement BU

Read Only: true

Maximum Length: 240

Value that indicates the procurement business unit on the charge reference.
ProcurementBUId: integer (int64)

Title: Procurement Business Unit ID

Value that uniquely identifies the procurement business unit.
ReferenceValueDate: string (date-time)

Title: Date Reference

Date value of the charge reference.
ReferenceValueNumber: number

Title: Numeric Reference

Number that identifies the charge reference.
ReferenceValueText: string

Title: Alphanumeric Reference

Maximum Length: 64

Text of the charge reference.
UserComment: string

Title: Comments

Maximum Length: 240

Comments added by the user for the charge reference.

{
    "type":"object",
    "properties":{
        "ProcurementBU":{
            "title":"Procurement BU",
            "maxLength":"240",
            "type":"string",
            "description":"Value that indicates the procurement business unit on the charge reference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBUId":{
            "title":"Procurement Business Unit ID",
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReferenceValueText":{
            "title":"Alphanumeric Reference",
            "maxLength":"64",
            "type":"string",
            "description":"Text of the charge reference.",
            "nullable":true,
            "x-queryable":true
        },
        "ReferenceValueNumber":{
            "title":"Numeric Reference",
            "type":"number",
            "description":"Number that identifies the charge reference.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "UserComment":{
            "title":"Comments",
            "maxLength":"240",
            "type":"string",
            "description":"Comments added by the user for the charge reference.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceChargeReferenceId":{
            "title":"Invoice Charge Reference ID",
            "type":"integer",
            "description":"Value that uniquely identifies the invoice charge reference.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ChargeReferenceValueDataType":{
            "title":"Reference Data Type",
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies the type of input data for charge references.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeReferenceTypeId":{
            "title":"Charge Reference Type ID",
            "type":"integer",
            "description":"Value that uniquely identifies the type of charge reference.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:APPLCORE_SETID_DETERMINANT_ATTR":"PrcBuId"
            },
            "x-queryable":true
        },
        "ChargeReferenceDataType":{
            "title":"Reference Data Type",
            "type":"string",
            "description":"Value that identifies the type of input data for charge references.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeReferencePredefined":{
            "title":"Predefined",
            "maxLength":"255",
            "type":"string",
            "description":"Contains one of the following values: true or false. If true, then the reference type is predefined in the default charge references setup. If false, then the reference type is not predefined. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ChargeReferenceName":{
            "title":"Charge Reference Name",
            "type":"string",
            "description":"Name of the charge reference type.",
            "nullable":true,
            "x-queryable":true
        },
        "ReferenceValueDate":{
            "title":"Date Reference",
            "type":"string",
            "description":"Date value of the charge reference.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "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."
        }
    }
}

Links

landedCostChargeReferencesForInvoiceLines

Operation: /fscmRestApi/resources/11.13.18.05/invoicesForLandedCostCharges/{invoicesForLandedCostChargesUniqID}/child/landedCostChargeReferencesForInvoiceLines

Parameters:

invoicesForLandedCostChargesUniqID: $request.path.invoicesForLandedCostChargesUniqID

The References for Landed Cost Charges manages the charge references on the charge used for invoice association.

Examples

This example describes how to update a landed cost charge.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/invoicesForLandedCostChargesUniqID"

Example 1 Request Body

The following example includes the contents of the request body in JSON format to patch an invoice to associate it with a charge (where an invoice has no charge but charge references exist). You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
	"ChargeName": "SS_Shipment
}

Example 1 Response Body

The following example includes the contents of the response body in JSON format where a charge (and default charge references, if any) gets patched to the invoice:

200 OK                                                                             
{
	"AssociationMode": null,
	"AssociationModeCode": null,
	"AssociationStatus": "Good match",
	"ChargeName": "SS_Shipment",
	"ChargeCode": "SS_Shipment",
	"ChargeId": null,
	"ChargeBU": "Vision Operations",
	"ChargeBUId": null,
	"MissingChargeReferences": "false",
	"InvoiceNumber": "LCMINV_10151824454",
	"InvoiceId": 300100175150435,
	"InvoiceLineNumber": "1",
	"InvoiceLineType": "ITEM",
	"InvoiceAmount": 150,
	"InvoiceNonrecoverableTaxAmount": 0,
	"InvoiceCurrency": "US Dollar",
	"InvoiceCurrencyCode": "USD",
	"InvoiceCreationDate": "10/15/18",
	"ProcurementBU": "Vision Operations",
	"ProcurementBUId": 204,
	"Supplier": "Advanced Network Devices",
	"SupplierId": 21,
	"SupplierSite": "FRESNO",
	"SupplierSiteId": 1969,
	"TradeOperationName": null,
	"TradeOperationNumber": null,
	...
}

Example 2 Request Body

The following example includes the contents of the request body in JSON format to patch an invoice with a charge (when you want to deassociate a charge from an invoice) You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
	"ChargeName":  null             
}

Example 2 Response Body

The following example includes the contents of the response body in JSON format where the charge (and its default charge references, if any) gets deleted. Note: Since a record is getting deleted, the self link of the invoice charge changes. To view the result, search with the invoice number using the finder and go to its self link.

200 OK                                                                             
{
	"AssociationMode": null,
	"AssociationModeCode": null,
	"AssociationStatus": "Good match",
	"ChargeName": null,
	"ChargeCode": null,
	"ChargeId": null,
	"ChargeBU":  null,
	"ChargeBUId": null,
	"MissingChargeReferences": "false",
	"InvoiceNumber": "LCMINV_10151824454",
	"InvoiceId": 300100175150435,
	"InvoiceLineNumber": "1",
	"InvoiceLineType": "ITEM",
	"InvoiceAmount": 150,
	"InvoiceNonrecoverableTaxAmount": 0,
	"InvoiceCurrency": "US Dollar",
	"InvoiceCurrencyCode": "USD",
	"InvoiceCreationDate": "10/15/18",
	"ProcurementBU": "Vision Operations",
	"ProcurementBUId": 204,
	"Supplier": "PennyPack Systems",
	"SupplierId": 21,
	"SupplierSite": "FRESNO",
	"SupplierSiteId": 1969,
	"TradeOperationName": null,
	"TradeOperationNumber": null,
	...
}

Example 3 Request Body

The following example includes the contents of the request body in JSON format to patch an invoice with a charge when the invoice is already associated. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
	"ChargeName": "SS_Shipment"
}

Example 3 Response Body

The following example includes the contents of the response body in JSON format where an error is thrown:

400 Bad Request                                                                       
This invoice is already associated with a charge. (CML-3720089)

Example 4 Request Body

The following example includes the contents of the request body in JSON format to patch a collection of invoices with charges. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
	"ChargeName": "SS_Freight"
}

Example 4 Response Body

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


{
	"parts":[
	{
		"id": "part1",
		"path": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED0005770800000000075BCD15000000033733370000000EACED0005770800000000075BCD150000000EACED0005770800000000000002E1",
		"operation": "update",
		"payload":{
			"AssociationMode": null,
			"AssociationModeCode": null,
			"AssociationStatus": "New",
			"ChargeName": "SS_Freight",
			"ChargeCode": "SS_Freight",
			"ChargeId": 1,
			"ChargeBU": "Vision Operations",
			"ChargeBUId": 204,
			"MissingChargeReferences": "true",
			"InvoiceNumber": "Bulk_Invoice",
			"InvoiceId": 123456789,
			"InvoiceLineNumber": "737",
			"InvoiceLineType": "ITEM",
			"InvoiceAmount": 30,
			"InvoiceNonrecoverableTaxAmount": 0,
			"InvoiceCurrency": "US Dollar",
			"InvoiceCurrencyCode": "USD",
			"InvoiceCreationDate": "2017-02-23T12:11:53+00:00",
			"ProcurementBU": "Vision Operations",
			"ProcurementBUId": 204,
			"Supplier": "CV_SuppA01",
			"SupplierId": 12,
			"SupplierSite": "CVSuppA01Site01",
			"SupplierSiteId": 2444,
			"TradeOperationName": null,
			"TradeOperationNumber": null,
			"links":[{"rel": "self", "href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED0005770800000000075BCD15000000033733370000000EACED0005770800000000075BCD150000000EACED0005770800000000000002E1",...]
			}
		},
		{
			"id": "part2",
			"path": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED0005770800000000075BCD15000000033436300000000EACED0005770800000000075BCD150000000EACED0005770800000000000001CC",
			"operation": "update",
			"payload":{
				"AssociationMode": null,
				"AssociationModeCode": null,
				"AssociationStatus": "New",
				"ChargeName": "SS_Freight",
				"ChargeCode": "SS_Freight",
				"ChargeId": 1,
				"ChargeBU": "Vision Operations",
				"ChargeBUId": 204,
				"MissingChargeReferences": "true",
				"InvoiceNumber": "Bulk_Invoice",
				"InvoiceId": 123456789,
				"InvoiceLineNumber": "460",
				"InvoiceLineType": "ITEM",
				"InvoiceAmount": 30,
				"InvoiceNonrecoverableTaxAmount": 0,
				"InvoiceCurrency": "US Dollar",
				"InvoiceCurrencyCode": "USD",
				"InvoiceCreationDate": "2017-02-23T12:11:53+00:00",
				"ProcurementBU": "Vision Operations",
				"ProcurementBUId": 204,
				"Supplier": "CV_SuppA01",
				"SupplierId": 12,
				"SupplierSite": "CVSuppA01Site01",
				"SupplierSiteId": 2444,
				"TradeOperationName": null,
				"TradeOperationNumber": null,
				"links":[{"rel": "self", "href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED0005770800000000075BCD15000000033436300000000EACED0005770800000000075BCD150000000EACED0005770800000000000001CC",...]
				}
			}
		}
	}
	]
}