Get all distributions
get
/fscmRestApi/resources/11.13.18.05/purchaseOrders/{purchaseOrdersUniqID}/child/lines/{POLineId}/child/schedules/{schedulesUniqID}/child/distributions
Request
Path Parameters
-
POLineId(required): integer(int64)
Value that uniquely identifies the purchase order line.
-
purchaseOrdersUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Purchase Orders resource and used to uniquely identify an instance of Purchase Orders. The client should not generate the hash key value. Instead, the client should query on the Purchase Orders collection resource in order to navigate to a specific instance of Purchase Orders to get the hash key.
-
schedulesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Schedules resource and used to uniquely identify an instance of Schedules. The client should not generate the hash key value. Instead, the client should query on the Schedules collection resource in order to navigate to a specific instance of Schedules 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 -
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 purchase order distribution according to the distribution identifier.
Finder Variables:- PODistributionId; integer; Value that uniquely identifies a purchase order distribution.
- PrimaryKey: Finds a purchase order distribution according to the distribution identifier.
-
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:- BudgetDate; string; Date to use to determine the timeframe when the organization consumed the budget.
- CreatedBy; string; User who created the purchase order distribution.
- CreationDate; string; Date and time when the buyer or application created the purchase order distribution.
- DeliverToCustomer; string; Name of the third-party that receives the item.
- DeliverToCustomerId; integer; Value that uniquely identifies the third-party location that receives the item.
- DeliverToCustomerLocation; string; Name of the customer location that receives the item. Applies during a drop ship.
- DeliverToCustomerLocationId; integer; Value that uniquely identifies the third-party location that receives the item.
- DeliverToLocationCode; string; Abbreviation that identifies the final location that receives the item.
- DeliverToLocationId; integer; Value that uniquely identifies the final location that receives the item.
- DestinationSubinventory; string; Subinventory that identifies where to deliver the requested item.
- DistributionNumber; number; Number that uniquely identifies the purchase order distribution for the purchase order schedule.
- LastUpdateDate; string; Date and time when the buyer or application most recently updated the purchase order distribution.
- LastUpdatedBy; string; User who most recently updated the purchase order distribution.
- PODistributionId; integer; Value that uniquely identifies the purchase order distribution.
- Requester; string; Name of the deliver-to person or requester.
- RequesterId; integer; Value that uniquely identifies the deliver-to person or requester.
- Requisition; string; Number that identifies the requisition.
- RequisitionHeaderId; integer; Value that uniquely identifies the requisition header.
-
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 TopResponse
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.
Root Schema : purchaseOrders-lines-schedules-distributions
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : purchaseOrders-lines-schedules-distributions-item-response
Type:
Show Source
object
-
BudgetDate: string
(date)
Title:
Budget Date
Date to use to determine the timeframe when the organization consumed the budget. -
ConversionRate: number
Title:
Conversion Rate
Conversion rate to use when converting the currency. -
ConversionRateDate: string
(date)
Title:
Conversion Date
Date to use for the conversion rate when converting an amount into another currency. The conversion rate varies depending on date. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the purchase order distribution. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the buyer or application created the purchase order distribution. -
Currency: string
Title:
Currency
Read Only:true
Maximum Length:80
Purchase order currency. -
CurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the purchase order currency. -
DeliverToCustomer: string
Title:
Name
Read Only:true
Maximum Length:360
Name of the third-party that receives the item. -
DeliverToCustomerId: integer
(int64)
Value that uniquely identifies the third-party location that receives the item.
-
DeliverToCustomerLocation: string
Read Only:
true
Name of the customer location that receives the item. Applies during a drop ship. -
DeliverToCustomerLocationId: integer
(int64)
Value that uniquely identifies the third-party location that receives the item.
-
DeliverToLocationCode: string
Title:
Deliver-to Location
Read Only:true
Abbreviation that identifies the final location that receives the item. -
DeliverToLocationId: integer
(int64)
Value that uniquely identifies the final location that receives the item.
-
DestinationChargeAccount: string
Title:
Destination Charge Account
Read Only:true
Account to charge for the cost of the item in the requisitioning business unit. -
DestinationChargeAccountId: integer
(int64)
Value that uniquely identifies the account to charge for the cost of the item in the requisitioning business unit.
-
DestinationSubinventory: string
Title:
Destination Subinventory
Maximum Length:10
Subinventory that identifies where to deliver the requested item. -
DestinationVarianceAccount: string
Title:
Destination Variance Account
Read Only:true
Account to charge for the variation in the purchase price for the purchase in the requisitioning business unit. Applies when the legal entity of the requisitioning business unit is not the same as the sold-to legal entity. -
DestinationVarianceAccountId: integer
(int64)
Value that uniquely identifies the account to charge for the variation in the purchase price for the purchase in the requisitioning business unit. Applies when the legal entity of the requisitioning business unit is not the same as the sold-to legal entity.
-
DFF: array
Flexfields for Distributions
Title:
Flexfields for Distributions
The Flexfields for Distributions resource manages additional details about purchase order distributions. -
DistributionNumber: number
Title:
Distribution
Number that uniquely identifies the purchase order distribution for the purchase order schedule. -
globalDFFs: array
US Federal Attributes for Distributions
Title:
US Federal Attributes for Distributions
The US Federal Attributes for Distributions resource manages federal financial attributes for purchase order distributions. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the buyer or application most recently updated the purchase order distribution. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the purchase order distribution. -
LineNumber: number
Title:
Line
Read Only:true
Number that uniquely identifies the purchase order line for the purchase order. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NonrecoverableExclusiveTax: number
Title:
Nonrecoverable Exclusive Tax
Tax that the purchase order amount does not contain. The purchaser cannot recover this tax. -
NonrecoverableInclusiveTax: number
Title:
Nonrecoverable Inclusive Tax
Tax that the purchase order amount contains. The purchaser cannot recover this tax. -
Ordered: number
Title:
Ordered
Price multiplied by the distribution quantity. Applies when the purchase order line contains a quantity. If the purchase order line references a fixed price service, then this attribute contains the same value that the distribution amount contains. -
OrderNumber: string
Title:
Order
Read Only:true
Maximum Length:30
Number that uniquely identifies the purchase order in the sold-to legal entity. -
POAccrualAccount: string
Title:
PO Accrual Account
Read Only:true
Account to charge for receipt accrual. Applies when the legal entity of the requisitioning business unit and the sold-to legal entity are the same. -
POAccrualAccountId: integer
(int64)
Value that uniquely identifies the account to charge for receipt accrual. Applies when the legal entity of the requisitioning business unit and the sold-to legal entity are the same.
-
POChargeAccount: string
Title:
PO Charge Account
Read Only:true
Account to charge for the purchase. Applies when the legal entity of the requisitioning business unit and the sold-to legal entity are the same. -
POChargeAccountId: integer
(int64)
Value that uniquely identifies the account to charge for the purchase. Applies when the legal entity of the requisitioning business unit and the sold-to legal entity are the same.
-
PODistributionId: integer
(int64)
Value that uniquely identifies the purchase order distribution.
-
POHeaderId: integer
(int64)
Value that uniquely identifies the purchase order.
-
POLineId: integer
(int64)
Value that uniquely identifies the parent of the purchase order line.
-
POVarianceAccount: string
Title:
PO Variance Account
Read Only:true
Account to charge for any price difference between the invoice and the purchase order. -
POVarianceAccountId: integer
(int64)
Value that uniquely identifies the account to charge for the price difference between the invoice and the purchase order.
-
projectDFF: array
Project Costing Flexfields for Distributions
Title:
Project Costing Flexfields for Distributions
The Project Costing Flexfields for Distributions resource manages project details about purchase order distributions. -
Quantity: number
Title:
Quantity
Distribution quantity of the item that the purchaser is purchasing. -
RecoverableExclusiveTax: number
Title:
Recoverable Exclusive Tax
Tax that the purchase order amount does not contain. The purchaser can recover this tax. -
RecoverableInclusiveTax: number
Title:
Recoverable Inclusive Tax
Tax that the purchase order amount contains. The purchaser can recover this tax. -
Requester: string
Title:
Requester
Read Only:true
Maximum Length:240
Name of the deliver-to person or requester. -
RequesterId: integer
(int64)
Value that uniquely identifies the deliver-to person or requester.
-
Requisition: string
Title:
Requisition
Read Only:true
Maximum Length:64
Number that identifies the requisition. -
RequisitionDistribution: number
Title:
Requisition Distribution
Read Only:true
Number that uniquely identifies a requisition distribution for the requisition line. -
RequisitionDistributionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the requisition distribution. -
RequisitionHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the requisition header. -
RequisitionLine: number
Title:
Requisition Line
Read Only:true
Number that uniquely identifies the requisition line for the requisition. -
RequisitionLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the requisition line. -
ScheduleNumber: number
Title:
Schedule
Read Only:true
Number that uniquely identifies the purchase order schedule for the purchase order line. -
Total: number
Title:
Total
Ordered amount plus the exclusive tax amounts of the purchase order distribution. -
TotalTax: number
Title:
Total Tax
Total of the exclusive tax amounts that the purchaser can recover and not recover for the purchase order distribution. -
UOM: string
Title:
UOM
Read Only:true
Maximum Length:25
Unit of measure of the item quantity. -
UOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the unit of measure.
Nested Schema : Flexfields for Distributions
Type:
array
Title:
Flexfields for Distributions
The Flexfields for Distributions resource manages additional details about purchase order distributions.
Show Source
Nested Schema : US Federal Attributes for Distributions
Type:
array
Title:
US Federal Attributes for Distributions
The US Federal Attributes for Distributions resource manages federal financial attributes for purchase order distributions.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Project Costing Flexfields for Distributions
Type:
array
Title:
Project Costing Flexfields for Distributions
The Project Costing Flexfields for Distributions resource manages project details about purchase order distributions.
Show Source
Nested Schema : purchaseOrders-lines-schedules-distributions-DFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Prompt
Maximum Length:30
Descriptive flexfield context name for purchase order distributions. -
__FLEX_Context_DisplayValue: string
Title:
Context Prompt
Descriptive flexfield context display value for purchase order distributions. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PoDistributionId: integer
(int64)
Value that uniquely identifies the purchase order distribution.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : purchaseOrders-lines-schedules-distributions-globalDFFs-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
Global descriptive flexfield context name for US federal attributes in a purchase order distribution. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Global descriptive flexfield context display value for US federal attributes in a purchase order distribution. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PoDistributionId: integer
(int64)
Value that uniquely identifies the purchase order distribution.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : purchaseOrders-lines-schedules-distributions-projectDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:40
Project costing descriptive flexfield context name for purchase order distributions. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Project costing descriptive flexfield context display value for purchase order distributions. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PoDistributionId: integer
(int64)
Value that uniquely identifies the purchase order distribution.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source