GET action not supported

get

/fscmRestApi/resources/11.13.18.05/receipts

Request

Query Parameters
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Find receipts.
      Finder Variables:
      • GroupId; integer; Value that uniquely identifies the group that contains the receipt.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : receipts
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : receipts-item-response
Type: object
Show Source
  • Abbreviation that identifies the error message. If the call is successful, then this attribute is empty.
  • Message text of the error. If the call is successful, then this attribute is empty.
  • Value that uniquely identifies the receipt header that includes errors. If the call is successful, then this attribute is empty.
  • Value that uniquely identifies the receipt line that includes an error. If the call is successful, then this attribute is empty.
  • Value that uniquely identifies the group that contains the receipts and transactions from each service call. The system creates this value. It is recommended that you leave the value for this attribute empty.
  • Links
  • Receipt Headers
    Title: Receipt Headers
    The Receipt Headers resource manages details about the receipt header or inbound shipment header.
  • Status of the current service call. Values include SUCCESS or FAILURE.
Nested Schema : Receipt Headers
Type: array
Title: Receipt Headers
The Receipt Headers resource manages details about the receipt header or inbound shipment header.
Show Source
Nested Schema : receipts-receiptHeaders-item-response
Type: object
Show Source
Nested Schema : Flexfields for Receipt Headers
Type: array
Title: Flexfields for Receipt Headers
The Flexfields for Receipt Headers resource manages details about the receipt header that the descriptive flexfield references.
Show Source
Nested Schema : Receipt Lines
Type: array
Title: Receipt Lines
The Receipt Lines resource manages details about the receipt line transaction or the inbound shipment line.
Show Source
Nested Schema : receipts-receiptHeaders-receiptHeaderDFF-item-response
Type: object
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-item-response
Type: object
Show Source
Nested Schema : Lots That Control Items
Type: array
Title: Lots That Control Items
The Lots That Control Items resource manages details about the lot when the lot controls the item.
Show Source
Nested Schema : Lots That Share Control
Type: array
Title: Lots That Share Control
The Lots That Share Control resource manages details about the lot when the lot and the serial controls the item.
Show Source
Nested Schema : Flexfields for Receipt Transactions
Type: array
Title: Flexfields for Receipt Transactions
The Flexfields for Receipt Transactions resource manages details about the receipt transaction that the descriptive flexfield references.
Show Source
Nested Schema : Serials That Control Items
Type: array
Title: Serials That Control Items
The Serial Item Serials resource manages details about the serial when the serial controls the item.
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-lotItemLots-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 lot attributes that the descriptive flexfield references. Use it when only the lot controls the item.
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. Use it when only the lot controls the item.
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-lotItemLots-lotItemLotAttributesDFF-item-response
Type: object
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-lotItemLots-lotItemLotsDFF-item-response
Type: object
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-lotSerialItemLots-item-response
Type: object
Show Source
Nested Schema : Flexfields for Lot Attributes That Share Control
Type: array
Title: Flexfields for Lot Attributes That Share Control
The Flexfields for Lot Attributes That Share Control resource manages details about lot attributes that the descriptive flexfield references. Use it when lots and serials control the item.
Show Source
Nested Schema : Flexfields for Lots That Share Control
Type: array
Title: Flexfields for Lots That Share Control
The Flexfields for Lots That Share Control resource manages details about the lot that the descriptive flexfield references. Use it when lots and serials control the item.
Show Source
Nested Schema : Serials That Share Control
Type: array
Title: Serials That Share Control
The Serials That Share Control resource manages details about the serial when the lot and the serial controls the item.
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-lotSerialItemLots-lotSerialItemLotAttributesDFF-item-response
Type: object
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-lotSerialItemLots-lotSerialItemLotsDFF-item-response
Type: object
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-lotSerialItemLots-lotSerialItemSerials-item-response
Type: object
Show Source
Nested Schema : Flexfields for Serial Attributes That Share Control
Type: array
Title: Flexfields for Serial Attributes That Share Control
The Flexfields for Serial Attributes That Share Control resource manages details about the serial attributes that the descriptive flexfield references. Use it when lots and serials control the item.
Show Source
Nested Schema : Flexfields for Serials That Share Control
Type: array
Title: Flexfields for Serials That Share Control
The Flexfields for Serials That Share Control resource manages details about the serial that the descriptive flexfield references. Use it when lots and serials control the item.
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-lotSerialItemLots-lotSerialItemSerials-lotSerialItemSerialAttributesDFF-item-response
Type: object
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-lotSerialItemLots-lotSerialItemSerials-lotSerialItemSerialsDFF-item-response
Type: object
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-receiptTransactionDFF-item-response
Type: object
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-serialItemSerials-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 serial attributes that the descriptive flexfield references. Use it when only the serial controls the item.
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. Use it when only the serial controls the item.
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-serialItemSerials-serialItemSerialAttributesDFF-item-response
Type: object
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-serialItemSerials-serialItemSerialsDFF-item-response
Type: object
Show Source
Back to Top