Get perpetual average costs for all items
get
/fscmRestApi/resources/11.13.18.05/perpetualAverageCostAdjustments
Request
Query Parameters
-
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 Finds perpetual average costed items according to the primary key.
Finder Variables- TransactionId; integer; Indicates the transaction identifier of the transaction.
- findCosts Finds the perpetual average cost of an item with the item cost.
Finder Variables- bindCostBookId; integer; Name of the cost book.
- bindCostDate; string; Date when the transaction was costed.
- bindCostOrganizationId; integer; Name of the cost organization.
- bindInventoryItemId; integer; Unique identifier of the inventory item.
- bindValUnitId; integer; Unique identifier for the valuation unit.
- PrimaryKey Finds perpetual average costed items according to the primary key.
-
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:- CostBook; string; Value that uniquely identifies the cost book code.
- CostBookId; integer; Code for the valuation unit.
- CostDate; string; Transaction cost date.
- CostOrganizationId; integer; Unique identifier for the cost organization.
- CostOrganizationName; string; Name of the cost organization.
- CostProfile; string; Value that identifies the cost profile.
- CostProfileId; integer; Value that identifies the cost profile.
- CurrencyCode; string; Indicates the currency code in which the cost is stored.
- EffectiveDate; string; Effective date of this cost.
- ExtendedPrecision; number; Indicates the extended precision of the currency.
- InventoryItemId; integer; Indicates the unique identifier of the inventory item.
- InventoryOrgId; integer; Unique identifier for the inventory organization.
- Item; string; Inventory item name.
- LegalEntityTimezoneCode; number; Value that identifies the details of the legal entity time zone.
- MasterOrganizationId; integer; Value that identifies the master organization identifier of the inventory organization associated with the cost organization.
- OrganizationId; integer; Inventory organization identifier.
- ReceiptQuantity; number; Value that indicates the quantity received.
- TotalUnitCost; string; Total unit cost for the adjustment transaction, which is the sum of the unit cost of all the cost elements.
- TransactionId; integer; Indicates the transaction identifier of the transaction.
- UOMCode; string; Indicates the costing unit of measure code.
- ValuationStructureCode; integer; Code for the valuation structure.
- ValuationStructureId; integer; Unique identifier for the valuation structure.
- ValuationUnit; string; Code for the valuation unit.
- ValuationUnitId; integer; Indicates the valuation unit identifier used for the transaction.
-
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
-
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : perpetualAverageCostAdjustments
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : perpetualAverageCostAdjustments-item-response
Type:
Show Source
object
-
CostBook: string
Read Only:
true
Maximum Length:30
Value that uniquely identifies the cost book code. -
CostBookId: integer
(int64)
Read Only:
true
Code for the valuation unit. -
CostDate: string
(date-time)
Read Only:
true
Transaction cost date. -
CostOrganizationId: integer
(int64)
Read Only:
true
Unique identifier for the cost organization. -
CostOrganizationName: string
Read Only:
true
Maximum Length:240
Name of the cost organization. -
CostProfile: string
Read Only:
true
Maximum Length:30
Value that identifies the cost profile. -
CostProfileId: integer
(int64)
Read Only:
true
Value that identifies the cost profile. -
CurrencyCode: string
Read Only:
true
Maximum Length:30
Indicates the currency code in which the cost is stored. -
EffectiveDate: string
(date-time)
Read Only:
true
Effective date of this cost. -
ExtendedPrecision: number
Read Only:
true
Indicates the extended precision of the currency. -
InventoryItemId: integer
(int64)
Read Only:
true
Indicates the unique identifier of the inventory item. -
InventoryOrgId: integer
(int64)
Read Only:
true
Unique identifier for the inventory organization. -
Item: string
Read Only:
true
Maximum Length:300
Inventory item name. -
LegalEntityTimezoneCode: number
Read Only:
true
Value that identifies the details of the legal entity time zone. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MasterOrganizationId: integer
(int64)
Read Only:
true
Value that identifies the master organization identifier of the inventory organization associated with the cost organization. -
OrganizationId: integer
(int64)
Read Only:
true
Inventory organization identifier. -
ReceiptQuantity: number
Read Only:
true
Value that indicates the quantity received. -
TotalUnitCost: string
Read Only:
true
Maximum Length:30
Total unit cost for the adjustment transaction, which is the sum of the unit cost of all the cost elements. -
TransactionId: integer
Read Only:
true
Indicates the transaction identifier of the transaction. -
UOMCode: string
Read Only:
true
Maximum Length:30
Indicates the costing unit of measure code. -
ValuationStructureCode: integer
(int64)
Read Only:
true
Code for the valuation structure. -
ValuationStructureId: integer
(int64)
Read Only:
true
Unique identifier for the valuation structure. -
ValuationUnit: string
Read Only:
true
Maximum Length:1000
Code for the valuation unit. -
ValuationUnitId: integer
(int64)
Read Only:
true
Indicates the valuation unit identifier used for the transaction.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.