Get one purchase order changes

get

/fscmRestApi/resources/11.13.18.05/purchasingDocumentChanges/{VersionId}

Request

Path Parameters
  • 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
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : purchasingDocumentChanges-item-response
Type: object
Show Source
Nested Schema : Purchasing Document Header Attachments Changes
Type: array
Title: Purchasing Document Header Attachments Changes
Management of changes to purchase order header attachments on an approved version for comparison.
Show Source
Nested Schema : Purchasing Document Header Changes
Type: array
Title: Purchasing Document Header Changes
Management of changes to purchase order header on an approved version for comparison.
Show Source
Nested Schema : Purchasing Document Line Changes
Type: array
Title: Purchasing Document Line Changes
Management of changes to purchase order lines on an approved version for comparison.
Show Source
Nested Schema : Purchase Order Distribution Changes
Type: array
Title: Purchase Order Distribution Changes
Management of changes to purchase order distributions on an approved version for comparison.
Show Source
Nested Schema : Purchase Order Schedule Changes
Type: array
Title: Purchase Order Schedule Changes
Management of changes to purchase order schedules on an approved version for comparison.
Show Source
Nested Schema : Purchase Order Distributions
Type: array
Title: Purchase Order Distributions
Management of changes on an approved version of a purchase order distribution.
Show Source
Nested Schema : Purchasing Document Line Attachment Changes
Type: array
Title: Purchasing Document Line Attachment Changes
Management of changes on an approved version of a purchase order line attachments.
Show Source
Nested Schema : Purchasing Document Lines
Type: array
Title: Purchasing Document Lines
Management of changes on an approved version of a purchase order lines.
Show Source
Nested Schema : Purchase Order Schedule Attachment Changes
Type: array
Title: Purchase Order Schedule Attachment Changes
Management of changes on an approved version of a purchase order schedule attachments.
Show Source
Nested Schema : Purchase Order Schedules
Type: array
Title: Purchase Order Schedules
Management of changes on an approved version of a purchase order schedules.
Show Source
Nested Schema : purchasingDocumentChanges-attachments-item-response
Type: object
Show Source
  • Title: Action Performed
    Maximum Length: 255
    Status for the action taken on the header attachments of purchase order.
  • Title: Category Name
    Maximum Length: 255
    Value that uniquely identifies the attachment category.
  • Title: Description
    Maximum Length: 255
    Description of the attached document.
  • Title: Display Name
    Maximum Length: 255
    Name of the attached document.
  • Links
  • Title: Type
    Maximum Length: 255
    Type of attachment on purchasing document.
  • Title: Version ID
    Value that uniquely identifies the purchase order attachment changes. This is a primary key of the purchasing document compare attachments view object.
Nested Schema : purchasingDocumentChanges-compareHeaders-item-response
Type: object
Show Source
  • Title: Attribute
    Maximum Length: 255
    Description for the list of header attributes.
  • Title: Changed From
    Maximum Length: 255
    Value of the attribute before it was changed on the change order.
  • Title: Changed To
    Maximum Length: 255
    Value of the updated attribute being changed on the change order.
  • Links
  • Title: Version ID
    Value that uniquely identifies the purchase order headers changes. This is a primary key of the purchasing document compare headers view object.
Nested Schema : purchasingDocumentChanges-compareLines-item-response
Type: object
Show Source
  • Title: Attribute
    Maximum Length: 255
    Description for the list of line attributes.
  • Title: Changed From
    Maximum Length: 255
    Value of the attribute before it was changed on the change order.
  • Title: Changed To
    Maximum Length: 255
    Value of the updated attribute being changed on the change order.
  • Title: Line ID
    Value that uniquely identifies the purchase order line.
  • Links
  • Title: Version ID
    Value that uniquely identifies the purchase order line changes. This is a primary key of the purchasing document compare lines view object.
Nested Schema : purchasingDocumentChanges-comparePODistributions-item-response
Type: object
Show Source
  • Title: Attribute
    Maximum Length: 255
    Description for the list of distributions attributes.
  • Title: Changed From
    Maximum Length: 255
    Value of the attribute before it was changed on the change order.
  • Title: Changed To
    Maximum Length: 255
    Value of the updated attribute being changed on the change order.
  • Title: Distribution ID
    Value that uniquely identifies the purchase order distribution.
  • Links
  • Title: Version ID
    Value that uniquely identifies the purchase order distribution changes. This is a primary key of the purchasing document compare distributions view object.
Nested Schema : purchasingDocumentChanges-comparePOSchedules-item-response
Type: object
Show Source
  • Title: Attribute
    Maximum Length: 255
    Description for the list of schedules attributes.
  • Title: Changed From
    Maximum Length: 255
    Value of the attribute before it was changed on the change order.
  • Title: Changed To
    Maximum Length: 255
    Value of the updated attribute being changed on the change order.
  • Value that uniquely identifies the purchase order schedule.
  • Links
  • Title: Version ID
    Value that uniquely identifies the purchase order schedule changes. This is a primary key of the purchasing document compare schedules view object.
Nested Schema : purchasingDocumentChanges-distributions-item-response
Type: object
Show Source
  • Title: Action Performed
    Maximum Length: 255
    Status for the action taken on the distributions of the purchase order.
  • Title: Amount
    Maximum Length: 255
    Value of the amount change requested on a change order for an order.
  • Title: Change Reason
    Maximum Length: 255
    Description for changing the document distribution.
  • Title: Requisition Accounting Currency
    Maximum Length: 255
    Abbreviation that identifies the currency of the purchase order.
  • Title: Deliver to Location
    Maximum Length: 255
    Name of the final location that receives the item.
  • Title: Description
    Maximum Length: 255
    Description for the line item referenced to the distribution.
  • Title: Distribution ID
    Value that uniquely identifies the purchase order distribution.
  • Title: Distribution
    Maximum Length: 255
    Number that uniquely identifies the purchase order distribution for the purchase order schedule.
  • Title: Line
    Maximum Length: 255
    Value that uniquely identifies the purchase order line referenced to distribution.
  • Links
  • Maximum Length: 255
    Description for the previous line item referenced to the distribution.
  • Maximum Length: 255
    Value that uniquely identifies the previous purchase order distribution.
  • Maximum Length: 255
    Value that uniquely identifies the previous purchase order line referenced to distribution.
  • Maximum Length: 255
    Account number previously used to charge for the purchase.
  • Maximum Length: 255
    Value that uniquely identifies the previous purchase order schedule referenced to distribution.
  • Title: PO Charge Account
    Maximum Length: 255
    Account to charge for the purchase.
  • Title: Shipment
    Maximum Length: 255
    Value that uniquely identifies the purchase order schedule referenced to distribution.
  • Title: Version ID
    Value that uniquely identifies the purchase order distribution changes. This is a primary key of the purchasing document distribution changes view object.
Nested Schema : purchasingDocumentChanges-lineAttachments-item-response
Type: object
Show Source
  • Title: Action Performed
    Maximum Length: 255
    Status for the action taken on the lines attachments of the purchase order.
  • Title: Category
    Maximum Length: 255
    Value that uniquely identifies the attachment category in lines.
  • Title: Description
    Maximum Length: 255
    Description of the attached document in lines.
  • Title: Display Name
    Maximum Length: 255
    Name of the attached document in lines.
  • Title: Line ID
    Value that uniquely identifies the purchase order line.
  • Links
  • Title: Type
    Maximum Length: 255
    Type of attachment in lines.
  • Title: Version ID
    Value that uniquely identifies the purchase order line attachment changes. This is a primary key of the purchasing document line attachments view object.
Nested Schema : purchasingDocumentChanges-lines-item-response
Type: object
Show Source
  • Title: Action Performed
    Maximum Length: 255
    Status for the action taken on the lines of the purchase order.
  • Title: Amount Changed
    Value of the amount change requested on a change order for an order.
  • Title: Requisition Currency
    Maximum Length: 255
    Abbreviation that identifies the currency of the purchase order.
  • Title: Category
    Maximum Length: 255
    Value that uniquely identifies the purchasing category.
  • Title: Change Reason
    Maximum Length: 255
    Description for changing the document line.
  • Title: Requisition Currency
    Maximum Length: 255
    Abbreviation that identifies the currency of the purchase order.
  • Title: Description
    Maximum Length: 255
    Description for the line item.
  • Title: Item
    Maximum Length: 255
    Abbreviation that uniquely identifies the item on the purchase order.
  • Title: Line ID
    Value that uniquely identifies the purchase order line.
  • Title: Line
    Maximum Length: 255
    Value that uniquely identifies purchase order line.
  • Links
  • Title: Description
    Maximum Length: 255
    Description for previous line item.
  • Title: Item
    Maximum Length: 255
    Abbreviation that uniquely identifies previous item on the purchase order.
  • Title: Line
    Maximum Length: 255
    Value that uniquely identifies previous purchase order line.
  • Title: Version ID
    Value that uniquely identifies the purchase order line changes. This is a primary key of the purchasing document line changes view object.
  • Maximum Length: 255
    Number that uniquely identifies the work order in the factory.
  • Maximum Length: 255
    Name of the finished item that the work order in contract manufacturing creates.
Nested Schema : purchasingDocumentChanges-scheduleAttachments-item-response
Type: object
Show Source
  • Title: Action Performed
    Status for the action taken on the schedules attachments of the purchase order.
  • Title: Category
    Maximum Length: 255
    Value that uniquely identifies the attachment category in schedules.
  • Title: Description
    Maximum Length: 255
    Description of the attached document in schedules.
  • Title: Display Name
    Maximum Length: 255
    Name of the attached document in schedules.
  • Title: Location
    Value that uniquely identifies the purchase order schedule.
  • Links
  • Title: Type
    Maximum Length: 255
    Type of attachment in schedules.
  • Title: Version ID
    Value that uniquely identifies the purchase order schedule attachment changes. This is a primary key of the purchasing document schedule attachments view object.
Nested Schema : purchasingDocumentChanges-schedules-item-response
Type: object
Show Source
Back to Top