Get all periodic average cost adjustments

get

/fscmRestApi/resources/11.13.18.05/periodicAverageCostAdjustments

Request

Query Parameters
  • 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).
  • 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
  • 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 the cost adjustment according to the cost adjustment identifier as the primary key.
      Finder Variables
      • AdjustmentHeaderId; integer; Value that uniquely identifies the cost adjustment.
    • findPeriodicAverageCostAdjustments Finds periodic average 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.
      • bindPeriod; string; Period of the costing transaction for the adjustment.
      • bindReason; string; Reason for the cost adjustment.
      • bindValuationUnit; string; Name of the valuation unit.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • Account; string; Combination of the segment attributes of the account key.
    • AccountCodeCombinationId; integer; Optional account code combination ID for the adjustment transaction.
    • 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 are Draft, Submitted, Processed, Deleted, and Failed.
    • AdjustmentStatusCode; string; Abbreviation that identifies the adjustment status. Values include D-Draft, S-Submitted, Y-Processed, X-Deleted, and F-Failed.
    • AdjustmentType; string; Type of adjustment. Values include Value and Opening cost override.
    • AdjustmentTypeCode; string; Abbreviation that identifies the adjustment type. Values include VALUE-Value and OPENING_BALANCE-Opening cost override.
    • ChartOfAccountsId; integer; Chart of Accounts
    • 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.
    • 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.
    • CostProfileId; integer; Cost profile used for processing the adjustment. The application generates this value.
    • CreatedBy; string; Created By
    • CreationDate; string; Creation Date
    • CurrencyCode; string; Abbreviation that identifies the currency.
    • ErrorMessage; string; System-generated message to indicate that an error occurred while processing the adjustment.
    • HeaderReferenceNumber; string; A unique reference number added by the user to identify the adjustment.
    • Item; string; Name of the inventory item for the adjustment.
    • ItemCostProfileId; integer; Item Cost profile used for processing the adjustment. The application generates this value.
    • ItemId; integer; Value that uniquely identifies the item.
    • LastUpdateDate; string; Last Update Date
    • LastUpdatedBy; string; Last Updated By
    • PeriodName; string; Period of the costing transaction for the adjustment. Adjustments can only be created in costing periods when the period status is open or pending close.
    • PeriodStatus; string; Period status of the cost adjustment.
    • PeriodStatusCode; string; Period status code of the adjustment.
    • Reason; string; Reason for the cost adjustment transaction.
    • ReasonCode; string; Abbreviation that identifies the reason for the cost adjustment transaction.
    • TotalUnitCost; number; Total unit cost for the adjustment transaction, which is the sum of the unit cost of all the cost elements.
    • TransactionId; integer; Value that uniquely identifies the transaction in costing.
    • UOMCode; string; Abbreviation that identifies the unit of measure.
    • ValuationUnit; string; Valuation unit code for the cost adjustment transaction.
    • ValuationUnitId; integer; Value that uniquely identifies the valuation unit.
    • ValuationUnitType; string; Type of valuation unit. Values include Asset and Expense.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : periodicAverageCostAdjustments
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : periodicAverageCostAdjustments-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Periodic Average Cost Adjustment Details
Type: array
Title: Periodic Average Cost Adjustment Details
The Cost Adjustment Details resource manages cost element level details for the periodic average cost adjustment.
Show Source
Nested Schema : periodicAverageCostAdjustments-Attachments-item-response
Type: object
Show Source
Nested Schema : periodicAverageCostAdjustments-costAdjustmentDetails-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all periodic average cost adjustments.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

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

Example Response Body

The following shows an example of the response body in JSON format.
"{
    "items": [
        {
            "AdjustmentHeaderId": 7003,
            "HeaderReferenceNumber": null,
            "AdjustmentNumber": "7003",
            "AdjustmentTypeCode": "VALUE",
            "CostOrganizationId": 300100206634907,
            "CostBookId": 300100549236702,
            "ItemId": 300100206690451,
            "ValuationUnitId": 300100549236927,
            "ItemCostProfileId": 300100549236769,
            "CostProfileId": 300100549236743,
            "TransactionId": 2417835,
            "ReasonCode": "ST_ADJ",
            "TotalUnitCost": 90,
            "ErrorMessage": null,
            "AdjustmentStatusCode": "Y",
            "AccountCodeCombinationId": null,
            "PeriodName": "Feb-22",
            "Item": "CST Item",
            "ValuationUnitType": null,
            "PeriodStatusCode": "F",
            "PeriodStatus": "Permanently closed",
            "CostOrganizationName": "CST Cost Org",
            "CostBook": "SS1510-CB1",
            "ValuationUnit": "SS1510AssetCB1VU",
            "AdjustmentType": "Value adjustment",
            "AdjustmentStatus": "Processed",
            "Reason": "ST_ADJ",
            "ChartOfAccountsId": null,
            "CurrencyCode": "INR",
            "UOMCode": "Ea",
            "AdjustmentDate": "2022-02-28T00:00:00+00:00",
            "CreatedBy": "COST_ACCT_ALL_COST_ORGS",
            "CreationDate": "2022-04-01T10:05:09+00:00",
            "LastUpdateDate": "2022-04-04T05:15:08+00:00",
            "LastUpdatedBy": "COST_ACCT_ALL_COST_ORGS",
            "Account": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://server/fscmRestApi/resources/version/periodicAverageCostAdjustments/7003",
                    "name": "periodicAverageCostAdjustments",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://server/fscmRestApi/resources/version/periodicAverageCostAdjustments/7003",
                    "name": "periodicAverageCostAdjustments",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://server/fscmRestApi/resources/version/periodicAverageCostAdjustments/7003/child/Attachments",
                    "name": "Attachments",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://server/fscmRestApi/resources/version/periodicAverageCostAdjustments/7003/child/costAdjustmentDetails",
                    "name": "costAdjustmentDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "AdjustmentHeaderId": 6001,
            "HeaderReferenceNumber": null,
            "AdjustmentNumber": "6001",
            "AdjustmentTypeCode": "VALUE",
            "CostOrganizationId": 300100206634907,
            "CostBookId": 300100549236702,
            "ItemId": 300100206690451,
            "ValuationUnitId": 300100549236927,
            "ItemCostProfileId": 300100549236769,
            "CostProfileId": 300100549236743,
            "TransactionId": 0,
            "ReasonCode": "ST_ADJ",
            "TotalUnitCost": 0,
            "ErrorMessage": null,
            "AdjustmentStatusCode": "O",
            "AccountCodeCombinationId": null,
            "PeriodName": "Jan-22",
            "Item": "CST Item",
            "ValuationUnitType": null,
            "PeriodStatusCode": "F",
            "PeriodStatus": "Permanently closed",
            "CostOrganizationName": "CST Cost Org",
            "CostBook": "SS1510-CB1",
            "ValuationUnit": "SS1510AssetCB1VU",
            "AdjustmentType": "Value adjustment",
            "AdjustmentStatus": "Obsolete",
            "Reason": "ST_ADJ",
            "ChartOfAccountsId": null,
            "CurrencyCode": "INR",
            "UOMCode": "Ea",
            "AdjustmentDate": "2022-01-31T00:00:00+00:00",
            "CreatedBy": "COST_ACCT_ALL_COST_ORGS",
            "CreationDate": "2022-04-01T05:53:27+00:00",
            "LastUpdateDate": "2022-04-01T05:53:31.288+00:00",
            "LastUpdatedBy": "COST_ACCT_ALL_COST_ORGS",
            "Account": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://server/fscmRestApi/resources/version/periodicAverageCostAdjustments/6001",
                    "name": "periodicAverageCostAdjustments",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://server/fscmRestApi/resources/version/periodicAverageCostAdjustments/6001",
                    "name": "periodicAverageCostAdjustments",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://server/fscmRestApi/resources/version/periodicAverageCostAdjustments/6001/child/Attachments",
                    "name": "Attachments",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://server/fscmRestApi/resources/version/periodicAverageCostAdjustments/6001/child/costAdjustmentDetails",
                    "name": "costAdjustmentDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "AdjustmentHeaderId": 7001,
            "HeaderReferenceNumber": null,
            "AdjustmentNumber": "7001",
            "AdjustmentTypeCode": "OPENING_BALANCE",
            "CostOrganizationId": 300100206634907,
            "CostBookId": 300100549236702,
            "ItemId": 300100206690451,
            "ValuationUnitId": 300100549236927,
            "ItemCostProfileId": 300100549236769,
            "CostProfileId": 300100549236743,
            "TransactionId": 1716921,
            "ReasonCode": "ST_ADJ",
            "TotalUnitCost": null,
            "ErrorMessage": null,
            "AdjustmentStatusCode": "Y",
            "AccountCodeCombinationId": null,
            "PeriodName": "Feb-22",
            "Item": "CST Item",
            "ValuationUnitType": null,
            "PeriodStatusCode": "F",
            "PeriodStatus": "Permanently closed",
            "CostOrganizationName": "CST Cost Org",
            "CostBook": "SS1510-CB1",
            "ValuationUnit": "SS1510AssetCB1VU",
            "AdjustmentType": "Opening cost override",
            "AdjustmentStatus": "Processed",
            "Reason": "ST_ADJ",
            "ChartOfAccountsId": null,
            "CurrencyCode": "INR",
            "UOMCode": "Ea",
            "AdjustmentDate": "2022-02-01T00:00:00+00:00",
            "CreatedBy": "COST_ACCT_ALL_COST_ORGS",
            "CreationDate": "2022-04-01T08:06:08+00:00",
            "LastUpdateDate": "2022-04-01T08:06:12.316+00:00",
            "LastUpdatedBy": "COST_ACCT_ALL_COST_ORGS",
            "Account": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://server/fscmRestApi/resources/version/periodicAverageCostAdjustments/7001",
                    "name": "periodicAverageCostAdjustments",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://server/fscmRestApi/resources/version/periodicAverageCostAdjustments/7001",
                    "name": "periodicAverageCostAdjustments",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://server/fscmRestApi/resources/version/periodicAverageCostAdjustments/7001/child/Attachments",
                    "name": "Attachments",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://server/fscmRestApi/resources/version/periodicAverageCostAdjustments/7001/child/costAdjustmentDetails",
                    "name": "costAdjustmentDetails",
                    "kind": "collection"
                }
            ]
        },"
Back to Top