Jump to

• Request
• Response
• Examples

Create cost adjustments

post

/fscmRestApi/resources/11.13.18.05/costAdjustments

Request

Header Parameters

• Effective-Of: string
  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: string
  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: string
  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: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AdjustmentDate: string (date-time)
  Title: Adjustment Date

  Date when the cost adjustment was made.
• AdjustmentDetail: array Cost Adjustment Details
  Title: Cost Adjustment Details

  Details of adjustment at the cost elemental level. It includes the cost element, new cost, and optional comments.
• AdjustmentStatus(required): string
  Title: Adjustment Status

  Maximum Length: 80

  Status of the adjustment. Possible values include Pending, Submitted, or Voided.
• AdjustmentStatusCode(required): string
  Title: Adjustment Status Code

  Maximum Length: 30

  Abbreviation that identifies the adjustment status. Possible values include P for Pending, S for Submitted, or C for Voided.
• AdjustmentType(required): string
  Title: Adjustment Type

  Maximum Length: 80

  Type of adjustment. Possible values include Perpetual Average, Receipt, or Layer.
• AdjustmentTypeCode(required): string
  Title: Adjustment Type Code

  Maximum Length: 25

  Abbreviation that identifies the adjustment type. Possible values include P for Perpetual Average, R for Receipt, or L for 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

  Indicates the name for the inventory organization associated with the cost organization.
• 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
• 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.
• ValuationUnitId: integer (int64)
  Title: Valuation Unit ID

  Value that uniquely identifies the valuation unit.

{
    "required":[
        "AdjustmentStatus",
        "AdjustmentStatusCode",
        "AdjustmentType",
        "AdjustmentTypeCode",
        "CostBook",
        "CostBookId",
        "CostOrganizationId",
        "CostOrganizationName",
        "ItemId",
        "Reason",
        "ReasonCode",
        "TransactionId"
    ],
    "type":"object",
    "properties":{
        "AdjustmentDate":{
            "title":"Adjustment Date",
            "type":"string",
            "description":"Date when the cost adjustment was made.",
            "format":"date-time",
            "nullable":true
        },
        "AdjustmentDetail":{
            "title":"Cost Adjustment Details",
            "type":"array",
            "description":"Details of adjustment at the cost elemental level. It includes the cost element, new cost, and optional comments.",
            "items":{
                "$ref":"#/components/schemas/costAdjustments-AdjustmentDetail-item-post-request"
            }
        },
        "AdjustmentStatus":{
            "title":"Adjustment Status",
            "maxLength":80,
            "type":"string",
            "description":"Status of the adjustment. Possible values include Pending, Submitted, or Voided.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AdjustmentStatusCode":{
            "title":"Adjustment Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the adjustment status. Possible values include P for Pending, S for Submitted, or C for Voided.",
            "nullable":false
        },
        "AdjustmentType":{
            "title":"Adjustment Type",
            "maxLength":80,
            "type":"string",
            "description":"Type of adjustment. Possible values include Perpetual Average, Receipt, or Layer.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AdjustmentTypeCode":{
            "title":"Adjustment Type Code",
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the adjustment type. Possible values include P for Perpetual Average, R for Receipt, or L for Layer.",
            "nullable":false
        },
        "CostBook":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CostBookId":{
            "title":"Cost Book ID",
            "type":"integer",
            "description":"Value that uniquely identifies the cost book.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CostDate":{
            "title":"Cost Date",
            "type":"string",
            "description":"Date of the costing transaction for the adjustment.",
            "format":"date-time",
            "nullable":true
        },
        "CostOrganizationId":{
            "title":"Cost Organization ID",
            "type":"integer",
            "description":"Value that uniquely identifies the cost organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CostOrganizationName":{
            "title":"Cost Organization Name",
            "maxLength":240,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":200,
            "type":"string",
            "description":"Abbreviation that identifies the currency.",
            "nullable":true
        },
        "InventoryOrganizationId":{
            "title":"Inventory Organization ID",
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "InventoryOrganizationName":{
            "title":"Inventory Organization Name",
            "maxLength":240,
            "type":"string",
            "description":"Indicates the name for the inventory organization associated with the cost organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Item":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the inventory item for the adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ItemId":{
            "title":"Item ID",
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "QuantityOnhand":{
            "title":"Remaining Receipt Quantity",
            "type":"number",
            "description":"Remaining Quantity",
            "nullable":true
        },
        "Reason":{
            "title":"Reason",
            "maxLength":80,
            "type":"string",
            "description":"Reason for the cost adjustment transaction.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ReasonCode":{
            "title":"Reason Code",
            "maxLength":200,
            "type":"string",
            "description":"Abbreviation that identifies the reason for the cost adjustment transaction.",
            "nullable":false
        },
        "ReceiptNumber":{
            "title":"Receipt Number",
            "maxLength":200,
            "type":"string",
            "description":"Number that identifies the receipt of the transaction for the adjustment.",
            "nullable":true
        },
        "ReceiptQuantity":{
            "title":"Receipt Quantity",
            "type":"number",
            "description":"Quantity of the item received.",
            "nullable":true
        },
        "TotalNewCost":{
            "title":"Total New Cost",
            "type":"number",
            "description":"Total new cost of the received item.",
            "nullable":true
        },
        "TotalUnitCost":{
            "title":"Total Unit Cost",
            "type":"number",
            "description":"Total cost of the received item.",
            "nullable":true
        },
        "TransactionId":{
            "title":"Transaction ID",
            "type":"integer",
            "description":"Value that uniquely identifies the transaction in costing.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "UOMCode":{
            "title":"UOM Code",
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "nullable":true
        },
        "UOMName":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "description":"Name of the unit of measure.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ValuationUnit":{
            "maxLength":1000,
            "type":"string",
            "description":"Valuation unit for the adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ValuationUnitId":{
            "title":"Valuation Unit ID",
            "type":"integer",
            "description":"Value that uniquely identifies the valuation unit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : Cost Adjustment Details

Type: array

Title: Cost Adjustment Details

Details of adjustment at the cost elemental level. It includes the cost element, new cost, and optional comments.

Show Source

• Array of: object schema

{
    "title":"Cost Adjustment Details",
    "type":"array",
    "description":"Details of adjustment at the cost elemental level. It includes the cost element, new cost, and optional comments.",
    "items":{
        "$ref":"#/components/schemas/costAdjustments-AdjustmentDetail-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• CostElement: string
  Title: Cost Element

  Maximum Length: 30

  Cost element to use when creating an adjustment detail.
• CostElementId: integer (int64)
  Title: Cost Element ID

  Value that uniquely identifies the cost element.
• CostElementType: string
  Maximum Length: 30

  Indicates the cost element type associated to the selected cost element.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  Currency code of the cost recorded in the adjustment detail.
• ExpensePoolId: integer (int64)
  Title: Expense Pool ID

  Value that uniquely identifies the expense pool.
• NewCost: number
  Title: New Cost

  New cost of the cost adjustment detail.
• SourceTransactionCostId: integer (int64)
  Title: Source Transaction Cost ID

  Value that uniquely identifies the transaction cost identifier for which the adjustment detail is linked.
• 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 adjustment detail.
• 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. This attribute doesn't have a default value.

{
    "type":"object",
    "properties":{
        "CostElement":{
            "title":"Cost Element",
            "maxLength":30,
            "type":"string",
            "description":"Cost element to use when creating an adjustment detail.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CostElementId":{
            "title":"Cost Element ID",
            "type":"integer",
            "description":"Value that uniquely identifies the cost element.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CostElementType":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the cost element type associated to the selected cost element.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"Currency code of the cost recorded in the adjustment detail.",
            "nullable":true
        },
        "ExpensePoolId":{
            "title":"Expense Pool ID",
            "type":"integer",
            "description":"Value that uniquely identifies the expense pool.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "NewCost":{
            "title":"New Cost",
            "type":"number",
            "description":"New cost of the cost adjustment detail.",
            "nullable":false
        },
        "SourceTransactionCostId":{
            "title":"Source Transaction Cost ID",
            "type":"integer",
            "description":"Value that uniquely identifies the transaction cost identifier for which the adjustment detail is linked.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SourceTransactionId":{
            "title":"Source Transaction ID",
            "type":"integer",
            "description":"Value that uniquely identifies the transaction for which the adjustment is created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "UnitCost":{
            "title":"Unit Cost",
            "type":"number",
            "description":"Unit cost of the cost adjustment detail.",
            "nullable":true
        },
        "UserComment":{
            "title":"Comments",
            "maxLength":240,
            "type":"string",
            "description":"Optional comment entered by the user for the cost adjustment detail.",
            "nullable":true
        },
        "UserDefinedFlag":{
            "title":"User Defined",
            "maxLength":5,
            "type":"boolean",
            "description":"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. This attribute doesn't have a default value.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : costAdjustments-item-response

Type: object

Show Source

• AdjustmentDate: string (date-time)
  Title: Adjustment Date

  Date when the cost adjustment was made.
• AdjustmentDetail: array Cost Adjustment Details
  Title: Cost Adjustment Details

  Details of adjustment at the cost elemental level. It includes the cost element, new cost, and optional comments.
• 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. Possible values include Pending, Submitted, or Voided.
• AdjustmentStatusCode: string
  Title: Adjustment Status Code

  Maximum Length: 30

  Abbreviation that identifies the adjustment status. Possible values include P for Pending, S for Submitted, or C for Voided.
• AdjustmentType: string
  Title: Adjustment Type

  Maximum Length: 80

  Type of adjustment. Possible values include Perpetual Average, Receipt, or Layer.
• AdjustmentTypeCode: string
  Title: Adjustment Type Code

  Maximum Length: 25

  Abbreviation that identifies the adjustment type. Possible values include P for Perpetual Average, R for Receipt, or L for 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

  Indicates the name for the inventory organization associated with the cost organization.
• 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
• 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.
• ValuationUnitId: integer (int64)
  Title: Valuation Unit ID

  Value that uniquely identifies the valuation unit.

{
    "type":"object",
    "properties":{
        "AdjustmentDate":{
            "title":"Adjustment Date",
            "type":"string",
            "description":"Date when the cost adjustment was made.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentDetail":{
            "title":"Cost Adjustment Details",
            "type":"array",
            "description":"Details of adjustment at the cost elemental level. It includes the cost element, new cost, and optional comments.",
            "items":{
                "$ref":"#/components/schemas/costAdjustments-AdjustmentDetail-item-response"
            }
        },
        "AdjustmentHeaderId":{
            "title":"Adjustment Header ID",
            "type":"integer",
            "description":"Value that uniquely identifies the adjustment header. The application generates this value.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdjustmentNumber":{
            "title":"Adjustment Number",
            "maxLength":50,
            "type":"string",
            "description":"Number that identifies the adjustment. The application generates this value.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentStatus":{
            "title":"Adjustment Status",
            "maxLength":80,
            "type":"string",
            "description":"Status of the adjustment. Possible values include Pending, Submitted, or Voided.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentStatusCode":{
            "title":"Adjustment Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the adjustment status. Possible values include P for Pending, S for Submitted, or C for Voided.",
            "nullable":false,
            "x-queryable":true
        },
        "AdjustmentType":{
            "title":"Adjustment Type",
            "maxLength":80,
            "type":"string",
            "description":"Type of adjustment. Possible values include Perpetual Average, Receipt, or Layer.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentTypeCode":{
            "title":"Adjustment Type Code",
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the adjustment type. Possible values include P for Perpetual Average, R for Receipt, or L for Layer.",
            "nullable":false,
            "x-queryable":true
        },
        "CostBook":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CostBookId":{
            "title":"Cost Book ID",
            "type":"integer",
            "description":"Value that uniquely identifies the cost book.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CostDate":{
            "title":"Cost Date",
            "type":"string",
            "description":"Date of the costing transaction for the adjustment.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CostOrganizationId":{
            "title":"Cost Organization ID",
            "type":"integer",
            "description":"Value that uniquely identifies the cost organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CostOrganizationName":{
            "title":"Cost Organization Name",
            "maxLength":240,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":200,
            "type":"string",
            "description":"Abbreviation that identifies the currency.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryOrganizationId":{
            "title":"Inventory Organization ID",
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InventoryOrganizationName":{
            "title":"Inventory Organization Name",
            "maxLength":240,
            "type":"string",
            "description":"Indicates the name for the inventory organization associated with the cost organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Item":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the inventory item for the adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemId":{
            "title":"Item ID",
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QuantityOnhand":{
            "title":"Remaining Receipt Quantity",
            "type":"number",
            "description":"Remaining Quantity",
            "nullable":true,
            "x-queryable":true
        },
        "Reason":{
            "title":"Reason",
            "maxLength":80,
            "type":"string",
            "description":"Reason for the cost adjustment transaction.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReasonCode":{
            "title":"Reason Code",
            "maxLength":200,
            "type":"string",
            "description":"Abbreviation that identifies the reason for the cost adjustment transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "ReceiptNumber":{
            "title":"Receipt Number",
            "maxLength":200,
            "type":"string",
            "description":"Number that identifies the receipt of the transaction for the adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "ReceiptQuantity":{
            "title":"Receipt Quantity",
            "type":"number",
            "description":"Quantity of the item received.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalNewCost":{
            "title":"Total New Cost",
            "type":"number",
            "description":"Total new cost of the received item.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalUnitCost":{
            "title":"Total Unit Cost",
            "type":"number",
            "description":"Total cost of the received item.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionId":{
            "title":"Transaction ID",
            "type":"integer",
            "description":"Value that uniquely identifies the transaction in costing.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM Code",
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMName":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "description":"Name of the unit of measure.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ValuationUnit":{
            "maxLength":1000,
            "type":"string",
            "description":"Valuation unit for the adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ValuationUnitId":{
            "title":"Valuation Unit ID",
            "type":"integer",
            "description":"Value that uniquely identifies the valuation unit.",
            "format":"int64",
            "nullable":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"
            }
        }
    }
}

Nested Schema : Cost Adjustment Details

Type: array

Title: Cost Adjustment Details

Details of adjustment at the cost elemental level. It includes the cost element, new cost, and optional comments.

Show Source

• Array of: object costAdjustments-AdjustmentDetail-item-response

{
    "title":"Cost Adjustment Details",
    "type":"array",
    "description":"Details of adjustment at the cost elemental level. It includes the cost element, new cost, and optional comments.",
    "items":{
        "$ref":"#/components/schemas/costAdjustments-AdjustmentDetail-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 : costAdjustments-AdjustmentDetail-item-response

Type: object

Show Source

• AdjustmentHeaderId: integer (int64)
  Title: Adjustment Header ID

  Read Only: true

  Value that uniquely identifies the adjustment to which the adjustment detail is linked.
• CostElement: string
  Title: Cost Element

  Maximum Length: 30

  Cost element to use when creating an adjustment detail.
• CostElementId: integer (int64)
  Title: Cost Element ID

  Value that uniquely identifies the cost element.
• CostElementType: string
  Maximum Length: 30

  Indicates the cost element type associated to the selected cost element.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  Currency code of the cost recorded in the adjustment detail.
• 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 adjustment detail.
• SourceTransactionCostId: integer (int64)
  Title: Source Transaction Cost ID

  Value that uniquely identifies the transaction cost identifier for which the adjustment detail is linked.
• 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 adjustment detail.
• UserAdjustmentId: integer (int64)
  Title: User Adjustment ID

  Read Only: true

  System generated number that uniquely identifies the adjustment detail.
• 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. This attribute doesn't have a default value.

{
    "type":"object",
    "properties":{
        "AdjustmentHeaderId":{
            "title":"Adjustment Header ID",
            "type":"integer",
            "description":"Value that uniquely identifies the adjustment to which the adjustment detail is linked.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CostElement":{
            "title":"Cost Element",
            "maxLength":30,
            "type":"string",
            "description":"Cost element to use when creating an adjustment detail.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CostElementId":{
            "title":"Cost Element ID",
            "type":"integer",
            "description":"Value that uniquely identifies the cost element.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CostElementType":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the cost element type associated to the selected cost element.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"Currency code of the cost recorded in the adjustment detail.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpensePool":{
            "title":"Expense Pool",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpensePoolId":{
            "title":"Expense Pool ID",
            "type":"integer",
            "description":"Value that uniquely identifies the expense pool.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NewCost":{
            "title":"New Cost",
            "type":"number",
            "description":"New cost of the cost adjustment detail.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceTransactionCostId":{
            "title":"Source Transaction Cost ID",
            "type":"integer",
            "description":"Value that uniquely identifies the transaction cost identifier for which the adjustment detail is linked.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceTransactionId":{
            "title":"Source Transaction ID",
            "type":"integer",
            "description":"Value that uniquely identifies the transaction for which the adjustment is created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UnitCost":{
            "title":"Unit Cost",
            "type":"number",
            "description":"Unit cost of the cost adjustment detail.",
            "nullable":true,
            "x-queryable":true
        },
        "UserAdjustmentId":{
            "title":"User Adjustment ID",
            "type":"integer",
            "description":"System generated number that uniquely identifies the adjustment detail.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserComment":{
            "title":"Comments",
            "maxLength":240,
            "type":"string",
            "description":"Optional comment entered by the user for the cost adjustment detail.",
            "nullable":true,
            "x-queryable":true
        },
        "UserDefinedFlag":{
            "title":"User Defined",
            "maxLength":5,
            "type":"boolean",
            "description":"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. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

AdjustmentDetail

Operation: /fscmRestApi/resources/11.13.18.05/costAdjustments/{costAdjustmentsUniqID}/child/AdjustmentDetail

Parameters:

• costAdjustmentsUniqID: $request.path.costAdjustmentsUniqID

Details of adjustment at the cost elemental level. It includes the cost element, new cost, and optional comments.

Back to Top

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,
 ...
 }
 ],
 ...
}   

Back to Top