Jump to

• Request
• Response
• Examples

Get a periodic average cost adjustment

get

/fscmRestApi/resources/11.13.18.05/periodicAverageCostAdjustments/{AdjustmentHeaderId}

Request

Path Parameters

• AdjustmentHeaderId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 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 : periodicAverageCostAdjustments-item-response

Type: object

Show Source

• Account: string
  Title: Account

  Maximum Length: 1000

  Combination of the segment attributes of the account key.
• AccountCodeCombinationId: integer (int64)
  Title: Account Code Combination ID

  Optional account code combination ID for the adjustment transaction.
• AdjustmentDate: string (date-time)
  Title: Adjustment Date

  Read Only: true

  Date when the cost adjustment was made.
• 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

  Read Only: true

  Maximum Length: 80

  Status of the adjustment. Values are Draft, Submitted, Processed, Deleted, and Failed.
• AdjustmentStatusCode: string
  Title: Adjustment Status Code

  Maximum Length: 1

  Default Value: S

  Abbreviation that identifies the adjustment status. Values include D-Draft, S-Submitted, Y-Processed, X-Deleted, and F-Failed.
• AdjustmentType: string
  Title: Adjustment Type

  Read Only: true

  Maximum Length: 80

  Type of adjustment. Values include Value and Opening cost override.
• AdjustmentTypeCode: string
  Title: Adjustment Type Code

  Maximum Length: 30

  Abbreviation that identifies the adjustment type. Values include VALUE-Value and OPENING_BALANCE-Opening cost override.
• Attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• ChartOfAccountsId: integer (int64)
  Chart of Accounts
• costAdjustmentDetails: array Periodic Average Cost Adjustment Details
  Title: Periodic Average Cost Adjustment Details

  The Cost Adjustment Details resource manages cost element level details for the periodic average cost adjustment.
• CostBook: string
  Title: Cost Book

  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.
• 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.
• CostProfileId: integer (int64)
  Title: Cost Profile ID

  Cost profile used for processing the adjustment. The application generates this value.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Created By
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Creation Date
• CurrencyCode: string
  Title: Currency Code

  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the currency.
• ErrorMessage: string
  Read Only: true

  Maximum Length: 60

  System-generated message to indicate that an error occurred while processing the adjustment.
• HeaderReferenceNumber: string
  Maximum Length: 18

  A unique reference number added by the user to identify the adjustment.
• Item: string
  Maximum Length: 255

  Name of the inventory item for the adjustment.
• ItemCostProfileId: integer (int64)
  Title: Item Cost Profile ID

  Item Cost profile used for processing the adjustment. The application generates this value.
• ItemId: integer (int64)
  Title: Item ID

  Value that uniquely identifies the item.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Last Update Date
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Last Updated By
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PeriodName: string
  Title: Period Name

  Maximum Length: 15

  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
  Title: Period Status

  Read Only: true

  Maximum Length: 255

  Period status of the cost adjustment.
• PeriodStatusCode: string
  Title: Period Status Code

  Read Only: true

  Maximum Length: 255

  Period status code of the adjustment.
• Reason: string
  Title: Reason

  Read Only: true

  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.
• TotalUnitCost: number
  Title: Total Unit Cost

  Total unit cost for the adjustment transaction, which is the sum of the unit cost of all the cost elements.
• TransactionId: integer (int64)
  Title: Transaction ID

  Read Only: true

  Default Value: 0

  Value that uniquely identifies the transaction in costing.
• UOMCode: string
  Title: UOM Code

  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the unit of measure.
• ValuationUnit: string
  Title: Valuation Unit

  Maximum Length: 1000

  Valuation unit code for the cost adjustment transaction.
• ValuationUnitId: integer (int64)
  Title: Valuation Unit ID

  Value that uniquely identifies the valuation unit.
• ValuationUnitType: string
  Title: Valuation Unit Type

  Maximum Length: 255

  Type of valuation unit. Values include Asset and Expense.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Creation Date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Account":{
            "title":"Account",
            "maxLength":"1000",
            "type":"string",
            "description":"Combination of the segment attributes of the account key.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.scm.costing.costProcessor.costAdjustments.restModel.view.PacUserAdjHeaderVO#accountKFF",
                "FND_ACFF_ResourceName":"periodicAverageCostAdjustmentServices",
                "ojStructureInstanceNumber":"ChartOfAccountsId"
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            },
            "x-queryable":true
        },
        "ValuationUnitType":{
            "title":"Valuation Unit Type",
            "maxLength":"255",
            "type":"string",
            "description":"Type of valuation unit. Values include Asset and Expense.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemCostProfileId":{
            "title":"Item Cost Profile ID",
            "type":"integer",
            "description":"Item Cost profile used for processing the adjustment. The application generates this value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "costAdjustmentDetails":{
            "title":"Periodic Average Cost Adjustment Details",
            "type":"array",
            "description":"The Cost Adjustment Details resource manages cost element level details for the periodic average cost adjustment.",
            "items":{
                "$ref":"#/components/schemas/periodicAverageCostAdjustments-costAdjustmentDetails-item-response"
            }
        },
        "AccountCodeCombinationId":{
            "title":"Account Code Combination ID",
            "type":"integer",
            "description":"Optional account code combination ID for the adjustment transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_CCID":"accountKFF",
                "precision":"18"
            },
            "x-queryable":true
        },
        "TotalUnitCost":{
            "title":"Total Unit Cost",
            "type":"number",
            "description":"Total unit cost for the adjustment transaction, which is the sum of the unit cost of all the cost elements.",
            "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-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
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/periodicAverageCostAdjustments-Attachments-item-response"
            }
        },
        "Reason":{
            "title":"Reason",
            "maxLength":"80",
            "type":"string",
            "description":"Reason for the cost adjustment transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HeaderReferenceNumber":{
            "maxLength":"18",
            "type":"string",
            "description":"A unique reference number added by the user to identify the adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "Item":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the inventory item for the adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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
        },
        "ValuationUnitId":{
            "title":"Valuation Unit ID",
            "type":"integer",
            "description":"Value that uniquely identifies the valuation unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PeriodStatusCode":{
            "title":"Period Status Code",
            "maxLength":"255",
            "type":"string",
            "description":"Period status code of the adjustment.",
            "nullable":true,
            "readOnly":true,
            "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,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM Code",
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"Last Updated By",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ValuationUnit":{
            "title":"Valuation Unit",
            "maxLength":"1000",
            "type":"string",
            "description":"Valuation unit code for the cost adjustment transaction.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"Created By",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdjustmentStatusCode":{
            "title":"Adjustment Status Code",
            "maxLength":"1",
            "type":"string",
            "description":"Abbreviation that identifies the adjustment status. Values include D-Draft, S-Submitted, Y-Processed, X-Deleted, and F-Failed.",
            "nullable":false,
            "default":"S",
            "x-queryable":true
        },
        "ChartOfAccountsId":{
            "type":"integer",
            "description":"Chart of Accounts",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "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-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CostProfileId":{
            "title":"Cost Profile ID",
            "type":"integer",
            "description":"Cost profile used for processing the adjustment. The application generates this value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TransactionId":{
            "title":"Transaction ID",
            "type":"integer",
            "description":"Value that uniquely identifies the transaction in costing.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AdjustmentType":{
            "title":"Adjustment Type",
            "maxLength":"80",
            "type":"string",
            "description":"Type of adjustment. Values include Value and Opening cost override.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdjustmentStatus":{
            "title":"Adjustment Status",
            "maxLength":"80",
            "type":"string",
            "description":"Status of the adjustment. Values are Draft, Submitted, Processed, Deleted, and Failed.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdjustmentTypeCode":{
            "title":"Adjustment Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the adjustment type. Values include VALUE-Value and OPENING_BALANCE-Opening cost override.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CostBook":{
            "title":"Cost Book",
            "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
        },
        "PeriodStatus":{
            "title":"Period Status",
            "maxLength":"255",
            "type":"string",
            "description":"Period status of the cost adjustment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodName":{
            "title":"Period Name",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "ErrorMessage":{
            "maxLength":"60",
            "type":"string",
            "description":"System-generated message to indicate that an error occurred while processing the adjustment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Last Update Date",
            "format":"date-time",
            "nullable":false,
            "readOnly":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 : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object periodicAverageCostAdjustments-Attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/periodicAverageCostAdjustments-Attachments-item-response"
    }
}

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

• Array of: object periodicAverageCostAdjustments-costAdjustmentDetails-item-response

{
    "title":"Periodic Average Cost Adjustment Details",
    "type":"array",
    "description":"The Cost Adjustment Details resource manages cost element level details for the periodic average cost adjustment.",
    "items":{
        "$ref":"#/components/schemas/periodicAverageCostAdjustments-costAdjustmentDetails-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 : periodicAverageCostAdjustments-Attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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."
        }
    }
}

Nested Schema : periodicAverageCostAdjustments-costAdjustmentDetails-item-response

Type: object

Show Source

• AdjustmentCreationDate: string (date-time)
  Title: Effective Date

  Read Only: true

  System-generated timestamp to indicate when the adjustment was created for the cost element.
• AdjustmentHeaderId: integer (int64)
  Title: Adjustment Header ID

  Value that uniquely identifies the cost adjustment header for the cost adjustment details.
• 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.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• UnitCost: number
  Title: Unit Cost

  New unit cost for the cost element for the Opening Balance Adjustment.
• UserAdjustmentId: integer (int64)
  Title: User Adjustment ID

  Value that uniquely identifies the cost adjustment detail.
• ValueCost: number
  Incremental value of the cost element for the value adjustment.

{
    "type":"object",
    "properties":{
        "AdjustmentCreationDate":{
            "title":"Effective Date",
            "type":"string",
            "description":"System-generated timestamp to indicate when the adjustment was created for the cost element.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitCost":{
            "title":"Unit Cost",
            "type":"number",
            "description":"New unit cost for the cost element for the Opening Balance Adjustment.",
            "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
        },
        "UserAdjustmentId":{
            "title":"User Adjustment ID",
            "type":"integer",
            "description":"Value that uniquely identifies the cost adjustment detail.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AdjustmentHeaderId":{
            "title":"Adjustment Header ID",
            "type":"integer",
            "description":"Value that uniquely identifies the cost adjustment header for the cost adjustment details.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ValueCost":{
            "type":"number",
            "description":"Incremental value of the cost element for the value adjustment.",
            "nullable":true,
            "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.",
            "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"
    }
}

Links

Attachments

Operation: /fscmRestApi/resources/11.13.18.05/periodicAverageCostAdjustments/{AdjustmentHeaderId}/child/Attachments

Parameters:

• AdjustmentHeaderId: $request.path.AdjustmentHeaderId

The attachments resource is used to view, create, and update attachments.

costAdjustmentDetails

Operation: /fscmRestApi/resources/11.13.18.05/periodicAverageCostAdjustments/{AdjustmentHeaderId}/child/costAdjustmentDetails

Parameters:

• AdjustmentHeaderId: $request.path.AdjustmentHeaderId

The Cost Adjustment Details resource manages cost element level details for the periodic average cost adjustment.

Back to Top

Examples

This example describes how to get xxx.

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/AdjustmentHeaderId"

For example:

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

Example Response Body

The following shows an example of the response body in JSON format.

"{
    "AdjustmentHeaderId": 58003,
    "HeaderReferenceNumber": "58003",
    "AdjustmentNumber": "58003",
    "AdjustmentTypeCode": "VALUE",
    "CostOrganizationId": 100000012270096,
    "CostBookId": 300100549272166,
    "ItemId": 300100549285667,
    "ValuationUnitId": 300100549307298,
    "ItemCostProfileId": 300100549295914,
    "CostProfileId": 300100549272303,
    "TransactionId": 0,
    "ReasonCode": "ST_ADJ",
    "TotalUnitCost": 40,
    "ErrorMessage": null,
    "AdjustmentStatusCode": "S",
    "AccountCodeCombinationId": null,
    "PeriodName": "Apr-22",
    "Item": "PM1000",
    "ValuationUnitType": null,
    "PeriodStatusCode": "O",
    "PeriodStatus": "Open",
    "CostOrganizationName": "ZCST-Vision Ops",
    "CostBook": "ADJ_TEST2",
    "ValuationUnit": "ORG4-V1",
    "AdjustmentType": "Value adjustment",
    "AdjustmentStatus": "Submitted",
    "Reason": "ST_ADJ",
    "ChartOfAccountsId": null,
    "CurrencyCode": "USD",
    "UOMCode": "Ea",
    "AdjustmentDate": "2022-04-30T00:00:00+00:00",
    "CreatedBy": "COST_ACCT_ALL_COST_ORGS",
    "CreationDate": "2022-04-25T09:50:49+00:00",
    "LastUpdateDate": "2022-04-25T09:50:49.347+00:00",
    "LastUpdatedBy": "COST_ACCT_ALL_COST_ORGS",
    "Account": null,
    "links": [
        {
            "rel": "self",
            "href": "https://server/fscmRestApi/resources/version/periodicAverageCostAdjustments/58003",
            "name": "periodicAverageCostAdjustments",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://server/fscmRestApi/resources/version/periodicAverageCostAdjustments/58003",
            "name": "periodicAverageCostAdjustments",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://server/fscmRestApi/resources/version/periodicAverageCostAdjustments/58003/child/Attachments",
            "name": "Attachments",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://server/fscmRestApi/resources/version/periodicAverageCostAdjustments/58003/child/costAdjustmentDetails",
            "name": "costAdjustmentDetails",
            "kind": "collection"
        }
    ]
}"

Back to Top