Get one receipt for an item
get
/fscmRestApi/resources/11.13.18.05/receiptCosts/{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: string
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: string
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : receiptCosts-item-response
Type:
Show Source
object-
CostBook: string
Title:
Cost BookRead Only:trueMaximum Length:30User-defined description of the cost book. -
CostBookId: integer
(int64)
Title:
Cost Book IDRead Only:trueCode for the valuation unit. -
CostDate: string
(date-time)
Title:
Cost DateRead Only:trueTransaction cost date. -
CostEffectiveDate: string
(date-time)
Title:
Effective DateRead Only:trueDate from which cost is effective. -
CostOrganizationId: integer
(int64)
Title:
Cost Organization IDRead Only:trueUnique identifier for the cost organization. -
CostOrganizationName: string
Title:
Cost Organization NameRead Only:trueMaximum Length:240Name of the cost organization. -
CostProfile: string
Title:
Cost ProfileRead Only:trueMaximum Length:30Value that identifies the cost profile. -
CostProfileId: integer
(int64)
Title:
Cost Profile IDRead Only:trueValue that identifies the cost profile. -
CurrencyCode: string
Title:
Currency CodeRead Only:trueMaximum Length:15Indicates the currency code in which the cost is stored. -
InventoryOrganizationId: integer
(int64)
Title:
Inventory Organization IDRead Only:trueUnique identifier for the inventory organization. -
InventoryOrganizationName: string
Title:
Inventory Organization NameRead Only:trueMaximum Length:240Indicates the name for the inventory organization associated with the cost organization. -
Item: string
Title:
ItemRead Only:trueMaximum Length:300Inventory item name. -
ItemId: integer
(int64)
Title:
Item IDRead Only:trueUnique item identifier -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
QuantityOnhand: number
Title:
Remaining Receipt QuantityRead Only:trueQuantity on hand at the valuation unit. -
ReceiptCostDetails: array
Receipt Cost Adjustment Details
Title:
Receipt Cost Adjustment DetailsCosts associated with a receipt are adjusted through a receipt cost adjustment. Receipt cost details include the cost elements associated with it and their individual costs. -
ReceiptNumber: string
Title:
Receipt NumberRead Only:trueMaximum Length:50Receipt transaction number. -
ReceiptQuantity: number
Title:
Receipt QuantityRead Only:trueReceipt quantity. -
ReferenceNumber: string
Title:
Reference NumberRead Only:trueMaximum Length:240A unique reference number added by the user to identify the adjustment. -
TotalUnitCost: number
Title:
Total Unit CostRead Only:trueTotal unit cost for the adjustment transaction, which is the sum of the unit cost of all the cost elements. -
TransactionId: integer
Title:
Transaction IDRead Only:trueIndicates the transaction identifier of the transaction. -
TransactionTypeName: string
Title:
Transaction TypeRead Only:trueMaximum Length:80Name of the transaction type. -
UOMCode: string
Title:
UOM CodeRead Only:trueMaximum Length:3Indicates the costing unit of measure code. -
UOMName: string
Title:
UOM NameRead Only:trueMaximum Length:25Indicates the costing unit of measure. -
ValuationUnit: string
Title:
Valuation UnitRead Only:trueMaximum Length:1000Code for the valuation unit. -
ValuationUnitId: integer
(int64)
Title:
Valuation Unit IDRead Only:trueIndicates the valuation unit identifier used for the transaction.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Receipt Cost Adjustment Details
Type:
arrayTitle:
Receipt Cost Adjustment DetailsCosts associated with a receipt are adjusted through a receipt cost adjustment. Receipt cost details include the cost elements associated with it and their individual costs.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 ElementRead Only:trueMaximum Length:30Code of the cost element. -
CostElementId: integer
(int64)
Title:
Cost Element IDRead Only:trueIndicates the cost element identifier associated to the selected cost element. -
CostElementType: string
Title:
Cost Element TypeRead Only:trueMaximum Length:30Type of cost element. -
CurrencyCode: string
Title:
Currency CodeRead Only:trueMaximum Length:15Indicates the currency code in which the cost is stored. -
ExpensePool: string
Title:
Expense PoolRead Only:trueMaximum Length:30Indicates the name of the expense pool. -
ExpensePoolId: integer
(int64)
Title:
Expense Pool IDRead Only:trueIndicates the code to identify the expense pool. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionCostId: integer
(int64)
Title:
Transaction Cost IDRead Only:trueTransaction cost identifier. -
UnitCost: number
Title:
Unit CostRead Only:trueUnit cost for actual costed item.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- ReceiptCostDetails
-
Parameters:
- TransactionId:
$request.path.TransactionId
Costs associated with a receipt are adjusted through a receipt cost adjustment. Receipt cost details include the cost elements associated with it and their individual costs. - 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",
...
}