Get one purchase order changes
get
/fscmRestApi/resources/11.13.18.05/purchasingDocumentChanges/{VersionId}
Request
Path Parameters
-
VersionId(required): integer
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> -
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: string
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: string
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 : purchasingDocumentChanges-item-response
Type:
Show Source
object-
attachments: array
Purchasing Document Header Attachments Changes
Title:
Purchasing Document Header Attachments ChangesManagement of changes to purchase order header attachments on an approved version for comparison. -
ChangeOrderDescription: string
Title:
Change Order DescriptionMaximum Length:255Description of the changes made. -
ChangeOrderNumber: string
Title:
Change OrderMaximum Length:255Number that uniquely identifies the change order for a document. -
ChangeOrderSequence: integer
Title:
Change Order SequenceThe sequence number for each change order. This is internally generated (start with 0) and increment by 1 for each new change order created for the document. -
ChangeType: string
Maximum Length:
255Value that indicates whether the change order is internal or external. -
compareHeaders: array
Purchasing Document Header Changes
Title:
Purchasing Document Header ChangesManagement of changes to purchase order header on an approved version for comparison. -
compareLines: array
Purchasing Document Line Changes
Title:
Purchasing Document Line ChangesManagement of changes to purchase order lines on an approved version for comparison. -
comparePODistributions: array
Purchase Order Distribution Changes
Title:
Purchase Order Distribution ChangesManagement of changes to purchase order distributions on an approved version for comparison. -
comparePOSchedules: array
Purchase Order Schedule Changes
Title:
Purchase Order Schedule ChangesManagement of changes to purchase order schedules on an approved version for comparison. -
CreationDate: string
(date-time)
Title:
Creation DateDate and time when the supplier created the change order. -
CurrencyCode: string
Maximum Length:
255Abbreviation that identifies the currency of the purchase order. -
distributions: array
Purchase Order Distributions
Title:
Purchase Order DistributionsManagement of changes on an approved version of a purchase order distribution. -
DocumentStyle: string
Title:
Document StyleMaximum Length:255Name of the purchasing document style. This attribute allows organizations to control the parameters and values displayed on the application to match the usage of the purchasing document. -
InitiatingParty: string
Title:
Initiating PartyMaximum Length:255Party where the purchase document change request originated. Valid values are requester, buyer, or supplier. -
Initiator: string
Title:
InitiatorMaximum Length:255User who requested changes to the purchase order. -
lineAttachments: array
Purchasing Document Line Attachment Changes
Title:
Purchasing Document Line Attachment ChangesManagement of changes on an approved version of a purchase order line attachments. -
lines: array
Purchasing Document Lines
Title:
Purchasing Document LinesManagement of changes on an approved version of a purchase order lines. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrderNumber: string
Maximum Length:
255Number that uniquely identifies the purchase order in the sold-to legal entity. -
POHeaderId: integer
Title:
Header IDValue that uniquely identifies the purchase order. -
scheduleAttachments: array
Purchase Order Schedule Attachment Changes
Title:
Purchase Order Schedule Attachment ChangesManagement of changes on an approved version of a purchase order schedule attachments. -
schedules: array
Purchase Order Schedules
Title:
Purchase Order SchedulesManagement of changes on an approved version of a purchase order schedules. -
Status: string
Title:
StatusMaximum Length:255Status of the change order relative to the change order life cycle. -
VersionId: integer
Title:
Version IDValue that uniquely identifies the purchase order changes. This is a primary key of the purchasing document changes view object.
Nested Schema : Purchasing Document Header Attachments Changes
Type:
arrayTitle:
Purchasing Document Header Attachments ChangesManagement of changes to purchase order header attachments on an approved version for comparison.
Show Source
Nested Schema : Purchasing Document Header Changes
Type:
arrayTitle:
Purchasing Document Header ChangesManagement of changes to purchase order header on an approved version for comparison.
Show Source
Nested Schema : Purchasing Document Line Changes
Type:
arrayTitle:
Purchasing Document Line ChangesManagement of changes to purchase order lines on an approved version for comparison.
Show Source
Nested Schema : Purchase Order Distribution Changes
Type:
arrayTitle:
Purchase Order Distribution ChangesManagement of changes to purchase order distributions on an approved version for comparison.
Show Source
Nested Schema : Purchase Order Schedule Changes
Type:
arrayTitle:
Purchase Order Schedule ChangesManagement of changes to purchase order schedules on an approved version for comparison.
Show Source
Nested Schema : Purchase Order Distributions
Type:
arrayTitle:
Purchase Order DistributionsManagement of changes on an approved version of a purchase order distribution.
Show Source
Nested Schema : Purchasing Document Line Attachment Changes
Type:
arrayTitle:
Purchasing Document Line Attachment ChangesManagement of changes on an approved version of a purchase order line attachments.
Show Source
Nested Schema : Purchasing Document Lines
Type:
arrayTitle:
Purchasing Document LinesManagement of changes on an approved version of a purchase order lines.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Purchase Order Schedule Attachment Changes
Type:
arrayTitle:
Purchase Order Schedule Attachment ChangesManagement of changes on an approved version of a purchase order schedule attachments.
Show Source
Nested Schema : Purchase Order Schedules
Type:
arrayTitle:
Purchase Order SchedulesManagement of changes on an approved version of a purchase order schedules.
Show Source
Nested Schema : purchasingDocumentChanges-attachments-item-response
Type:
Show Source
object-
ActionPerformed: string
Title:
Action PerformedMaximum Length:255Status for the action taken on the header attachments of purchase order. -
Category: string
Title:
Category NameMaximum Length:255Value that uniquely identifies the attachment category. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attached document. -
DisplayName: string
Title:
Display NameMaximum Length:255Name of the attached document. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Type: string
Title:
TypeMaximum Length:255Type of attachment on purchasing document. -
VersionId: integer
Title:
Version IDValue that uniquely identifies the purchase order attachment changes. This is a primary key of the purchasing document compare attachments view object.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 : purchasingDocumentChanges-compareHeaders-item-response
Type:
Show Source
object-
Attribute: string
Title:
AttributeMaximum Length:255Description for the list of header attributes. -
ChangedFrom: string
Title:
Changed FromMaximum Length:255Value of the attribute before it was changed on the change order. -
ChangedTo: string
Title:
Changed ToMaximum Length:255Value of the updated attribute being changed on the change order. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
VersionId: integer
Title:
Version IDValue that uniquely identifies the purchase order headers changes. This is a primary key of the purchasing document compare headers view object.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : purchasingDocumentChanges-compareLines-item-response
Type:
Show Source
object-
Attribute: string
Title:
AttributeMaximum Length:255Description for the list of line attributes. -
ChangedFrom: string
Title:
Changed FromMaximum Length:255Value of the attribute before it was changed on the change order. -
ChangedTo: string
Title:
Changed ToMaximum Length:255Value of the updated attribute being changed on the change order. -
LineId: integer
Title:
Line IDValue that uniquely identifies the purchase order line. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
VersionId: integer
Title:
Version IDValue that uniquely identifies the purchase order line changes. This is a primary key of the purchasing document compare lines view object.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : purchasingDocumentChanges-comparePODistributions-item-response
Type:
Show Source
object-
Attribute: string
Title:
AttributeMaximum Length:255Description for the list of distributions attributes. -
ChangedFrom: string
Title:
Changed FromMaximum Length:255Value of the attribute before it was changed on the change order. -
ChangedTo: string
Title:
Changed ToMaximum Length:255Value of the updated attribute being changed on the change order. -
DistributionId: integer
Title:
Distribution IDValue that uniquely identifies the purchase order distribution. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
VersionId: integer
Title:
Version IDValue that uniquely identifies the purchase order distribution changes. This is a primary key of the purchasing document compare distributions view object.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : purchasingDocumentChanges-comparePOSchedules-item-response
Type:
Show Source
object-
Attribute: string
Title:
AttributeMaximum Length:255Description for the list of schedules attributes. -
ChangedFrom: string
Title:
Changed FromMaximum Length:255Value of the attribute before it was changed on the change order. -
ChangedTo: string
Title:
Changed ToMaximum Length:255Value of the updated attribute being changed on the change order. -
LineLocationId: integer
Value that uniquely identifies the purchase order schedule.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
VersionId: integer
(int64)
Title:
Version IDValue that uniquely identifies the purchase order schedule changes. This is a primary key of the purchasing document compare schedules view object.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : purchasingDocumentChanges-distributions-item-response
Type:
Show Source
object-
ActionPerformed: string
Title:
Action PerformedMaximum Length:255Status for the action taken on the distributions of the purchase order. -
AmountChanged: string
Title:
AmountMaximum Length:255Value of the amount change requested on a change order for an order. -
ChangeReason: string
Title:
Change ReasonMaximum Length:255Description for changing the document distribution. -
CurrencyCode: string
Title:
Requisition Accounting CurrencyMaximum Length:255Abbreviation that identifies the currency of the purchase order. -
DeliverToLocation: string
Title:
Deliver to LocationMaximum Length:255Name of the final location that receives the item. -
Description: string
Title:
DescriptionMaximum Length:255Description for the line item referenced to the distribution. -
DistributionId: integer
Title:
Distribution IDValue that uniquely identifies the purchase order distribution. -
DistributionNumber: string
Title:
DistributionMaximum Length:255Number that uniquely identifies the purchase order distribution for the purchase order schedule. -
LineNumber: string
Title:
LineMaximum Length:255Value that uniquely identifies the purchase order line referenced to distribution. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OldDescription: string
Maximum Length:
255Description for the previous line item referenced to the distribution. -
OldDistributionNumber: string
Maximum Length:
255Value that uniquely identifies the previous purchase order distribution. -
OldLineNumber: string
Maximum Length:
255Value that uniquely identifies the previous purchase order line referenced to distribution. -
OldPOChargeAccount: string
Maximum Length:
255Account number previously used to charge for the purchase. -
OldShipmentNumber: string
Maximum Length:
255Value that uniquely identifies the previous purchase order schedule referenced to distribution. -
POChargeAccount: string
Title:
PO Charge AccountMaximum Length:255Account to charge for the purchase. -
ShipmentNumber: string
Title:
ShipmentMaximum Length:255Value that uniquely identifies the purchase order schedule referenced to distribution. -
VersionId: integer
Title:
Version IDValue that uniquely identifies the purchase order distribution changes. This is a primary key of the purchasing document distribution changes view object.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : purchasingDocumentChanges-lineAttachments-item-response
Type:
Show Source
object-
ActionPerformed: string
Title:
Action PerformedMaximum Length:255Status for the action taken on the lines attachments of the purchase order. -
Category: string
Title:
CategoryMaximum Length:255Value that uniquely identifies the attachment category in lines. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attached document in lines. -
DisplayName: string
Title:
Display NameMaximum Length:255Name of the attached document in lines. -
LineId: integer
Title:
Line IDValue that uniquely identifies the purchase order line. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Type: string
Title:
TypeMaximum Length:255Type of attachment in lines. -
VersionId: integer
Title:
Version IDValue that uniquely identifies the purchase order line attachment changes. This is a primary key of the purchasing document line attachments view object.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : purchasingDocumentChanges-lines-item-response
Type:
Show Source
object-
ActionPerformed: string
Title:
Action PerformedMaximum Length:255Status for the action taken on the lines of the purchase order. -
AmountChanged: integer
(int64)
Title:
Amount ChangedValue of the amount change requested on a change order for an order. -
AmountChangedCurrencyCode: string
Title:
Requisition CurrencyMaximum Length:255Abbreviation that identifies the currency of the purchase order. -
Category: string
Title:
CategoryMaximum Length:255Value that uniquely identifies the purchasing category. -
ChangeReason: string
Title:
Change ReasonMaximum Length:255Description for changing the document line. -
CurrencyCode: string
Title:
Requisition CurrencyMaximum Length:255Abbreviation that identifies the currency of the purchase order. -
Description: string
Title:
DescriptionMaximum Length:255Description for the line item. -
ItemNumber: string
Title:
ItemMaximum Length:255Abbreviation that uniquely identifies the item on the purchase order. -
LineId: integer
Title:
Line IDValue that uniquely identifies the purchase order line. -
LineNumber: string
Title:
LineMaximum Length:255Value that uniquely identifies purchase order line. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OldDescription: string
Title:
DescriptionMaximum Length:255Description for previous line item. -
OldItemNumber: string
Title:
ItemMaximum Length:255Abbreviation that uniquely identifies previous item on the purchase order. -
OldLineNumber: string
Title:
LineMaximum Length:255Value that uniquely identifies previous purchase order line. -
VersionId: integer
Title:
Version IDValue that uniquely identifies the purchase order line changes. This is a primary key of the purchasing document line changes view object. -
WorkOrderNumber: string
Maximum Length:
255Number that uniquely identifies the work order in the factory. -
WorkOrderProduct: string
Maximum Length:
255Name of the finished item that the work order in contract manufacturing creates.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : purchasingDocumentChanges-scheduleAttachments-item-response
Type:
Show Source
object-
ActionPerformed: string
Title:
Action PerformedStatus for the action taken on the schedules attachments of the purchase order. -
Category: string
Title:
CategoryMaximum Length:255Value that uniquely identifies the attachment category in schedules. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attached document in schedules. -
DisplayName: string
Title:
Display NameMaximum Length:255Name of the attached document in schedules. -
LineLocationId: integer
Title:
LocationValue that uniquely identifies the purchase order schedule. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Type: string
Title:
TypeMaximum Length:255Type of attachment in schedules. -
VersionId: integer
Title:
Version IDValue that uniquely identifies the purchase order schedule attachment changes. This is a primary key of the purchasing document schedule attachments view object.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : purchasingDocumentChanges-schedules-item-response
Type:
Show Source
object-
ActionPerformed: string
Title:
Action PerformedMaximum Length:255Status for the action taken on the schedules of the purchase order. -
AmountChanged: string
Title:
Amount ChangedMaximum Length:255Value of the amount change requested on a change order for an order. -
ChangeReason: string
Title:
Change ReasonMaximum Length:255Description for changing the document schedule. -
ChangeStatus: string
Title:
Change StatusMaximum Length:255Indicates what state the schedule in a pending change order is in relating to the entire change order lifecycle. -
CurrencyCode: string
Maximum Length:
255Abbreviation that identifies the currency of the purchase order. -
Description: string
Title:
DescriptionMaximum Length:255Description for the line item referenced to the schedule. -
LineLocationId: integer
Value that uniquely identifies the purchase order schedule.
-
LineNumber: string
Title:
LineMaximum Length:255Value that uniquely identifies purchase order line referenced to schedule. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OldDescription: string
Maximum Length:
255Description for previous line item referenced to the schedule. -
OldLineNumber: string
Maximum Length:
255Value that uniquely identifies the previous purchase order line. -
OldPaymentType: string
Title:
Changed FromMaximum Length:255Indicates the previous type of payment, whether it's based on units of work or a lump sum. -
OldPromisedDeliveryDate: string
(date)
Title:
Original Promised Delivery DateDate when the supplier initially promises to deliver the item to the buyer. -
OldPromisedShipDate: string
(date)
Date when the supplier initially promised to ship the item to the buyer.
-
OldRequestedDeliveryDate: string
(date)
Date when the buyer initially requested that the supplier deliver the item.
-
OldRequestedShipDate: string
(date)
Date when the buyer initially requested the supplier to ship the item.
-
OldShipLocation: string
Maximum Length:
255Name of the previous location where the supplier wanted to ship the item. -
OldShipmentNumber: string
Maximum Length:
255Value that uniquely identifies the previous purchase order schedule referenced to distribution. -
PaymentType: string
Maximum Length:
255Indicates the type of payment, whether it's based on units of work or a lump sum. -
PromisedDeliveryDate: string
(date)
Title:
Promised Delivery DateDate when the supplier promises to deliver the item to the buyer. -
PromisedShipDate: string
(date)
Title:
Promised Ship DateDate when the supplier promises to ship the item to the buyer. -
RequestedDeliveryDate: string
Title:
Requested Delivery DateMaximum Length:255Date when the buyer requested that the supplier deliver the item. -
RequestedShipDate: string
(date)
Title:
Requested Ship DateDate when the buyer requested that the supplier ship the item. -
ShipmentNumber: string
Title:
ShipmentMaximum Length:255Value that uniquely identifies the purchase order schedule referenced to distribution. -
ShipToLocation: string
Title:
Ship-to LocationMaximum Length:255Name of the location where the supplier ships the item. -
VersionId: integer
Title:
Version IDValue that uniquely identifies the purchase order schedule changes. This is a primary key of the purchasing document schedule changes view object.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- attachments
-
Operation: /fscmRestApi/resources/11.13.18.05/purchasingDocumentChanges/{VersionId}/child/attachmentsParameters:
- VersionId:
$request.path.VersionId
Management of changes to purchase order header attachments on an approved version for comparison. - VersionId:
- compareHeaders
-
Operation: /fscmRestApi/resources/11.13.18.05/purchasingDocumentChanges/{VersionId}/child/compareHeadersParameters:
- VersionId:
$request.path.VersionId
Management of changes to purchase order header on an approved version for comparison. - VersionId:
- compareLines
-
Operation: /fscmRestApi/resources/11.13.18.05/purchasingDocumentChanges/{VersionId}/child/compareLinesParameters:
- VersionId:
$request.path.VersionId
Management of changes to purchase order lines on an approved version for comparison. - VersionId:
- comparePODistributions
-
Parameters:
- VersionId:
$request.path.VersionId
Management of changes to purchase order distributions on an approved version for comparison. - VersionId:
- comparePOSchedules
-
Operation: /fscmRestApi/resources/11.13.18.05/purchasingDocumentChanges/{VersionId}/child/comparePOSchedulesParameters:
- VersionId:
$request.path.VersionId
Management of changes to purchase order schedules on an approved version for comparison. - VersionId:
- distributions
-
Operation: /fscmRestApi/resources/11.13.18.05/purchasingDocumentChanges/{VersionId}/child/distributionsParameters:
- VersionId:
$request.path.VersionId
Management of changes on an approved version of a purchase order distribution. - VersionId:
- lineAttachments
-
Operation: /fscmRestApi/resources/11.13.18.05/purchasingDocumentChanges/{VersionId}/child/lineAttachmentsParameters:
- VersionId:
$request.path.VersionId
Management of changes on an approved version of a purchase order line attachments. - VersionId:
- lines
-
Parameters:
- VersionId:
$request.path.VersionId
Management of changes on an approved version of a purchase order lines. - VersionId:
- scheduleAttachments
-
Operation: /fscmRestApi/resources/11.13.18.05/purchasingDocumentChanges/{VersionId}/child/scheduleAttachmentsParameters:
- VersionId:
$request.path.VersionId
Management of changes on an approved version of a purchase order schedule attachments. - VersionId:
- schedules
-
Parameters:
- VersionId:
$request.path.VersionId
Management of changes on an approved version of a purchase order schedules. - VersionId: