Get one receipt cost
get
/fscmRestApi/resources/11.13.18.05/receiptCosts/{TransactionId}
Request
Path Parameters
-
TransactionId(required): integer
Value that uniquely identifies the receipt transaction in costing.
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : receiptCosts-item-response
Type:
Show Source
object
-
CostBook: string
Title:
Cost Book
Read Only:true
Maximum Length:30
Name of the cost book where the receipt applies. -
CostBookId: integer
(int64)
Title:
Cost Book ID
Read Only:true
Value that uniquely identifies the cost book. -
CostDate: string
(date-time)
Title:
Cost Date
Read Only:true
Date of the costing transaction. -
CostEffectiveDate: string
(date-time)
Title:
Effective Date
Read Only:true
Date when the cost for the transaction becomes active. -
CostOrganizationId: integer
(int64)
Title:
Cost Organization ID
Read Only:true
Value that uniquely identifies the cost organization. -
CostOrganizationName: string
Title:
Cost Organization Name
Read Only:true
Maximum Length:240
Name of the cost organization where the receipt applies. -
CostProfile: string
Title:
Cost Profile
Read Only:true
Maximum Length:30
Cost profile associated with the receipt item. -
CostProfileId: integer
(int64)
Title:
Cost Profile ID
Read Only:true
Value that uniquely identifies the cost profile. -
CurrencyCode: string
Title:
Currency Code
Read Only:true
Maximum Length:15
Abbreviation that identifies the currency. -
InventoryOrganizationId: integer
(int64)
Title:
Inventory Organization ID
Read Only:true
Value that uniquely identifies the inventory organization. -
InventoryOrganizationName: string
Title:
Inventory Organization Name
Read Only:true
Maximum Length:240
Name of the inventory organization where the receipt applies. -
Item: string
Title:
Item
Read Only:true
Maximum Length:300
Name of the inventory item where the receipt applies. -
ItemId: integer
(int64)
Title:
Item ID
Read Only:true
Value that uniquely identifies the inventory item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
QuantityOnhand: number
Title:
Remaining Receipt Quantity
Read Only:true
Remaining quantity of the inventory item. -
ReceiptCostDetails: array
Receipt Cost Details
Title:
Receipt Cost Details
The Receipt Cost Details resource allows you to view the cost elements and unit costs of the received items. -
ReceiptNumber: string
Title:
Receipt Number
Read Only:true
Maximum Length:50
Number that identifies the receipt. -
ReceiptQuantity: number
Title:
Receipt Quantity
Read Only:true
Quantity of the inventory item received. -
ReferenceNumber: string
Title:
Reference Number
Read Only:true
Maximum Length:240
Number that uniquely identifies the reference. -
TotalUnitCost: number
Title:
Total Unit Cost
Read Only:true
Total cost of the received inventory item. -
TransactionId: integer
Title:
Transaction ID
Read Only:true
Value that uniquely identifies the receipt transaction in costing. -
TransactionTypeName: string
Title:
Transaction Type
Read Only:true
Maximum Length:80
Name of the transaction type where the receipt applies. -
UOMCode: string
Title:
UOM Code
Read Only:true
Maximum Length:3
Abbreviation that identifies the unit of measure. -
UOMName: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Name of the unit of measure. -
ValuationUnit: string
Title:
Valuation Unit
Read Only:true
Maximum Length:1000
Valuation unit where the receipt applies. -
ValuationUnitId: integer
(int64)
Title:
Valuation Unit ID
Read Only:true
Value that uniquely identifies the valuation unit.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Receipt Cost Details
Type:
array
Title:
Receipt Cost Details
The Receipt Cost Details resource allows you to view the cost elements and unit costs of the received items.
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.
Nested Schema : receiptCosts-ReceiptCostDetails-item-response
Type:
Show Source
object
-
CostElement: string
Title:
Cost Element
Read Only:true
Maximum Length:30
Cost element to use with the receipt item. -
CostElementId: integer
(int64)
Title:
Cost Element ID
Read Only:true
Value that uniquely identifies the cost element. -
CostElementType: string
Title:
Cost Element Type
Read Only:true
Maximum Length:30
Name of the cost element type. -
CurrencyCode: string
Title:
Currency Code
Read Only:true
Maximum Length:15
Abbreviation that identifies the currency. -
ExpensePool: string
Title:
Expense Pool
Read Only:true
Maximum Length:30
Expense pool to use when creating the cost. -
ExpensePoolId: integer
(int64)
Title:
Expense Pool ID
Read Only:true
Value that uniquely identifies the expense pool. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TransactionCostId: integer
(int64)
Title:
Transaction Cost ID
Read Only:true
Value that uniquely identifies the transaction cost. -
UnitCost: number
Title:
Unit Cost
Read Only:true
Unit cost of the cost element.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ReceiptCostDetails
-
Parameters:
- TransactionId:
$request.path.TransactionId
The Receipt Cost Details resource allows you to view the cost elements and unit costs of the received items. - TransactionId:
Examples
This example describes how to get one receipt cost.
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/receiptCosts/TransactionId"
Example Response Body
The following shows an example of the response body in JSON format.
{ "TransactionId": 11578, "CostOrganizationId": 100000014977014, "CostOrganizationName": "ZCST-Seattle", "CostBookId": 100000016508002, "CostBook": "zBIA-CB-M1", "InventoryOrganizationId": 207, "InventoryOrganizationName": "Tall Manufacturing", "ItemId": 663915, "Item": "INV-102", "TransactionTypeName": "Miscellaneous Receipt", "ValuationUnitId": 300100007497728, "ValuationUnit": "ORG11-M1-DSR\\-NLOC\\-1", "CostProfileId": 300100007497621, "CostProfile": "Actual-Inv-Sub-Asset", "CostDate": "2009-08-13T23:52:19-07:00", "CostEffectiveDate": "2010-04-04T16:11:57-07:00", "ReceiptNumber": 3456, "ReceiptQuantity": 1, "QuantityOnhand": 1, "TotalUnitCost": 123, "CurrencyCode": "USD", "UOMName": "Each", "UOMCode": "Ea", ... }