Jump to

• Request
• Response

Get one cost layer for adjustment

get

/fscmRestApi/resources/11.13.18.05/layerInventoryCostAdjustments/{TransactionId}

Request

Path Parameters

• TransactionId(required): integer
  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 : layerInventoryCostAdjustments-item-response

Type: object

Show Source

• BaseTransactionTypeId: integer (int64)
  Read Only: true

  Identifier for a base transaction type.
• CostAsOfDate: string (date-time)
  Read Only: true

  Value that identifies the cost as of a specific date.
• CostBook: string
  Read Only: true

  Maximum Length: 30

  Name of the cost book.
• CostBookId: integer (int64)
  Read Only: true

  Identifies the cost book identifier associated with the selected cost book.
• 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: 15

  Indicates the currency code in which the cost is stored.
• DepletionQuantity: number
  Read Only: true

  Quantity depleted from a specific layer.
• 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.
• InventoryOrganizationId: integer (int64)
  Read Only: true

  Unique identifier for the inventory organization.
• Item: string
  Read Only: true

  Maximum Length: 300

  Inventory item name.
• LegalEntityTimezoneCode: string
  Read Only: true

  Maximum Length: 50

  Value that identifies the details of the transaction time zone.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LotNumber: string
  Read Only: true

  Maximum Length: 80

  Value that uniquely identifies the lot when the inventory items are lot controlled.
• OrganizationId: integer (int64)
  Read Only: true

  Unique identifier for the inventory organization identifier.
• Posted: string
  Read Only: true

  Maximum Length: 5

  Adjustment status.
• QuantityOnhandDb: number
  Read Only: true

  Quantity on hand at the valuation unit.
• ReceiptNumber: string
  Read Only: true

  Maximum Length: 240

  Value that identifies the receipt number.
• ReceiptQuantity: number
  Read Only: true

  Value that identifies the receipt quantity.
• SerialNumber: string
  Read Only: true

  Maximum Length: 80

  Value that uniquely identifies the serial when the inventory items are serial controlled.
• TotalUnitCost: number
  Read Only: true

  Total unit cost for the adjustment transaction, which is the sum of the unit cost of all the cost elements.
• TransactionDate: string (date-time)
  Read Only: true

  Indicates the transaction date for the record.
• TransactionId: integer
  Read Only: true

  Indicates the transaction identifier of the transaction.
• UOMCode: string
  Read Only: true

  Maximum Length: 3

  Indicates the costing unit of measure code.
• 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.

{
    "type":"object",
    "properties":{
        "CostAsOfDate":{
            "type":"string",
            "description":"Value that identifies the cost as of a specific date.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Posted":{
            "maxLength":"5",
            "type":"string",
            "description":"Adjustment status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Unique identifier for the inventory organization identifier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TotalUnitCost":{
            "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,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"Indicates the currency code in which the cost is stored.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostOrganizationName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the cost organization.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Item":{
            "maxLength":"300",
            "type":"string",
            "description":"Inventory item name.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ValuationUnitId":{
            "type":"integer",
            "description":"Indicates the valuation unit identifier used for the transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InventoryOrganizationId":{
            "type":"integer",
            "description":"Unique identifier for the inventory organization.",
            "format":"int64",
            "nullable":true,
            "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"
            }
        },
        "DepletionQuantity":{
            "type":"number",
            "description":"Quantity depleted from a specific layer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Indicates the costing unit of measure code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LotNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that uniquely identifies the lot when the inventory items are lot controlled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionDate":{
            "type":"string",
            "description":"Indicates the transaction date for the record.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiptNumber":{
            "maxLength":"240",
            "type":"string",
            "description":"Value that identifies the receipt number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValuationUnit":{
            "maxLength":"1000",
            "type":"string",
            "description":"Code for the valuation unit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Indicates the unique identifier of the inventory item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QuantityOnhandDb":{
            "type":"number",
            "description":"Quantity on hand at the valuation unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostProfileId":{
            "type":"integer",
            "description":"Value that identifies the cost profile.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Indicates the transaction identifier of the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LegalEntityTimezoneCode":{
            "maxLength":"50",
            "type":"string",
            "description":"Value that identifies the details of the transaction time zone.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostBook":{
            "maxLength":"30",
            "type":"string",
            "description":"Name of the cost book.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SerialNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that uniquely identifies the serial when the inventory items are serial controlled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostOrganizationId":{
            "type":"integer",
            "description":"Unique identifier for the cost organization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BaseTransactionTypeId":{
            "type":"integer",
            "description":"Identifier for a base transaction type.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CostDate":{
            "type":"string",
            "description":"Transaction cost date.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExtendedPrecision":{
            "type":"number",
            "description":"Indicates the extended precision of the currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostProfile":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the cost profile.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReceiptQuantity":{
            "type":"number",
            "description":"Value that identifies the receipt quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostBookId":{
            "type":"integer",
            "description":"Identifies the cost book identifier associated with the selected cost book.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "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