GET action not supported

get

/fscmRestApi/resources/11.13.18.05/receipts/{GroupId}/child/receiptHeaders

Request

Path Parameters
  • 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
  • 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
  • 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 Finds receipt headers.
      Finder Variables
      • UniqueHeaderId; integer; Value that uniquely identifies the receipt header.
  • 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

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • BUId; integer; Value that uniquely identifies the business unit. For a purchase order receipt, this attribute references the procurement business unit of the supplier site. For a receipt that includes a return material authorization, this attribute references the business unit that the return material authorization contains.
    • BillOfLading; string; Number that identifies the bill of lading for this shipment.
    • BusinessUnit; string; Name of the business unit. For a purchase order receipt, this attribute references the procurement business unit of the supplier site. For a receipt that includes a return material authorization, this attribute references the business unit that the return material authorization contains.
    • Comments; string; Text that describes the receiving that occurred when receiving the item.
    • CustomerId; integer; Value that uniquely identifies the customer.
    • CustomerPartyName; string; Name of the customer.
    • CustomerPartyNumber; string; Unique identifier for customer party number.
    • EmployeeId; integer; Value that uniquely identifies the employee who performed the receiving transactions.
    • EmployeeName; string; Name of the employee who performed the receiving transactions.
    • FreightCarrierId; integer; Value that uniquely identifies the carrier.
    • FreightCarrierName; string; Name of the carrier.
    • FromOrganizationCode; string; Abbreviation that identifies the source organization for an in-transit shipment.
    • FromOrganizationId; integer; Value that uniquely identifies the source organization for an in-transit shipment.
    • GLDate; string; General ledger date.
    • NumberOfPackingUnits; integer; Number of containers in the shipment.
    • OrganizationCode; string; Abbreviation that identifies the receiving organization.
    • OrganizationId; integer; Value that uniquely identifies the receiving organization.
    • PackingSlip; string; Number that identifies the packing slip for a container on the shipment.
    • RADOOSourceSystemId; integer; Value that uniquely identifies the source system that created the receipt advice for this item.
    • RADOOSourceSystemName; string; Name of the source system that created the receipt advice for this item.
    • ReceiptHeaderId; integer; Value that uniquely identifies the receipt header or shipment header. Use this attribute when you receive an inbound shipment or advance shipment notice, or when you add an item to a receipt that already exists.
    • ReceiptNumber; string; Number that identifies items that the warehouse receives in a single receipt.
    • ReceiptSourceCode; string; Source of the shipment or the receipt. Values include Supplier, Inventory, Transfer Order, or Customer.
    • ShipmentNumber; string; Shipment number that the shipment source assigns. This number corresponds to the number that identifies one of the following objects: advance shipment notice, in-transit shipment, or transfer order shipment.
    • ShippedDate; string; Date when the supplier shipped the item.
    • TransactionDate; string; Date when the transaction occurred.
    • UniqueHeaderId; integer; Value that uniquely identifies the receipt header.
    • VendorId; integer; Value that uniquely identifies the supplier.
    • VendorName; string; Name of the supplier.
    • VendorNumber; string; Number that identifies the supplier.
    • VendorSiteCode; string; Abbreviation that identifies the supplier site for the business unit.
    • VendorSiteId; integer; Value that uniquely identifies the supplier site.
    • WaybillAirbillNumber; string; Number that identifies the waybill or airbill.
  • 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-receiptHeaders
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : receipts-receiptHeaders-item-response
Type: object
Show Source
Nested Schema : receiptHeaderDFF
Type: array
Show Source
Nested Schema : Transaction Lines
Type: array
Title: Transaction 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 for Lot Items resource manages the lot information for a transaction line whose item is lot controlled and not serial controlled.
Show Source
Nested Schema : Serials and Lots That Control Items
Type: array
Title: Serials and Lots That Control Items
The Lots for Lot and Serial Items resource manages the lot information for a transaction line whose item is both lot and serial controlled.
Show Source
Nested Schema : receiptTransactionDFF
Type: array
Show Source
Nested Schema : Serials That Control Items
Type: array
Title: Serials That Control Items
The Serials for Serial Items resource manages the serial number information for a transaction line whose item is serial controlled and not lot controlled.
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-lotItemLots-item-response
Type: object
Show Source
  • Maximum Length: 32
    Abbreviation that identifies the expiration action.
  • Date when the warehouse performed the expiration action.
  • Maximum Length: 150
    Abbreviation that identifies the grade.
  • Date when the warehouse applied a hold on the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot control.
  • Links
  • Date when the item of the lot corresponding to receipt transaction request. This attribute is applicable when the warehouse places the item under lot control.
  • lotItemLotAttributesDFF
  • lotItemLotsDFF
  • Maximum Length: 80
    Number that identifies the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot control.
  • Date when the lot matures. This attribute is applicable when the warehouse places the item under lot control.
  • Date when the lot originated corresponding to the ASN line request or receipt line request. This attribute is applicable when the warehouse places the item under lot control.
  • Maximum Length: 30
    Type of origination for the lot corresponding to the advanced shipment notice (ASN) line request or receipt line request. This attribute is applicable when the warehouse places the item under lot control.
  • Maximum Length: 80
    Number that identifies the parent lot of the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot control.
  • Transaction quantity for the lot in the primary unit of measure that the item uses. This attribute is applicable when the warehouse places the item under lot control.
  • Value that uniquely identifies the receipt line request.
  • Value that uniquely identifies the reason for the receiving transaction. This attribute is applicable when the warehouse places the item under lot control.
  • Maximum Length: 30
    Name of the reason for the receiving transaction for the lot. This attribute is applicable when the warehouse places the item under lot control.
  • Date when the lot is retested. This attribute is based on the lot origination date and the retest interval.
  • Transaction quantity for the lot in the secondary unit of measure that the item uses. This attribute is applicable when the warehouse places the item under lot control.
  • Value that uniquely identifies the material status.
  • Value that uniquely identifies the lot for the receipt line request.
  • Transaction quantity of the item for the lot corresponding to the receipt transaction request expires. This attribute is applicable when the warehouse places the item under lot control.
  • Maximum Length: 150
    Number that identifies the supplier lot for the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot control.
Nested Schema : lotItemLotAttributesDFF
Type: array
Show Source
Nested Schema : lotItemLotsDFF
Type: array
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
  • Maximum Length: 32
    Abbreviation that identifies the expiration action.
  • Date when the warehouse performed the expiration action.
  • Maximum Length: 150
    Abbreviation that identifies the grade.
  • Date when the warehouse applied a hold on the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot and serial control.
  • Links
  • Date when the item of this lot corresponding to the receipt transaction request expires. This attribute is applicable when the warehouse places the item under lot and serial control.
  • Maximum Length: 80
    Number that identifies the lot for the item corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot and serial control.
  • lotSerialItemLotAttributesDFF
  • lotSerialItemLotsDFF
  • Lots and Serials That Control Items
    Title: Lots and Serials That Control Items
    The Serials for Lot and Serial Items resource manages the serial number information associated with a specific lot for a transaction line whose item is both lot and serial controlled.
  • Date when the lot matures for the receipt transaction request. This attribute is applicable when the warehouse places the item under lot and serial control.
  • Date when this lot originated for the receipt transaction request. This attribute is applicable when the warehouse places the item under lot and serial control.
  • Maximum Length: 30
    Type of origination for the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot and serial control.
  • Maximum Length: 80
    Number that identifies the parent lot of the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot and serial control.
  • Transaction quantity for this lot in the primary unit of measure that the item uses. This attribute is applicable when the warehouse places the item under lot and serial control.
  • Value that uniquely identifies the receipt line request.
  • Value that uniquely identifies the reason for the receiving transaction for the lot. This attribute is applicable when the warehouse places the item under lot and serial control.
  • Maximum Length: 30
    Name of the reason for the receiving transaction for the lot. This attribute is applicable when the warehouse places the item under lot and serial control.
  • Date when the lot is retested. This attribute is based on the lot origination date and the retest interval.
  • Transaction quantity for this lot in the secondary unit of measure that the item uses. This attribute is applicable when the warehouse places the item under lot and serial control.
  • Value that uniquely identifies the material status.
  • Value that uniquely identifies the lot for lot serial items for the receipt line request.
  • Transaction quantity of the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot and serial control.
  • Maximum Length: 150
    Number that identifies the supplier lot for the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot and serial control.
Nested Schema : lotSerialItemLotAttributesDFF
Type: array
Show Source
Nested Schema : lotSerialItemLotsDFF
Type: array
Show Source
Nested Schema : Lots and Serials That Control Items
Type: array
Title: Lots and Serials That Control Items
The Serials for Lot and Serial Items resource manages the serial number information associated with a specific lot for a transaction line whose item is both lot and serial controlled.
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 : lotSerialItemSerialAttributesDFF
Type: array
Show Source
Nested Schema : lotSerialItemSerialsDFF
Type: array
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 : serialItemSerialAttributesDFF
Type: array
Show Source
Nested Schema : serialItemSerialsDFF
Type: array
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