Get one transaction

get

/fscmRestApi/resources/11.13.18.05/receivingTransactionsHistory/{TransactionId}

Request

Path Parameters
Query Parameters
  • 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>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : receivingTransactionsHistory-item-response
Type: object
Show Source
Nested Schema : Flexfields for Inventory Striping Attributes
Type: array
Title: Flexfields for Inventory Striping Attributes
The Flexfields for Inventory Striping Attributes resource manages the inventory striping attributes that the descriptive flexfield references associated with a receiving transaction. Inventory striping (inventory tracking) attributes are a set of named attributes (project, task, and country of origin) as well as user-configurable attributes, which when specified as part of the receipt or receiving transaction, are used to track the inventory on hand.
Show Source
Nested Schema : Lots
Type: array
Title: Lots
The Lots resource manages the lots associated to a receiving transaction.
Show Source
Nested Schema : Receipt Header Attachments
Type: array
Title: Receipt Header Attachments
This resource manages details about receipt header attachments.
Show Source
Nested Schema : Receipt Header Descriptive Flexfields
Type: array
Title: Receipt Header Descriptive Flexfields
This resource manages the descriptive flexfield information for a receipt header.
Show Source
Nested Schema : Serials
Type: array
Title: Serials
The Serials resource manages the serials associated to a receiving transaction.
Show Source
Nested Schema : Transaction Attachments
Type: array
Title: Transaction Attachments
This resource manages details about receiving transaction attachments.
Show Source
Nested Schema : Flexfields for Receiving Transactions
Type: array
Title: Flexfields for Receiving Transactions
The Flexfields for Receiving Transactions resource manages details about the receiving transaction attributes that the descriptive flexfield references.
Show Source
Nested Schema : receivingTransactionsHistory-inventoryStripingDFF-item-response
Type: object
Show Source
  • Title: Context Segment
    Maximum Length: 40
    Descriptive flexfield context name for inventory striping attributes. This attribute is associated with a feature that requires opt in.
  • Title: Context Segment
    Descriptive flexfield context display value for inventory striping attributes. This attribute is associated with a feature that requires opt in.
  • Title: Country of Origin
    Maximum Length: 2
    Abbreviation that identifies the country of manufacture for this item. This attribute is associated with a feature that requires opt in.
  • Title: Country of Origin
    Name of the country of manufacture. This attribute is associated with a feature that requires opt in.
  • Links
  • Title: Project
    Value that uniquely identifies the project. This attribute is associated with a feature that requires opt in.
  • Title: Project
    Number that identifies the project. This attribute is associated with a feature that requires opt in.
  • Title: Task
    Value that uniquely identifies the task. This attribute is associated with a feature that requires opt in.
  • Title: Task
    Number that identifies the task. This attribute is associated with a feature that requires opt in.
  • Value that uniquely identifies the receiving transaction. This attribute is associated with a feature that requires opt in.
Nested Schema : receivingTransactionsHistory-lots-item-response
Type: object
Show Source
Nested Schema : Flexfields for Lot Attributes
Type: array
Title: Flexfields for Lot Attributes
The Flexfields for Lot Attributes resource manages details about the lot attributes that the descriptive flexfield references.
Show Source
Nested Schema : Serials for Lots
Type: array
Title: Serials for Lots
The Serials for Lots resource manages the serials associated to a lot.
Show Source
Nested Schema : Flexfields for Lots
Type: array
Title: Flexfields for Lots
The Flexfields for Lots resource manages details about the lot that the descriptive flexfield references.
Show Source
Nested Schema : receivingTransactionsHistory-lots-lotAttributeDFFs-item-response
Type: object
Show Source
Nested Schema : receivingTransactionsHistory-lots-lotSerials-item-response
Type: object
Show Source
Nested Schema : Flexfields for Lot Serial Attributes
Type: array
Title: Flexfields for Lot Serial Attributes
The Flexfields for Lot Serial Attributes resource manages details about the lot serial attributes that the descriptive flexfield references.
Show Source
Nested Schema : Flexfields for Lot Serials
Type: array
Title: Flexfields for Lot Serials
The Flexfields for Lot Serials resource manages details about the lot serial that the descriptive flexfield references.
Show Source
Nested Schema : receivingTransactionsHistory-lots-lotSerials-lotSerialAttributeDFFs-item-response
Type: object
Show Source
Nested Schema : receivingTransactionsHistory-lots-lotSerials-lotSerialStandardDFFs-item-response
Type: object
Show Source
Nested Schema : receivingTransactionsHistory-lots-lotStandardDFFs-item-response
Type: object
Show Source
Nested Schema : receivingTransactionsHistory-receiptAttachments-item-response
Type: object
Show Source
Nested Schema : receivingTransactionsHistory-receiptDFF-item-response
Type: object
Show Source
Nested Schema : receivingTransactionsHistory-serials-item-response
Type: object
Show Source
Nested Schema : Flexfields for Serial Attributes
Type: array
Title: Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages details about the serial attributes that the descriptive flexfield references.
Show Source
Nested Schema : Flexfields for Serials
Type: array
Title: Flexfields for Serials
The Flexfields for Serials resource manages details about the serial that the descriptive flexfield references.
Show Source
Nested Schema : receivingTransactionsHistory-serials-serialAttributeDFFs-item-response
Type: object
Show Source
Nested Schema : receivingTransactionsHistory-serials-serialStandardDFFs-item-response
Type: object
Show Source
Nested Schema : receivingTransactionsHistory-transactionAttachments-item-response
Type: object
Show Source
Nested Schema : receivingTransactionsHistory-transactionDFFs-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get one transaction.

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/receivingTransactionsHistory/TransactionId"

For example, the following command gets one transaction where the transaction identifier is 3035417:

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

Example Response Body

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

{
    "TransactionId": 3035417,
    "TransactionTypeCode": "DELIVER",
    "TransactionType": "Deliver",
    "TransactionDate": "2014-07-31",
    "Quantity": 20,
    "UOMCode": "Ea",
    "UnitOfMeasure": "Each",
    "PrimaryQuantity": 20,
    "PrimaryUOMCode": "Ea",
    "PrimaryUnitOfMeasure": "Each",
    "Amount": null,
    "CurrencyCode": "USD",
    "CurrencyName": "US Dollar",
    "CurrencyConversionType": null,
    "CurrencyConversionRate": null,
    "CurrencyConversionDate": null,
    "ItemId": 663912,
    "ItemNumber": "RCV-110",
    "ItemDescription": "LSR Item"
    ...
}
Back to Top