Jump to

• Request
• Response
• Examples

Get all cost adjustments

get

/fscmRestApi/resources/11.13.18.05/costAdjustments

Request

Query Parameters

• effectiveDate: string
  This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Find the cost adjustment according to the cost adjustment identifier as the primary key.
    Finder Variables:
    • AdjustmentHeaderId; integer; Value that uniquely identifies the cost adjustment.
  • findAdjustments: Find the cost adjustments according to the specified attributes.
    Finder Variables:
    • bindAdjustmentDate; string; Date when the cost adjustment was made.
    • bindAdjustmentNumber; string; Number that identifies the adjustment.
    • bindAdjustmentStatus; string; Status of the adjustment.
    • bindAdjustmentType; string; Type of adjustment.
    • bindCostBook; string; Name of the cost book.
    • bindCostOrgName; string; Name of the cost organization.
    • bindItem; string; Name of the item.
    • bindReason; string; Reason for the cost adjustment.
    • bindReceiptNumber; string; Number that identifies the receipt transaction.
    • bindValuationUnit; string; Name of the valuation unit.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AdjustmentDate; string; Date when the cost adjustment was made.
  • AdjustmentHeaderId; integer; Value that uniquely identifies the adjustment header. The application generates this value.
  • AdjustmentNumber; string; Number that identifies the adjustment. The application generates this value.
  • AdjustmentStatus; string; Status of the adjustment. Values include Pending, Submitted, or Voided.
  • AdjustmentStatusCode; string; Abbreviation that identifies the adjustment status. Values include P-Pending, S-Submitted, or C-Voided.
  • AdjustmentType; string; Type of adjustment. Values include Perpetual, Receipt, or Layer.
  • AdjustmentTypeCode; string; Abbreviation that identifies the adjustment type. Values include P-Perpetual, R-Receipt, or L-Layer.
  • CostBook; string; 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; Value that uniquely identifies the cost book.
  • CostDate; string; Date of the costing transaction for the adjustment.
  • CostOrganizationId; integer; Value that uniquely identifies the cost organization.
  • CostOrganizationName; string; 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; Abbreviation that identifies the currency.
  • InventoryOrganizationId; integer; Value that uniquely identifies the inventory organization.
  • InventoryOrganizationName; string; Name of the inventory organization for the adjustment.
  • Item; string; Name of the inventory item for the adjustment.
  • ItemId; integer; Value that uniquely identifies the item.
  • QuantityOnhand; number; Remaining quantity of the item.
  • Reason; string; Reason for the cost adjustment transaction.
  • ReasonCode; string; Abbreviation that identifies the reason for the cost adjustment transaction.
  • ReceiptNumber; string; Number that identifies the receipt of the transaction for the adjustment.
  • ReceiptQuantity; number; Quantity of the item received.
  • TotalNewCost; number; Total new cost of the received item.
  • TotalUnitCost; number; Total cost of the received item.
  • TransactionId; integer; Value that uniquely identifies the transaction in costing.
  • UOMCode; string; Abbreviation that identifies the unit of measure.
  • UOMName; string; Name of the unit of measure.
  • ValuationUnit; string; 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; Value that uniquely identifies the valuation unit.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• 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.

There's no request body for this operation.

Back to Top

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.

Body ()

Root Schema : costAdjustments

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/costAdjustments-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"InventoryManagement",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object costAdjustments-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/costAdjustments-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-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

  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.

{
    "type":"object",
    "properties":{
        "InventoryOrganizationName":{
            "title":"Inventory Organization Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the inventory organization for the adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TotalUnitCost":{
            "title":"Total Unit Cost",
            "type":"number",
            "description":"Total cost of the received item.",
            "nullable":true,
            "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
        },
        "ItemId":{
            "title":"Item ID",
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":200,
            "type":"string",
            "description":"Abbreviation that identifies the currency.",
            "nullable":true,
            "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
        },
        "Item":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the inventory item 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
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AdjustmentDate":{
            "title":"Adjustment Date",
            "type":"string",
            "description":"Date when the cost adjustment was made.",
            "format":"date-time",
            "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
        },
        "UOMCode":{
            "title":"UOM Code",
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "nullable":true,
            "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
        },
        "ValuationUnit":{
            "maxLength":1000,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentStatusCode":{
            "title":"Adjustment Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the adjustment status. Values include P-Pending, S-Submitted, or C-Voided.",
            "nullable":false,
            "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
        },
        "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
        },
        "AdjustmentType":{
            "title":"Adjustment Type",
            "maxLength":80,
            "type":"string",
            "description":"Type of adjustment. Values include Perpetual, Receipt, or Layer.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentStatus":{
            "title":"Adjustment Status",
            "maxLength":80,
            "type":"string",
            "description":"Status of the adjustment. Values include Pending, Submitted, or Voided.",
            "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. Values include P-Perpetual, R-Receipt, or L-Layer.",
            "nullable":false,
            "x-queryable":true
        },
        "AdjustmentDetail":{
            "title":"Cost Adjustment Details",
            "type":"array",
            "description":"Adjustment cost at cost-element level for a receipt or an item.",
            "items":{
                "$ref":"#/components/schemas/costAdjustments-AdjustmentDetail-item-response"
            }
        },
        "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
        },
        "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
        },
        "CostDate":{
            "title":"Cost Date",
            "type":"string",
            "description":"Date of the costing transaction for the adjustment.",
            "format":"date-time",
            "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
        },
        "ReceiptQuantity":{
            "title":"Receipt Quantity",
            "type":"number",
            "description":"Quantity of the item received.",
            "nullable":true,
            "x-queryable":true
        },
        "QuantityOnhand":{
            "title":"Remaining Receipt Quantity",
            "type":"number",
            "description":"Remaining quantity of the item.",
            "nullable":true,
            "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
        }
    }
}

Nested Schema : Cost Adjustment Details

Type: array

Title: Cost Adjustment Details

Adjustment cost at cost-element level for a receipt or an item.

Show Source

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

{
    "title":"Cost Adjustment Details",
    "type":"array",
    "description":"Adjustment cost at cost-element level for a receipt or an item.",
    "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 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.

{
    "type":"object",
    "properties":{
        "SourceTransactionCostId":{
            "title":"Source Transaction Cost ID",
            "type":"integer",
            "description":"Value that uniquely identifies the transaction cost identifier for which the adjustment detail is created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "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. The attribute does not have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "NewCost":{
            "title":"New Cost",
            "type":"number",
            "description":"New cost of the cost element.",
            "nullable":false,
            "x-queryable":true
        },
        "UserAdjustmentId":{
            "title":"User Adjustment ID",
            "type":"integer",
            "description":"Value that uniquely identifies the adjustment detail. The application generates this value.",
            "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
        },
        "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
        },
        "UnitCost":{
            "title":"Unit Cost",
            "type":"number",
            "description":"Unit cost of the cost element.",
            "nullable":true,
            "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
        },
        "AdjustmentHeaderId":{
            "title":"Adjustment Header ID",
            "type":"integer",
            "description":"Value that uniquely identifies the adjustment against which this adjustment detail is created.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CostElement":{
            "title":"Cost Element",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "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."
        }
    }
}

Back to Top

Examples

This example describes how to get all cost adjustments.

<Enter the cURL command syntax>

Get All

Use the following cURL command to submit a request on the REST resource to get all cost adjustments that the database contains:

curl -u username:password "https://servername/fscmRestApi/resources/version/costAdjustments

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

{
  "items" : [ {
    "AdjustmentHeaderId" : 25,
    "AdjustmentNumber" : "25",
    "AdjustmentTypeCode" : "R",
    "AdjustmentDate" : "2017-11-15T00:00:00+00:00",
    "AdjustmentStatusCode" : "C",
    "ReasonCode" : "ST_ADJ",
    "TransactionId" : 428831,
    "CostOrganizationId" : 100000012270096,
    "CostBookId" : 100000010001016,
    "ItemId" : 149,
    "InventoryOrganizationId" : 204,
    "ReceiptQuantity" : 11,
    "QuantityOnhand" : 11,
    "TotalUnitCost" : 0.90151,
    "TotalNewCost" : 11.901518,
    "ValuationUnitId" : 300100002800067,
    "CostDate" : "2015-03-24T23:36:50+00:00",
    "ReceiptNumber" : "UPG_0071_07_R10",
    "CurrencyCode" : "USD",
    "CostOrganizationName" : "ZCST-Vision Ops",
    "CostBook" : "ZCST-Vision Ops",
    "InventoryOrganizationName" : "Vision Operations",
    "Item" : "AS54888",
    "ValuationUnit" : "ORG4-V1",
    "AdjustmentType" : "Receipt",
    "AdjustmentStatus" : "Voided",
    "Reason" : "ST_ADJ",
    "UOMCode" : "Ea",
    "UOMName" : "Each",
     ...
   }, {
     ...
   }, {
     ...
   }
   ],
   ...
}

Get All According to Adjustment Status

Use the following cURL command to submit a request on the REST resource to get all cost adjustments according to the status of the adjustment:

curl -u username:password "https://servername/fscmRestApi/resources/version/costAdjustments?findAdjustments;bindAdjustmentStatus=Submitted

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

{
  "items" : [ {
    "AdjustmentHeaderId" : 24,
    "AdjustmentNumber" : "24",
    "AdjustmentTypeCode" : "R",
    "AdjustmentDate" : "2017-11-15T00:00:00+00:00",
    "AdjustmentStatusCode" : "S",
    "ReasonCode" : "ST_ADJ",
    "TransactionId" : 428831,
    "CostOrganizationId" : 100000012270096,
    "CostBookId" : 100000010001016,
    "ItemId" : 149,
    "InventoryOrganizationId" : 204,
    "ReceiptQuantity" : 11,
    "QuantityOnhand" : 11,
    "TotalUnitCost" : 0.90151,
    "TotalNewCost" : 11.901518,
    "ValuationUnitId" : 300100002800067,
    "CostDate" : "2015-03-24T23:36:50+00:00",
    "ReceiptNumber" : "UPG_0071_07_R10",
    "CurrencyCode" : "USD",
    "CostOrganizationName" : "ZCST-Vision Ops",
    "CostBook" : "ZCST-Vision Ops",
    "InventoryOrganizationName" : "Vision Operations",
    "Item" : "AS54888",
    "ValuationUnit" : "ORG4-V1",
    "AdjustmentType" : "Receipt",
    "AdjustmentStatus" : "Submitted",
    "Reason" : "ST_ADJ",
    "UOMCode" : "Ea",
    "UOMName" : "Each",
 ...
   }, {
    ...
   }, {
    ...
   }
   ],
   ...
}

Back to Top