REST API for Oracle Fusion Cloud SCM

Update one manual adjustment

patch

/fscmRestApi/resources/11.13.18.05/manualPriceAdjustments/{ManualPriceAdjustmentId}

Request

Path Parameters

ManualPriceAdjustmentId(required): integer(int64)

Value that uniquely identifies the manual adjustment.

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

AdjustmentAmount: number

Value that's used in calculating a manual or negotiated discount. This can be a monetary unit or a percentage value.
AdjustmentElementBasis: string

Maximum Length: 30

Value that indicates the pricing basis for calculating the adjustment.
AdjustmentTypeCode: string

Maximum Length: 30

Abbreviation that indicates the method used for calculating a manual or negotiated discount for product charges.
ManualPriceAdjustmentId: integer (int64)

Value that uniquely identifies the manual adjustment.
ModifiedFlag: boolean

Maximum Length: 1

Value indicates that the row has been modified in the version currently submitted.
ReasonCode: string

Maximum Length: 30

Abbreviation indicates the rationale for a manual discount.

{
    "type":"object",
    "properties":{
        "AdjustmentTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that indicates the method used for calculating a manual or negotiated discount for product charges.",
            "nullable":false
        },
        "AdjustmentElementBasis":{
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates the pricing basis for calculating the adjustment.",
            "nullable":true
        },
        "ManualPriceAdjustmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the manual adjustment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AdjustmentAmount":{
            "type":"number",
            "description":"Value that's used in calculating a manual or negotiated discount. This can be a monetary unit or a percentage value.",
            "nullable":false
        },
        "ModifiedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value indicates that the row has been modified in the version currently submitted.",
            "nullable":true
        },
        "ReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation indicates the rationale for a manual discount.",
            "nullable":false
        }
    }
}

Response

Supported Media Types

application/json

Default Response

The following table describes the default response for this task.

Headers

Metadata-Context(required):

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(required):

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 : manualPriceAdjustments-item-response

Type: object

Show Source

AdjustmentAmount: number

Value that's used in calculating a manual or negotiated discount. This can be a monetary unit or a percentage value.
AdjustmentBasisMeaning: string

Read Only: true

Maximum Length: 80

Value that indicates the basis for calculating the price adjustment.
AdjustmentElementBasis: string

Maximum Length: 30

Value that indicates the pricing basis for calculating the adjustment.
AdjustmentType: string

Read Only: true

Maximum Length: 80

Value that indicates the method used for calculating a manual or negotiated discount for product charges.
AdjustmentTypeCode: string

Maximum Length: 30

Abbreviation that indicates the method used for calculating a manual or negotiated discount for product charges.
ChargeDefinition: string

Read Only: true

Maximum Length: 80

Value that indicates the charge definition code of the charge to which manual adjustment is applied.
ChargeDefinitionCode: string

Maximum Length: 30

Abbreviation that indicates the charge definition code of the charge to which manual adjustment is applied.
CreatedBy: string

Read Only: true

Maximum Length: 64

Who column: indicates the user who created the row for the manual adjustment.
CreationDate: string (date-time)

Read Only: true

Who column: indicates the date and time row created for the manual adjustment.
LastUpdateDate: string (date-time)

Read Only: true

Who column: indicates the date and time of the last update of the row for the manual adjustment.
LastUpdatedBy: string

Read Only: true

Maximum Length: 64

Who column: indicates the user who last updated the row for the manual adjustment.
LastUpdateLogin: string

Read Only: true

Maximum Length: 32

Who column: indicates the session login associated with the user who last updated the row for the manual adjustment.
links: array Links

Title: Links

The link relations associated with the resource instance.
ManualPriceAdjustmentId: integer (int64)

Value that uniquely identifies the manual adjustment.
ModifiedFlag: boolean

Maximum Length: 1

Value indicates that the row has been modified in the version currently submitted.
ParentEntity: string

Read Only: true

Maximum Length: 12

Value indicates the entity code to which the manual adjustment is applied.
ParentEntityCode: string

Maximum Length: 30

Abbreviation that indicates the entity code to which the manual adjustment is applied.
ParentEntityId: integer (int64)

Value indicates the entity ID against which the manual adjustment is applied.
Reason: string

Read Only: true

Maximum Length: 80

Value that indicates the rationale for a manual discount.
ReasonCode: string

Maximum Length: 30

Abbreviation indicates the rationale for a manual discount.
SequenceNumber: integer (int32)

Read Only: true

Default Value: 1

Value indicates the sequence in which this adjustment is applied in relation to other manual adjustments.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who last updated the row for the manual adjustment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Who column: indicates the date and time row created for the manual adjustment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdjustmentElementBasis":{
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates the pricing basis for calculating the adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentEntityId":{
            "type":"integer",
            "description":"Value indicates the entity ID against which the manual adjustment is applied.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who created the row for the manual adjustment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeDefinition":{
            "maxLength":80,
            "type":"string",
            "description":"Value that indicates the charge definition code of the charge to which manual adjustment is applied.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ModifiedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value indicates that the row has been modified in the version currently submitted.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that indicates the charge definition code of the charge to which manual adjustment is applied.",
            "nullable":false,
            "x-queryable":true
        },
        "ReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation indicates the rationale for a manual discount.",
            "nullable":false,
            "x-queryable":true
        },
        "Reason":{
            "maxLength":80,
            "type":"string",
            "description":"Value that indicates the rationale for a manual discount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdjustmentType":{
            "maxLength":80,
            "type":"string",
            "description":"Value that indicates the method used for calculating a manual or negotiated discount for product charges.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdjustmentTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that indicates the method used for calculating a manual or negotiated discount for product charges.",
            "nullable":false,
            "x-queryable":true
        },
        "AdjustmentBasisMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Value that indicates the basis for calculating the price adjustment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentEntityCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that indicates the entity code to which the manual adjustment is applied.",
            "nullable":false,
            "x-queryable":true
        },
        "ManualPriceAdjustmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the manual adjustment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"Value indicates the sequence in which this adjustment is applied in relation to other manual adjustments.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":1,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "AdjustmentAmount":{
            "type":"number",
            "description":"Value that's used in calculating a manual or negotiated discount. This can be a monetary unit or a percentage value.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParentEntity":{
            "maxLength":12,
            "type":"string",
            "description":"Value indicates the entity code to which the manual adjustment is applied.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Who column: indicates the date and time of the last update of the row for the manual adjustment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Who column: indicates the session login associated with the user who last updated the row for the manual  adjustment.",
            "nullable":true,
            "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."
        }
    }
}

Examples

This example describes how to update one manual adjustment.

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/manualPriceAdjustments/ManualPriceAdjustmentId"

Example Request Body

The following example includes the contents of the request body in JSON format. 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.

{
"AdjustmentAmount": 15
}

Example Response Body

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

{
"AdjustmentAmount": 15,
"AdjustmentElementBasis": "QP_LIST_PRICE",
"AdjustmentTypeCode": "DISCOUNT_PERCENT",
"ChargeDefinitionCode": "QP_SALE_PRICE",
"CreatedBy": "RCL_USER",
"CreationDate": "2022-11-18T11:07:45.059+00:00",
"LastUpdateDate": "2022-11-18T11:27:21+00:00",
"LastUpdateLogin": "ED6E8317A87191D4E053A06515AC04A0",
"LastUpdatedBy": "RCL_USER",
"ManualPriceAdjustmentId": 300100563741497,
"ModifiedFlag": null,
"ParentEntityCode": "RCL_DEBRIEF_LINE",
"ParentEntityId": 300100554460840,
"ReasonCode": "ORA_OTHER",
"SequenceNumber": 1,
"ChargeDefinition": "Sale Price",
"ParentEntity": "Debrief Line",
"AdjustmentType": "Discount percent",
"Reason": "Other",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/manualPriceAdjustments/300100563741497",
"name": "manualPriceAdjustments",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/manualPriceAdjustments/300100563741497",
"name": "manualPriceAdjustments",
"kind": "item"
}
]
}