Create cost adjustment
/fscmRestApi/resources/11.13.18.05/costAdjustments
Request
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
- application/json
object
-
AdjustmentDate: string
(date-time)
Title:
Adjustment Date
Date when the cost adjustment was made. -
AdjustmentDetail: array
Cost Adjustment Details
Title:
Cost Adjustment Details
Adjustment cost at cost-element level for a receipt or an item. -
AdjustmentStatus(required): string
Title:
Adjustment Status
Maximum Length:80
Status of the adjustment. Values include Pending, Submitted, or Voided. -
AdjustmentStatusCode(required): string
Title:
Adjustment Status Code
Maximum Length:30
Abbreviation that identifies the adjustment status. Values include P-Pending, S-Submitted, or C-Voided. -
AdjustmentType(required): string
Title:
Adjustment Type
Maximum Length:80
Type of adjustment. Values include Perpetual, Receipt, or Layer. -
AdjustmentTypeCode(required): string
Title:
Adjustment Type Code
Maximum Length:25
Abbreviation that identifies the adjustment type. Values include P-Perpetual, R-Receipt, or L-Layer. -
CostBook(required): string
Maximum Length:
30
Name of the cost book for the adjustment. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Cost Books task. -
CostBookId(required): integer
(int64)
Title:
Cost Book ID
Value that uniquely identifies the cost book. -
CostDate: string
(date-time)
Title:
Cost Date
Date of the costing transaction for the adjustment. -
CostOrganizationId(required): integer
(int64)
Title:
Cost Organization ID
Value that uniquely identifies the cost organization. -
CostOrganizationName(required): string
Title:
Cost Organization Name
Maximum Length:240
Name of the cost organization for the adjustment. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Cost Organizations task. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:200
Abbreviation that identifies the currency. -
InventoryOrganizationId: integer
(int64)
Title:
Inventory Organization ID
Value that uniquely identifies the inventory organization. -
InventoryOrganizationName: string
Title:
Inventory Organization Name
Maximum Length:240
Name of the inventory organization for the adjustment. -
Item: string
Maximum Length:
300
Name of the inventory item for the adjustment. -
ItemId(required): integer
(int64)
Title:
Item ID
Value that uniquely identifies the item. -
QuantityOnhand: number
Title:
Remaining Receipt Quantity
Remaining quantity of the item. -
Reason(required): string
Title:
Reason
Maximum Length:80
Reason for the cost adjustment transaction. -
ReasonCode(required): string
Title:
Reason Code
Maximum Length:200
Abbreviation that identifies the reason for the cost adjustment transaction. -
ReceiptNumber: string
Title:
Receipt Number
Maximum Length:200
Number that identifies the receipt of the transaction for the adjustment. -
ReceiptQuantity: number
Title:
Receipt Quantity
Quantity of the item received. -
TotalNewCost: number
Title:
Total New Cost
Total new cost of the received item. -
TotalUnitCost: number
Title:
Total Unit Cost
Total cost of the received item. -
TransactionId(required): integer
(int64)
Title:
Transaction ID
Value that uniquely identifies the transaction in costing. -
UOMCode: string
Title:
UOM Code
Maximum Length:3
Abbreviation that identifies the unit of measure. -
UOMName: string
Title:
UOM Name
Maximum Length:25
Name of the unit of measure. -
ValuationUnit: string
Maximum Length:
1000
Valuation unit for the adjustment. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Valuation Units task. -
ValuationUnitId: integer
(int64)
Title:
Valuation Unit ID
Value that uniquely identifies the valuation unit.
array
Cost Adjustment Details
object
-
CostElement: string
Title:
Cost Element
Maximum Length:30
Cost element to use when creating an adjustment detail. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Cost Elements task. -
CostElementId: integer
(int64)
Title:
Cost Element ID
Value that uniquely identifies the cost element. -
ExpensePoolId: integer
(int64)
Title:
Expense Pool ID
Value that uniquely identifies the expense pool. -
NewCost: number
Title:
New Cost
New cost of the cost element. -
SourceTransactionCostId: integer
(int64)
Title:
Source Transaction Cost ID
Value that uniquely identifies the transaction cost identifier for which the adjustment detail is created. -
SourceTransactionId: integer
(int64)
Title:
Source Transaction ID
Value that uniquely identifies the transaction for which the adjustment is created. -
UnitCost: number
Title:
Unit Cost
Unit cost of the cost element. -
UserComment: string
Title:
Comments
Maximum Length:240
Optional comment entered by the user for the cost adjustment detail. -
UserDefinedFlag: boolean
Title:
User Defined
Maximum Length:5
Contains one of the following values: true or false. If true, then adjustment detail is user defined. If false, then adjustment detail is generated from the existing cost elements associated with the item. The attribute does not have a default value.
Response
- application/json
Default Response
-
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.
object
-
AdjustmentDate: string
(date-time)
Title:
Adjustment Date
Date when the cost adjustment was made. -
AdjustmentDetail: array
Cost Adjustment Details
Title:
Cost Adjustment Details
Adjustment cost at cost-element level for a receipt or an item. -
AdjustmentHeaderId: integer
(int64)
Title:
Adjustment Header ID
Read Only:true
Value that uniquely identifies the adjustment header. The application generates this value. -
AdjustmentNumber: string
Title:
Adjustment Number
Read Only:true
Maximum Length:50
Number that identifies the adjustment. The application generates this value. -
AdjustmentStatus: string
Title:
Adjustment Status
Maximum Length:80
Status of the adjustment. Values include Pending, Submitted, or Voided. -
AdjustmentStatusCode: string
Title:
Adjustment Status Code
Maximum Length:30
Abbreviation that identifies the adjustment status. Values include P-Pending, S-Submitted, or C-Voided. -
AdjustmentType: string
Title:
Adjustment Type
Maximum Length:80
Type of adjustment. Values include Perpetual, Receipt, or Layer. -
AdjustmentTypeCode: string
Title:
Adjustment Type Code
Maximum Length:25
Abbreviation that identifies the adjustment type. Values include P-Perpetual, R-Receipt, or L-Layer. -
CostBook: string
Maximum Length:
30
Name of the cost book for the adjustment. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Cost Books task. -
CostBookId: integer
(int64)
Title:
Cost Book ID
Value that uniquely identifies the cost book. -
CostDate: string
(date-time)
Title:
Cost Date
Date of the costing transaction for the adjustment. -
CostOrganizationId: integer
(int64)
Title:
Cost Organization ID
Value that uniquely identifies the cost organization. -
CostOrganizationName: string
Title:
Cost Organization Name
Maximum Length:240
Name of the cost organization for the adjustment. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Cost Organizations task. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:200
Abbreviation that identifies the currency. -
InventoryOrganizationId: integer
(int64)
Title:
Inventory Organization ID
Value that uniquely identifies the inventory organization. -
InventoryOrganizationName: string
Title:
Inventory Organization Name
Maximum Length:240
Name of the inventory organization for the adjustment. -
Item: string
Maximum Length:
300
Name of the inventory item for the adjustment. -
ItemId: integer
(int64)
Title:
Item ID
Value that uniquely identifies the item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
QuantityOnhand: number
Title:
Remaining Receipt Quantity
Remaining quantity of the item. -
Reason: string
Title:
Reason
Maximum Length:80
Reason for the cost adjustment transaction. -
ReasonCode: string
Title:
Reason Code
Maximum Length:200
Abbreviation that identifies the reason for the cost adjustment transaction. -
ReceiptNumber: string
Title:
Receipt Number
Maximum Length:200
Number that identifies the receipt of the transaction for the adjustment. -
ReceiptQuantity: number
Title:
Receipt Quantity
Quantity of the item received. -
TotalNewCost: number
Title:
Total New Cost
Total new cost of the received item. -
TotalUnitCost: number
Title:
Total Unit Cost
Total cost of the received item. -
TransactionId: integer
(int64)
Title:
Transaction ID
Value that uniquely identifies the transaction in costing. -
UOMCode: string
Title:
UOM Code
Maximum Length:3
Abbreviation that identifies the unit of measure. -
UOMName: string
Title:
UOM Name
Maximum Length:25
Name of the unit of measure. -
ValuationUnit: string
Maximum Length:
1000
Valuation unit for the adjustment. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Valuation Units task. -
ValuationUnitId: integer
(int64)
Title:
Valuation Unit ID
Value that uniquely identifies the valuation unit.
array
Cost Adjustment Details
array
Links
object
-
AdjustmentHeaderId: integer
(int64)
Title:
Adjustment Header ID
Read Only:true
Value that uniquely identifies the adjustment against which this adjustment detail is created. -
CostElement: string
Title:
Cost Element
Maximum Length:30
Cost element to use when creating an adjustment detail. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Cost Elements task. -
CostElementId: integer
(int64)
Title:
Cost Element ID
Value that uniquely identifies the cost element. -
ExpensePool: string
Title:
Expense Pool
Read Only:true
Maximum Length:30
Expense pool to use when creating an adjustment detail. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Expense Pools task. -
ExpensePoolId: integer
(int64)
Title:
Expense Pool ID
Value that uniquely identifies the expense pool. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NewCost: number
Title:
New Cost
New cost of the cost element. -
SourceTransactionCostId: integer
(int64)
Title:
Source Transaction Cost ID
Value that uniquely identifies the transaction cost identifier for which the adjustment detail is created. -
SourceTransactionId: integer
(int64)
Title:
Source Transaction ID
Value that uniquely identifies the transaction for which the adjustment is created. -
UnitCost: number
Title:
Unit Cost
Unit cost of the cost element. -
UserAdjustmentId: integer
(int64)
Title:
User Adjustment ID
Read Only:true
Value that uniquely identifies the adjustment detail. The application generates this value. -
UserComment: string
Title:
Comments
Maximum Length:240
Optional comment entered by the user for the cost adjustment detail. -
UserDefinedFlag: boolean
Title:
User Defined
Maximum Length:5
Contains one of the following values: true or false. If true, then adjustment detail is user defined. If false, then adjustment detail is generated from the existing cost elements associated with the item. The attribute does not have a default value.
array
Links
object
-
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
- AdjustmentDetail
-
Operation: /fscmRestApi/resources/11.13.18.05/costAdjustments/{costAdjustmentsUniqID}/child/AdjustmentDetailParameters:
- costAdjustmentsUniqID:
$request.path.costAdjustmentsUniqID
Adjustment cost at cost-element level for a receipt or an item. - costAdjustmentsUniqID:
Examples
This example describes how to create one cost adjustment.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/costAdjustments"
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 creates.
{ "TransactionId" : 333133, "AdjustmentType" : "Receipt", "Reason" : "ST_ADJ", "AdjustmentDetail" : [ { "CostElement" : "ZCST-MATERIAL", "NewCost" : 1 } ] }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "AdjustmentHeaderId" : 4011, "AdjustmentNumber" : "6001", "AdjustmentTypeCode" : "R", "AdjustmentDate" : null, "AdjustmentStatusCode" : "P", "ReasonCode" : "ST_ADJ", "TransactionId" : 333133, "CostOrganizationId" : 100000014977014, "CostBookId" : 100000014978010, "ItemId" : 149, "InventoryOrganizationId" : 207, "ReceiptQuantity" : 10, "QuantityOnhand" : 0, "TotalUnitCost" : 1107.86, "TotalNewCost" : 1, "ValuationUnitId" : 300100002799598, "CostDate" : "2012-04-24T08:56:31+00:00", "ReceiptNumber" : "33594", "CurrencyCode" : "USD", "CostOrganizationName" : "ZCST-Seattle", "CostBook" : "ZCST-Seattle", "InventoryOrganizationName" : "Tall Manufacturing", "Item" : "AS54888", "ValuationUnit" : "ORG11-M1", "AdjustmentType" : "Receipt", "AdjustmentStatus" : "Pending", "Reason" : "ST_ADJ", "UOMCode" : "Ea", "UOMName" : "Each", "AdjustmentDetail" : [ { "AdjustmentHeaderId" : 4011, "CostElementId" : 100000010001028, "ExpensePoolId" : 0, "NewCost" : 1, "SourceTransactionCostId" : 23588, "SourceTransactionId" : 333133, "UnitCost" : 1107.86, "UserAdjustmentId" : 5048, "CostElement" : "ZCST-MATERIAL", "ExpensePool" : null, "UserDefinedFlag" : false, ... } ], ... }
Example Two cURL Command
Example Two Request Body
This example creates a complex cost adjustment that includes multiple cost elements:
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/costAdjustments"
The following example includes the contents of the request body in JSON format:
{ "TransactionId" : 333133, "AdjustmentType" : "Receipt", "Reason" : "ST_ADJ", "AdjustmentDetail" : [ { "CostElement" : "ZCST-MATERIAL", "NewCost" : 1 }, { "CostElement" : "ZCST-OVERHEAD", "NewCost" : 6 } ] }
Example Two Response Body
The following example includes the contents of the response body in JSON format:
{ "AdjustmentHeaderId" : 4011, "AdjustmentNumber" : "6001", "AdjustmentTypeCode" : "R", "AdjustmentDate" : null, "AdjustmentStatusCode" : "P", "ReasonCode" : "ST_ADJ", "TransactionId" : 333133, "CostOrganizationId" : 100000014977014, "CostBookId" : 100000014978010, "ItemId" : 149, "InventoryOrganizationId" : 207, "ReceiptQuantity" : 10, "QuantityOnhand" : 0, "TotalUnitCost" : 1107.86, "TotalNewCost" : 7, "ValuationUnitId" : 300100002799598, "CostDate" : "2012-04-24T08:56:31+00:00", "ReceiptNumber" : "33594", "CurrencyCode" : "USD", "CostOrganizationName" : "ZCST-Seattle", "CostBook" : "ZCST-Seattle", "InventoryOrganizationName" : "Tall Manufacturing", "Item" : "AS54888", "ValuationUnit" : "ORG11-M1", "AdjustmentType" : "Receipt", "AdjustmentStatus" : "Pending", "Reason" : "ST_ADJ", "UOMCode" : "Ea", "UOMName" : "Each", "AdjustmentDetail" : [ { "AdjustmentHeaderId" : 4011, "CostElementId" : 100000010001028, "ExpensePoolId" : 0, "NewCost" : 1, "SourceTransactionCostId" : 23588, "SourceTransactionId" : 333133, "UnitCost" : 1107.86, "UserAdjustmentId" : 5048, "CostElement" : "ZCST-MATERIAL", "ExpensePool" : null, "UserDefinedFlag" : false, ... }, { "AdjustmentHeaderId" : 4011, "CostElementId" : 100000011624089, "ExpensePoolId" : 0, "NewCost" : 6, "SourceTransactionCostId" : 23589, "SourceTransactionId" : 333133, "UnitCost" : 0, "UserAdjustmentId" : 5049, "CostElement" : "ZCST-OVERHEAD", "ExpensePool" : null, "UserDefinedFlag" : false, ... } ], ... }
Example Three cURL Command
Example Three Request Body
This example creates a complex cost adjustment that includes multiple cost element identifiers:
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/costAdjustments"
The following example includes the contents of the request body in JSON format:
{ "TransactionId" : 333133, "AdjustmentType" : "Receipt", "Reason" : "ST_ADJ", "AdjustmentDetail" : [ { "CostElementId" : 100000010001028, "NewCost" : 1 }, { "CostElementId" : 100000011624081, "NewCost" : 6 }, { "CostElementId" : 100000011624011, "NewCost" : 1 } ] }
Example Three Response Body
The following example includes the contents of the response body in JSON format:
{ "AdjustmentHeaderId" : 4011, "AdjustmentNumber" : "6001", "AdjustmentTypeCode" : "R", "AdjustmentDate" : null, "AdjustmentStatusCode" : "P", "ReasonCode" : "ST_ADJ", "TransactionId" : 333133, "CostOrganizationId" : 100000014977014, "CostBookId" : 100000014978010, "ItemId" : 149, "InventoryOrganizationId" : 207, "ReceiptQuantity" : 10, "QuantityOnhand" : 0, "TotalUnitCost" : 1107.86, "TotalNewCost" : 8, "ValuationUnitId" : 300100002799598, "CostDate" : "2012-04-24T08:56:31+00:00", "ReceiptNumber" : "33594", "CurrencyCode" : "USD", "CostOrganizationName" : "ZCST-Seattle", "CostBook" : "ZCST-Seattle", "InventoryOrganizationName" : "Tall Manufacturing", "Item" : "AS54888", "ValuationUnit" : "ORG11-M1", "AdjustmentType" : "Receipt", "AdjustmentStatus" : "Pending", "Reason" : "ST_ADJ", "UOMCode" : "Ea", "UOMName" : "Each", "AdjustmentDetail" : [ { "AdjustmentHeaderId" : 4011, "CostElementId" : 100000010001028, "ExpensePoolId" : 0, "NewCost" : 1, "SourceTransactionCostId" : 23588, "SourceTransactionId" : 333133, "UnitCost" : 1107.86, "UserAdjustmentId" : 5048, "CostElement" : "ZCST-MATERIAL", "ExpensePool" : null, "UserDefinedFlag" : false, ... }, { "AdjustmentHeaderId" : 4011, "CostElementId" : 100000011624081, "ExpensePoolId" : 0, "NewCost" : 6, "SourceTransactionCostId" : 23589, "SourceTransactionId" : 333133, "UnitCost" : 0, "UserAdjustmentId" : 5049, "CostElement" : "ZCST-OVERHEAD", "ExpensePool" : null, "UserDefinedFlag" : false, ... } ], ... }