Jump to

• Request
• Response

Get all tolerance rules

get

/fscmRestApi/resources/11.13.18.05/inboundFiscalDocumentToleranceRules

Request

Query Parameters

• 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
• finder: string
  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 a tolerance rule according to its primary key.
    Finder Variables:
    • ToleranceRuleId; integer; Value that uniquely identifies a tolerance rule.
• limit: integer
  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.
• 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
  
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  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
• q: string
  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:
  

  • Description; string; Stores the tolerance rule description for a specific row.
  • InactiveFlag; boolean; Flag identifying if the tolerance rule is inactive or not.
  • InventoryItemId; integer; Indicates the item to which tolerance rule is applicable.
  • InventoryItemNumber; string; Indicates the item name to which tolerance rule is applicable.
  • InventoryOrganizationId; integer; Indicates the inventory organization id to which tolerance rule is applicable.
  • InventoryOrganizationName; string; Indicates the inventory organization name to which tolerance rule is applicable.
  • LastUpdateDate; string; Indicates the date and time of the last update of the row.
  • Name; string; Stores the tolerance rule name for a specific row
  • PartyId; integer; Indicates the party id to which tolerance rule is applicable.
  • PartyName; string; Indicates the party name to which tolerance rule is applicable.
  • Status; string; Indicates the status of tolerance rule whether it is active or not
  • ToleranceRuleCode; string; Indicates the tolerance code of the tolerance.
  • ToleranceRuleId; integer; Indicates identifier for tolerance rules.
• totalResults: boolean
  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

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

Body ()

Root Schema : inboundFiscalDocumentToleranceRules

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/inboundFiscalDocumentToleranceRules-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"InventoryManagement",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object inboundFiscalDocumentToleranceRules-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/inboundFiscalDocumentToleranceRules-item-response"
    }
}

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 : inboundFiscalDocumentToleranceRules-item-response

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 240

  Stores the tolerance rule description for a specific row.
• InactiveFlag: boolean
  Title: Inactive

  Maximum Length: 1

  Default Value: false

  Flag identifying if the tolerance rule is inactive or not.
• InventoryItemId: integer (int64)
  Title: Inventory Item ID

  Indicates the item to which tolerance rule is applicable.
• InventoryItemNumber: string
  Title: Item

  Read Only: true

  Maximum Length: 300

  Indicates the item name to which tolerance rule is applicable.
• InventoryOrganizationId: integer (int64)
  Title: Inventory Organization ID

  Indicates the inventory organization id to which tolerance rule is applicable.
• InventoryOrganizationName: string
  Title: Inventory Organization

  Read Only: true

  Maximum Length: 240

  Indicates the inventory organization name to which tolerance rule is applicable.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Indicates the date and time of the last update of the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Name

  Maximum Length: 80

  Stores the tolerance rule name for a specific row
• PartyId: integer (int64)
  Title: Party ID

  Indicates the party id to which tolerance rule is applicable.
• PartyName: string
  Title: Party Name

  Read Only: true

  Maximum Length: 360

  Indicates the party name to which tolerance rule is applicable.
• ReceivedQuantityToleranceHigherLimit: number
  Title: Received Quantity Tolerance Higher Limit

  Indicates the higher tolerance limit for the received quantity tolerance type .
• ReceivedQuantityToleranceHigherLimitAction: string
  Title: Received Quantity Tolerance Higher Limit Action

  Maximum Length: 30

  Default Value: ALLOW_DISCREPANCY

  Higher limit action for received quantity tolerance.
• ReceivedQuantityToleranceLowerLimit: number
  Title: Received Quantity Tolerance Lower Limit

  Indicates the lower tolerance limit for the received quantity tolerance type .
• ReceivedQuantityToleranceLowerLimitAction: string
  Title: Received Quantity Tolerance Lower Limit Action

  Maximum Length: 30

  Default Value: ALLOW_DISCREPANCY

  Lower limit action for received quantity tolerance.
• SourceDocumentPriceToleranceHigherLimit: number
  Title: Source Document Price Tolerance Higher Limit

  Indicates the higher tolerance limit for the source document price tolerance type.
• SourceDocumentPriceToleranceHigherLimitAction: string
  Title: Source Document Price Tolerance Higher Limit Action

  Maximum Length: 30

  Default Value: ALLOW_DISCREPANCY

  Higher limit action for source document price tolerance.
• SourceDocumentPriceToleranceLowerLimit: number
  Title: Source Document Price Tolerance Lower Limit

  Indicates the lower tolerance limit for the source document price tolerance type.
• SourceDocumentPriceToleranceLowerLimitAction: string
  Title: Source Document Price Tolerance Lower Limit Action

  Maximum Length: 30

  Default Value: ALLOW_DISCREPANCY

  Lower limit action for source document price tolerance.
• SourceDocumentQuantityToleranceHigherLimit: number
  Title: Source Document Quantity Tolerance Higher Limit Action

  Indicates the higher tolerance limit for the source document quantity tolerance type.
• SourceDocumentQuantityToleranceHigherLimitAction: string
  Title: Source Document Quantity Tolerance Higher Limit

  Maximum Length: 30

  Default Value: ALLOW_DISCREPANCY

  Higher limit action for source document quantity tolerance.
• SourceDocumentQuantityToleranceLowerLimit: number
  Title: Source Document Quantity Tolerance Lower Limit

  Indicates the lower tolerance limit for the source document quantity tolerance type.
• SourceDocumentQuantityToleranceLowerLimitAction: string
  Title: Source Document Quantity Tolerance Lower Limit Action

  Maximum Length: 30

  Default Value: ALLOW_DISCREPANCY

  Lower limit action for source document quantity tolerance.
• Status: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  Indicates the status of tolerance rule whether it is active or not
• ToleranceRuleCode: string
  Title: Code

  Maximum Length: 30

  Indicates the tolerance code of the tolerance.
• ToleranceRuleId: integer (int64)
  Title: Tolerance Rule ID

  Indicates identifier for tolerance rules.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Stores the tolerance rule description for a specific row.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentPriceToleranceLowerLimitAction":{
            "title":"Source Document Price Tolerance Lower Limit Action",
            "maxLength":"30",
            "type":"string",
            "description":"Lower limit action for source document price tolerance.",
            "nullable":true,
            "default":"ALLOW_DISCREPANCY",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InventoryOrganizationName":{
            "title":"Inventory Organization",
            "maxLength":"240",
            "type":"string",
            "description":"Indicates the inventory organization name to which tolerance rule is applicable.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceDocumentPriceToleranceHigherLimitAction":{
            "title":"Source Document Price Tolerance Higher Limit Action",
            "maxLength":"30",
            "type":"string",
            "description":"Higher limit action for source document price tolerance.",
            "nullable":true,
            "default":"ALLOW_DISCREPANCY",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartyName":{
            "title":"Party Name",
            "maxLength":"360",
            "type":"string",
            "description":"Indicates the party name to which tolerance rule is applicable.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"Stores the tolerance rule name for a specific row",
            "nullable":false,
            "x-queryable":true
        },
        "SourceDocumentPriceToleranceHigherLimit":{
            "title":"Source Document Price Tolerance Higher Limit",
            "type":"number",
            "description":"Indicates the higher tolerance limit for the source document price tolerance type.",
            "nullable":true,
            "x-queryable":false
        },
        "InventoryOrganizationId":{
            "title":"Inventory Organization ID",
            "type":"integer",
            "description":"Indicates the inventory organization id to which tolerance rule is applicable.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "ToleranceRuleId":{
            "title":"Tolerance Rule ID",
            "type":"integer",
            "description":"Indicates identifier for tolerance rules.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ReceivedQuantityToleranceHigherLimitAction":{
            "title":"Received Quantity Tolerance Higher Limit Action",
            "maxLength":"30",
            "type":"string",
            "description":"Higher limit action for received quantity tolerance.",
            "nullable":true,
            "default":"ALLOW_DISCREPANCY",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ReceivedQuantityToleranceHigherLimit":{
            "title":"Received Quantity Tolerance Higher Limit",
            "type":"number",
            "description":"Indicates the higher tolerance limit for the received quantity tolerance type .",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceDocumentQuantityToleranceHigherLimitAction":{
            "title":"Source Document Quantity Tolerance Higher Limit",
            "maxLength":"30",
            "type":"string",
            "description":"Higher limit action for source document quantity tolerance.",
            "nullable":true,
            "default":"ALLOW_DISCREPANCY",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InventoryItemNumber":{
            "title":"Item",
            "maxLength":"300",
            "type":"string",
            "description":"Indicates the item name to which tolerance rule is applicable.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"Indicates the status of tolerance rule whether it is active or not",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceDocumentQuantityToleranceLowerLimit":{
            "title":"Source Document Quantity Tolerance Lower Limit",
            "type":"number",
            "description":"Indicates the lower tolerance limit for the source document quantity tolerance type.",
            "nullable":true,
            "x-queryable":false
        },
        "ToleranceRuleCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the tolerance code of the tolerance.",
            "nullable":false,
            "x-queryable":true
        },
        "ReceivedQuantityToleranceLowerLimit":{
            "title":"Received Quantity Tolerance Lower Limit",
            "type":"number",
            "description":"Indicates the lower tolerance limit for the received quantity tolerance type .",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentPriceToleranceLowerLimit":{
            "title":"Source Document Price Tolerance Lower Limit",
            "type":"number",
            "description":"Indicates the lower tolerance limit for the source document price tolerance type.",
            "nullable":true,
            "x-queryable":false
        },
        "InventoryItemId":{
            "title":"Inventory Item ID",
            "type":"integer",
            "description":"Indicates the item to which tolerance rule is applicable.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "dependencies":[
                    "InventoryOrganizationId"
                ]
            },
            "x-queryable":true
        },
        "InactiveFlag":{
            "title":"Inactive",
            "maxLength":"1",
            "type":"boolean",
            "description":"Flag identifying if the tolerance rule is inactive or not.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReceivedQuantityToleranceLowerLimitAction":{
            "title":"Received Quantity Tolerance Lower Limit Action",
            "maxLength":"30",
            "type":"string",
            "description":"Lower limit action for received quantity tolerance.",
            "nullable":true,
            "default":"ALLOW_DISCREPANCY",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"Indicates the party id to which tolerance rule is applicable.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceDocumentQuantityToleranceHigherLimit":{
            "title":"Source Document Quantity Tolerance Higher Limit Action",
            "type":"number",
            "description":"Indicates the higher tolerance limit for the source document quantity tolerance type.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentQuantityToleranceLowerLimitAction":{
            "title":"Source Document Quantity Tolerance Lower Limit Action",
            "maxLength":"30",
            "type":"string",
            "description":"Lower limit action for source document quantity tolerance.",
            "nullable":true,
            "default":"ALLOW_DISCREPANCY",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Indicates the date and time of the last update of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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