Jump to

• Request
• Response

Get all agreement price breaks

get

/fscmRestApi/resources/11.13.18.05/purchaseAgreementLines/{AgreementLineId}/child/priceBreaks

Request

Path Parameters

• AgreementLineId(required): integer(int64)
  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

• 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>
• effectiveDate: string
  This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
• 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 agreement line price breaks according to their primary key.
    Finder Variables
    • PriceBreakId; integer; Value that uniquely identifies the agreement line price break
• 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:
  

  • CreatedBy; string; User who created the price breaks for a purchase agreement line.
  • CreationDate; string; Date and time when the buyer or application created the price breaks for a purchase agreement line.
  • LastUpdateDate; string; Date when the price break was last updated.
  • LastUpdatedBy; string; User who last updated the price breaks on a purchase agreement line.
  • LineNumber; number; Value that uniquely identifies the purchase order or agreement line.
  • PriceBreakId; integer; Value that uniquely identifies the price break referenced by this line.
  • PriceBreakNumber; number; Number that uniquely identifies the price break on the purchase agreement line.
  • UOM; string; Abbreviation that identifies the unit of measure on the agreement line price break.
• 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

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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 : purchaseAgreementLines-priceBreaks

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/purchaseAgreementLines-priceBreaks-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object purchaseAgreementLines-priceBreaks-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/purchaseAgreementLines-priceBreaks-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 : purchaseAgreementLines-priceBreaks-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the price breaks for a purchase agreement line.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the buyer or application created the price breaks for a purchase agreement line.
• Currency: string
  Title: Currency

  Read Only: true

  Maximum Length: 80

  Currency on the agreement line price break.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 15

  Code that identifies the currency on the agreement line price break.
• DiscountPercent: number
  Title: Discount Percent

  Read Only: true

  Value that identifies the discount percentage for the price break.
• EndDate: string (date)
  Title: End Date

  Read Only: true

  Date after which the purchase agreement is no longer valid.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the price break was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the price breaks on a purchase agreement line.
• LineNumber: number
  Title: Line

  Read Only: true

  Value that uniquely identifies the purchase order or agreement line.
• links: array Links
  Title: Links

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

  Read Only: true

  Maximum Length: 240

  Name of the location where the supplier ships the item.
• LocationCode: string
  Title: Location Code

  Read Only: true

  Maximum Length: 60

  Abbreviation that identifies the location where the supplier ships the item.
• LocationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the location where the supplier ships the shipment item.
• Price: number
  Title: Price

  Read Only: true

  Unit price for the line.
• PriceBreakId: integer (int64)
  Read Only: true

  Value that uniquely identifies the price break referenced by this line.
• PriceBreakNumber: number
  Title: Price Break

  Read Only: true

  Number that uniquely identifies the price break on the purchase agreement line.
• Quantity: number
  Title: Quantity

  Read Only: true

  Value that identifies the price break quantity, when the price break is effective for blanket purchase orders.
• ShipToOrganization: string
  Title: Ship-to Organization

  Read Only: true

  Maximum Length: 240

  Name of the inventory organization that receives the item.
• ShipToOrganizationCode: string
  Title: Ship-to Organization Code

  Read Only: true

  Maximum Length: 18

  Abbreviation that identifies the ship-to organization.
• ShipToOrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the ship-to organization.
• StartDate: string (date)
  Title: Start Date

  Read Only: true

  Date on which the agreement becomes effective.
• UOM: string
  Title: UOM

  Read Only: true

  Maximum Length: 25

  Abbreviation that identifies the unit of measure on the agreement line price break.
• UOMCode: string
  Read Only: true

  Maximum Length: 3

  Code that identifies the unit of measure.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the price breaks on a purchase agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the buyer or application created the price breaks for a purchase agreement line.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the price breaks for a purchase agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceBreakNumber":{
            "title":"Price Break",
            "type":"number",
            "description":"Number that uniquely identifies the price break on the purchase agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the location where the supplier ships the shipment item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LocationCode":{
            "title":"Location Code",
            "maxLength":"60",
            "type":"string",
            "description":"Abbreviation that identifies the location where the supplier ships the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Value that identifies the price break quantity, when the price break is effective for blanket purchase orders.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ShipToOrganization":{
            "title":"Ship-to Organization",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the inventory organization that receives the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date after which the purchase agreement is no longer valid.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LineNumber":{
            "title":"Line",
            "type":"number",
            "description":"Value that uniquely identifies the purchase order or agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date on which the agreement becomes effective.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"Code that identifies the currency on the agreement line price break.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UOM":{
            "title":"UOM",
            "maxLength":"25",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure on the agreement line price break.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "Price":{
            "title":"Price",
            "type":"number",
            "description":"Unit price for the line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Currency":{
            "title":"Currency",
            "maxLength":"80",
            "type":"string",
            "description":"Currency on the agreement line price break.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PriceBreakId":{
            "type":"integer",
            "description":"Value that uniquely identifies the price break referenced by this line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShipToOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ship-to organization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Code that identifies the unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ShipToOrganizationCode":{
            "title":"Ship-to Organization Code",
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the ship-to organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DiscountPercent":{
            "title":"Discount Percent",
            "type":"number",
            "description":"Value that identifies the discount percentage for the price break.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Location":{
            "title":"Location",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the location where the supplier ships the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the price break was last updated.",
            "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