Jump to

• Request
• Response
• Examples

Get one parameter

get

/fscmRestApi/resources/11.13.18.05/receivingParameters/{receivingParametersUniqID}

Request

Path Parameters

• receivingParametersUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Receiving Parameters resource and used to uniquely identify an instance of Receiving Parameters. The client should not generate the hash key value. Instead, the client should query on the Receiving Parameters collection resource in order to navigate to a specific instance of Receiving Parameters to get the hash key.

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 Top

Response

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.

Body ()

Root Schema : receivingParameters-item-response

Type: object

Show Source

• AllowDefaultingOfLotsAndSerialNumbersFromASNFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the default lots and serial numbers from an advance shipment notice (ASN) or an advance shipment billing notice (ASBN) are enabled when executing a receipt or a put away transaction. If false, then the default lots and serial numbers from an ASN or an ASBN are not enabled when executing a receipt or a put away transaction. The default value is false.
• AllowDefaultingOfLotsAndSerialNumbersFromTransferOrderFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the default lots and serial numbers from a transfer order are enabled when executing a receipt or a put away transaction. If false, then the default lots and serial numbers from a transfer order aren't enabled when executing a receipt or a put away transaction. The default value is false.
• AllowRoutingOverride: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Contains one of the following values: Yes or No. If Yes, then allow the organization to override the receipt routing. If No, then do not allow the organization to override the receipt routing. The default value is No.
• AllowRoutingOverrideCode: string
  Maximum Length: 1

  Abbreviation that determines whether or not to allow the organization to override the receipt routing.
• AllowSubstituteReceipts: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Contains one of the following values: Yes or No. If Yes, then allow the organization to substitute receipts for the item. If No, then do not allow the organization to substitute receipts for the item. The default value is No.
• AllowSubstituteReceiptsCode: string
  Maximum Length: 1

  Abbreviation that determines whether or not to allow the organization to substitute receipts for the item.
• AllowUnorderedReceipts: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Contains one of the following values: Yes or No. If Yes, then allow the organization to use unordered receipts. If No, then do not allow the organization to use unordered receipts. The default value is No.
• AllowUnorderedReceiptsCode: string
  Maximum Length: 1

  Abbreviation that determines whether or not to allow the organization to use unordered receipts.
• ASNControlAction: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Action to take when receiving a purchase order if an advance shipment notice already exists. Values include Reject, Warning, or None.
• BlindReceivingCode: string
  Maximum Length: 1

  Abbreviation that determines whether or not to enforce blind receiving in the organization.
• DeliveryRequiredForExpenseLocations: string
  Maximum Length: 1

  Abbreviation that indicates if delivery is required for receipts created in expense locations. Valid values are Y, N, and NULL.
• DeliveryRequiredForPARLocations: string
  Maximum Length: 1

  Abbreviation that indicates if delivery is required for receipts created in par locations. Valid values are Y, N, and NULL.
• EarlyReceiptToleranceInDays: number
  Number of days allowed to receive an early shipment.
• EnforceBlindReceiving: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Contains one of the following values: Yes or No. If Yes, then enforce blind receiving in the organization. If No, then do not enforce blind receiving in the organization. The default value is No.
• EnforceRMALotNumber: string
  Maximum Length: 1

  Abbreviation that determines how to enforce the lot number received for the line on the return material authorization. Values include W, R, or U.
• EnforceRMASerialNumbers: string
  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then enforce the serial number received for the line on the return material authorization. If N, then do not enforce this serial number. The default value is N.
• EnforceShipToLocationCode: string
  Maximum Length: 25

  Abbreviation that identifies the action to take if an exception occurs for the ship-to location. Values include REJECT, WARNING, or NONE.
• IncludeClosedPOReceipt: string
  Maximum Length: 1

  Abbreviation that determines whether or not to allow the organization to receive an item that references a closed purchase order.
• IncludeClosedPurchaseOrdersForReceipt: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Contains one of the following values: Yes or No. If Yes, then allow the organization to receive an item that references a closed purchase order. If No, then do not allow the organization to receive an item that references a closed purchase order. The default value is No.
• IntfDropshipsToShipping: string
  Maximum Length: 1

  Contains one of the following values: Yes or No. If Yes, then shipping documents are generated for drop ship orders on advanced shipment notice (ASN) creation. If No, then shipping documents are not generated for drop ship orders. The default value is No.
• IntfReturnsToShipping: string
  Maximum Length: 1

  Abbreviation that determines whether or not to interface supplier returns to shipping for shipping documents.
• IntfRmasToShipping: string
  Maximum Length: 1

  Contains one of the following values: Yes or No. If Yes, then shipping documents are generated for return material authorization order on order creation. If No, then shipping documents are not generated for return material authorization orders. The default value is No.
• LateReceiptToleranceInDays: number
  Number of days allowed to receive a late shipment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManualReceiptNumberType: string
  Maximum Length: 25

  Abbreviation that determines the type of receipt number to use when manually creating a receipt. Values include NUMERIC or ALPHANUMERIC.
• NextReceiptNumber: integer (int64)
  Next number that is in the sequence for creating receipts.
• OrganizationCode: string
  Read Only: true

  Maximum Length: 18

  Abbreviation that identifies the receiving organization.
• OrganizationId: integer (int64)
  Value that uniquely identifies the receiving organization.
• OverReceiptAction: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Action to take when receiving a quantity that exceeds tolerances. Possible values are Reject, Warning, and None.
• OverReceiptTolerance: number
  Percent value allowed to receive items that exceed the tolerance.
• PrintReceiptTraveler: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Contains one of the following values: Yes or No. If Yes, then print the receipt traveler report in the organization on receiving the item. If No, then do not print the receipt traveler report on receipt generation. The default value is No.
• PrintReceiptTravelerCode: string
  Maximum Length: 1

  Abbreviation that determines whether or not to print the receipt traveler report in the organization.
• PrintShippingDocumentsForReturnsToSuppliers: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Contains one of the following values: Yes or No. If Yes, then create shipments for return transfer order to generate shipping documents. If No, then do not create shipments for the supplier returns. The default value is No.
• ProcessAllLinesTogether: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Contains one of the following values: Yes or No. If Yes, then process all lines on an advanced shipment notice together for success or failure. If No, then do not process all lines on an advanced shipment notice together for success or failure. The default value is No.
• ProcessASNLinesTogether: string
  Maximum Length: 1

  Abbreviation that determines whether or not to process all lines on an advance shipment notice together for success or failure.
• QuantityRcvExceptionCode: string
  Maximum Length: 25

  Abbreviation that identifies the action to take if the receipt date occurs outside of tolerances. Values include Reject, Warning or None.
• ReceiptASNExistsCode: string
  Maximum Length: 30

  Abbreviation that identifies the action to take when receiving a purchase order if an advance shipment notice already exists. Values include REJECT, WARNING, or NONE.
• ReceiptDaysExceptionCode: string
  Maximum Length: 25

  Abbreviation that identifies the action to take if a receipt date occurs that exceeds tolerances. Values include REJECT, WARNING, or NONE.
• ReceiptExceedDaysAction: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Action to take if a receipt date occurs that exceeds tolerances. Values include Reject, Warning, or None.
• ReceiptNumberGeneration: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Determines how to create receipt numbers. Values include Manual or Automatic.
• ReceiptNumberType: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Determines the type of receipt number to use when manually creating a receipt. Possible values are Numeric and Alphanumeric.
• ReceiptRouting: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Routing to use when receiving the item. Values include Standard receipt, Inspection required, or Direct delivery.
• ReceivingRoutingId: integer (int64)
  Value that uniquely identifies the routing to use when receiving the item. Values include 1 for standard receipt, 2 for inspection required, or 3 for direct delivery.
• RMALotValidation: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Determines how to enforce the lot number received for the line on the return material authorization. Values include Warning, Restricted, or Unrestricted.
• RMAReceiptRouting: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Routing to use when receiving the documents for the return material authorization. Values include Standard receipt, Inspection required, or Direct delivery.
• RMAReceiptRoutingId: integer (int64)
  Abbreviation that identifies the routing to use when receiving documents for the return material authorization.
• RMASerialNumbersValidation: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Contains one of the following values: Yes or No. If Yes, then enforce that the serial number received on return material authorization (RMA) is the same as that shipped on the original sales order. If No, then do not enforce this serial number. The default value is No.
• ShipToExceptionAction: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Action to take if an exception occurs for the ship-to location. Values include Reject, Warning, or None.
• UserDefinedReceiptNumberCode: string
  Maximum Length: 25

  Abbreviation that determines how to create receipt numbers. Values include MANUAL or AUTOMATIC.

{
    "type":"object",
    "properties":{
        "ShipToExceptionAction":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Action to take if an exception occurs for the ship-to location. Values include Reject, Warning, or None.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LateReceiptToleranceInDays":{
            "type":"number",
            "description":"Number of days allowed to receive a late shipment.",
            "nullable":true,
            "x-queryable":true
        },
        "ReceiptNumberType":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Determines the type of receipt number to use when manually creating a receipt. Possible values are Numeric and Alphanumeric.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowUnorderedReceipts":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Contains one of the following values: Yes or No. If Yes, then allow the organization to use unordered receipts. If No, then do not allow the organization to use unordered receipts. The default value is No.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NextReceiptNumber":{
            "type":"integer",
            "description":"Next number that is in the sequence for creating receipts.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProcessAllLinesTogether":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Contains one of the following values: Yes or No. If Yes, then process all lines on an advanced shipment notice together for success or failure. If No, then do not process all lines on an advanced shipment notice together for success or failure. The default value is No.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OverReceiptAction":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Action to take when receiving a quantity that exceeds tolerances. Possible values are Reject, Warning, and None.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnforceRMASerialNumbers":{
            "maxLength":1,
            "type":"string",
            "description":"Contains one of the following values: Y or N. If Y, then enforce the serial number received for the line on the return material authorization. If N, then do not enforce this serial number. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "ManualReceiptNumberType":{
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that determines the type of receipt number to use when manually creating a receipt. Values include NUMERIC or ALPHANUMERIC.",
            "nullable":true,
            "x-queryable":true
        },
        "AllowSubstituteReceipts":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Contains one of the following values: Yes or No. If Yes, then allow the organization to substitute receipts for the item. If No, then do not allow the organization to substitute receipts for the item. The default value is No.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UserDefinedReceiptNumberCode":{
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that determines how to create receipt numbers. Values include MANUAL or AUTOMATIC.",
            "nullable":true,
            "x-queryable":true
        },
        "RMAReceiptRoutingId":{
            "type":"integer",
            "description":"Abbreviation that identifies the routing to use when receiving documents for the return material authorization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeliveryRequiredForExpenseLocations":{
            "maxLength":1,
            "type":"string",
            "description":"Abbreviation that indicates if delivery is required for receipts created in expense locations. Valid values are Y, N, and NULL.",
            "nullable":true,
            "x-queryable":true
        },
        "ASNControlAction":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Action to take when receiving a purchase order if an advance shipment notice already exists. Values include Reject, Warning, or None.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EarlyReceiptToleranceInDays":{
            "type":"number",
            "description":"Number of days allowed to receive an early shipment.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnforceBlindReceiving":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Contains one of the following values: Yes or No. If Yes, then enforce blind receiving in the organization. If No, then do not enforce blind receiving in the organization. The default value is No.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiptRouting":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Routing to use when receiving the item. Values include Standard receipt, Inspection required, or Direct delivery.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IncludeClosedPOReceipt":{
            "maxLength":1,
            "type":"string",
            "description":"Abbreviation that determines whether or not to allow the organization to receive an item that references a closed purchase order.",
            "nullable":true,
            "x-queryable":true
        },
        "PrintReceiptTraveler":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Contains one of the following values: Yes or No. If Yes, then print the receipt traveler report in the organization on receiving the item. If No, then do not print the receipt traveler report on receipt generation. The default value is No.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiptASNExistsCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the action to take when receiving a purchase order if an advance shipment notice already exists. Values include REJECT, WARNING, or NONE.",
            "nullable":true,
            "x-queryable":true
        },
        "PrintReceiptTravelerCode":{
            "maxLength":1,
            "type":"string",
            "description":"Abbreviation that determines whether or not to print the receipt traveler report in the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "RMALotValidation":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Determines how to enforce the lot number received for the line on the return material authorization. Values include Warning, Restricted, or Unrestricted.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowUnorderedReceiptsCode":{
            "maxLength":1,
            "type":"string",
            "description":"Abbreviation that determines whether or not to allow the organization to use unordered receipts.",
            "nullable":true,
            "x-queryable":true
        },
        "IntfReturnsToShipping":{
            "maxLength":1,
            "type":"string",
            "description":"Abbreviation that determines whether or not to interface supplier returns to shipping for shipping documents.",
            "nullable":true,
            "x-queryable":true
        },
        "ReceiptExceedDaysAction":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Action to take if a receipt date occurs that exceeds tolerances. Values include Reject, Warning, or None.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IncludeClosedPurchaseOrdersForReceipt":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Contains one of the following values: Yes or No. If Yes, then allow the organization to receive an item that references a closed purchase order. If No, then do not allow the organization to receive an item that references a closed purchase order. The default value is No.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QuantityRcvExceptionCode":{
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the action to take if the receipt date occurs outside of tolerances. Values include Reject, Warning or None.",
            "nullable":true,
            "x-queryable":true
        },
        "PrintShippingDocumentsForReturnsToSuppliers":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Contains one of the following values: Yes or No. If Yes, then create shipments for return transfer order to generate shipping documents. If No, then do not create shipments for the supplier returns. The default value is No.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeliveryRequiredForPARLocations":{
            "maxLength":1,
            "type":"string",
            "description":"Abbreviation that indicates if delivery is required for receipts created in par locations. Valid values are Y, N, and NULL.",
            "nullable":true,
            "x-queryable":true
        },
        "AllowDefaultingOfLotsAndSerialNumbersFromTransferOrderFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the default lots and serial numbers from a transfer order are enabled when executing a receipt or a put away transaction. If false, then the default lots and serial numbers from a transfer order aren't enabled when executing a receipt or a put away transaction. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "AllowRoutingOverrideCode":{
            "maxLength":1,
            "type":"string",
            "description":"Abbreviation that determines whether or not to allow the organization to override the receipt routing.",
            "nullable":true,
            "x-queryable":true
        },
        "EnforceShipToLocationCode":{
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the action to take if an exception occurs for the ship-to location. Values include REJECT, WARNING, or NONE.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receiving organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IntfDropshipsToShipping":{
            "maxLength":1,
            "type":"string",
            "description":"Contains one of the following values: Yes or No. If Yes, then shipping documents are generated for drop ship orders on advanced shipment notice (ASN) creation. If No, then shipping documents are not generated for drop ship orders. The default value is No.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the receiving organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceivingRoutingId":{
            "type":"integer",
            "description":"Value that uniquely identifies the routing to use when receiving the item. Values include 1 for standard receipt, 2 for inspection required, or 3 for direct delivery.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RMAReceiptRouting":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Routing to use when receiving the documents for the return material authorization. Values include Standard receipt, Inspection required, or Direct delivery.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiptNumberGeneration":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Determines how to create receipt numbers. Values include Manual or Automatic.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowDefaultingOfLotsAndSerialNumbersFromASNFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the default lots and serial numbers from an advance shipment notice (ASN) or an advance shipment billing notice (ASBN) are enabled when executing a receipt or a put away transaction. If false, then the default lots and serial numbers from an ASN or an ASBN are not enabled when executing a receipt or a put away transaction. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "AllowRoutingOverride":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Contains one of the following values: Yes or No. If Yes, then allow the organization to override the receipt routing. If No, then do not allow the organization to override the receipt routing. The default value is No.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OverReceiptTolerance":{
            "type":"number",
            "description":"Percent value allowed to receive items that exceed the tolerance.",
            "nullable":true,
            "x-queryable":true
        },
        "ReceiptDaysExceptionCode":{
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the action to take if a receipt date occurs that exceeds tolerances. Values include REJECT, WARNING, or NONE.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessASNLinesTogether":{
            "maxLength":1,
            "type":"string",
            "description":"Abbreviation that determines whether or not to process all lines on an advance shipment notice together for success or failure.",
            "nullable":true,
            "x-queryable":true
        },
        "BlindReceivingCode":{
            "maxLength":1,
            "type":"string",
            "description":"Abbreviation that determines whether or not to enforce blind receiving in the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "RMASerialNumbersValidation":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Contains one of the following values: Yes or No. If Yes, then enforce that the serial number received on return material authorization (RMA) is the same as that shipped on the original sales order. If No, then do not enforce this serial number. The default value is No.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowSubstituteReceiptsCode":{
            "maxLength":1,
            "type":"string",
            "description":"Abbreviation that determines whether or not to allow the organization to substitute receipts for the item.",
            "nullable":true,
            "x-queryable":true
        },
        "EnforceRMALotNumber":{
            "maxLength":1,
            "type":"string",
            "description":"Abbreviation that determines how to enforce the lot number received for the line on the return material authorization. Values include W, R, or U.",
            "nullable":true,
            "x-queryable":true
        },
        "IntfRmasToShipping":{
            "maxLength":1,
            "type":"string",
            "description":"Contains one of the following values: Yes or No. If Yes, then shipping documents are generated for return material authorization order on order creation. If No, then  shipping documents are not generated for return material authorization orders. The default value is No.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

This example describes how to get one receiving parameter.

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/receivingParameters?q=OrganizationCode=value"

For example, the following command gets one receiving parameter for organization M1:

curl -u username:password "https://servername/fscmRestApi/resources/version/receivingParameters?q=OrganizationCode=M1"

Example Response Body

The following example includes the contents of the response body in JSON format:

{
"items": [
  {
"OrganizationCode": "M1",
"OrganizationId": 207,
"ShipToExceptionAction": "Warning",
"EnforceShipToLocationCode": "WARNING",
"ASNControlAction": "Warning",
"ReceiptASNExistsCode": "WARNING",
"EarlyReceiptToleranceInDays": 8,
"LateReceiptToleranceInDays": 8,
"ReceiptExceedDaysAction": "Warning",
"ReceiptDaysExceptionCode": "WARNING",
"OverReceiptTolerance": 8,
"OverReceiptAction": "Warning",
"QuantityRcvExceptionCode": "WARNING",
"ReceiptRouting": "Inspection required",
"ReceivingRoutingId": 2,
"AllowSubstituteReceipts": "Yes",
"AllowSubstituteReceiptsCode": "Y",
"AllowUnorderedReceipts": "No",
"AllowUnorderedReceiptsCode": "N",
"EnforceBlindReceiving": "No",
"BlindReceivingCode": "N",
"PrintReceiptTraveler": "No",
"PrintReceiptTravelerCode": "N",
"IncludeClosedPurchaseOrdersForReceipt": "Yes",
"IncludeClosedPOReceipt": "Y",
"AllowRoutingOverride": "Yes",
"AllowRoutingOverrideCode": "Y",
"ProcessAllLinesTogether": "Yes",
"ProcessASNLinesTogether": "Y",
"PrintShippingDocumentsForReturnsToSuppliers": "Yes",
"IntfReturnsToShipping": "Y",
"IntfDropshipsToShipping": "Y",
"IntfRmasToShipping": "Y",
"ReceiptNumberGeneration": "Automatic",
"UserDefinedReceiptNumberCode": "AUTOMATIC",
"ReceiptNumberType": "Numeric",
"ManualReceiptNumberType": "NUMERIC",
"NextReceiptNumber": 33924,
"RMAReceiptRouting": "Standard receipt",
"RMAReceiptRoutingId": 1,
"RMALotValidation": "Restricted",
"EnforceRMALotNumber": "R",
"RMASerialNumbersValidation": "Yes",
"EnforceRMASerialNumbers": "Y",
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
  {
"rel": "self",
"href": "https://servername/logisticsApi/resources/version/receivingParameters",
"name": "receivingParameters",
"kind": "collection"
}
],
}

Back to Top