GET lifecycle details for all requisitions not supported
get
/fscmRestApi/resources/11.13.18.05/requisitionLifecycleDetails
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 requisition lifecycle details according to the primary key.
Finder Variables- RequisitionHeaderId; integer; Value that uniquely identifies the requisition.
- PrimaryKey Finds requisition lifecycle details according to the primary key.
-
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:- RequisitionHeaderId; integer; Value that uniquely identifies the requisition.
-
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 : requisitionLifecycleDetails
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 : requisitionLifecycleDetails-item-response
Type:
Show Source
object
-
Description: string
Maximum Length:
240
Description of the requisition. -
invoices: array
Invoices
Title:
Invoices
The invoices details, if any, that are associated with lines in the purchase order. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
negotiations: array
Negotiations
Title:
Negotiations
The Negotiations resource retrieves the details of the negotiations, if any, that are associated with lines in the requisition. -
orderSummaryAttributes: array
Summary Attributes for Orders
Title:
Summary Attributes for Orders
The Summary Attributes for Orders resource retrieves the aggregated summary details of all purchase orders associated with a requisition. The summary details include the ordered, in transit, in receiving, delivered, and invoiced amounts that help you track the fulfillment of your request. -
Preparer: string
Title:
Name
Read Only:true
Maximum Length:240
Name of the user who owns the requisition. This user creates the requisition but can transfer ownership to another user. -
PreparerId: integer
(int64)
Value that uniquely identifies the user who created the requisition.
-
purchaseOrderHistoryDetails: array
Purchase Order History Details
Title:
Purchase Order History Details
Detailed history of all actions such as submit purchase order or submit purchase order change taken on a purchase order. -
receipts: array
Receipts
Title:
Receipts
The receipts details, if any, that are associated with purchase order schedules. -
Requisition: string
Title:
Requisition
Maximum Length:64
Number that identifies the requisition. -
RequisitionHeaderId: integer
(int64)
Value that uniquely identifies the requisition.
-
requisitionHistoryDetails: array
Requisition History Details
Title:
Requisition History Details
The detailed history of all actions such as submit or cancel taken on a requisition. -
RequisitioningBU: string
Title:
Business Unit
Read Only:true
Maximum Length:240
Name of the business unit that raised the requisition for goods and services. -
RequisitioningBUId: integer
(int64)
Value that uniquely identifies the business unit that raised the requisition for goods and services.
-
requisitionLines: array
Requisition Lines
Title:
Requisition Lines
The Requisition Lines resource retrieves the approved requisition lines that are sourced externally along with the details of the purchase order schedules associated with the requisition lines. This resource helps you track the quantity ordered, shipped, received, delivered, and invoiced for each purchase order schedule. -
shipments: array
Shipments
Title:
Shipments
The Shipments resource retrieves the details of the shipments, if any, that are associated with purchase order schedules. -
transferOrderHistoryDetails: array
Transfer Order History Details
Title:
Transfer Order History Details
The detailed history of all actions taken on a transfer order such as create or cancel.
Nested Schema : Invoices
Type:
array
Title:
Invoices
The invoices details, if any, that are associated with lines in the purchase order.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Negotiations
Type:
array
Title:
Negotiations
The Negotiations resource retrieves the details of the negotiations, if any, that are associated with lines in the requisition.
Show Source
Nested Schema : Summary Attributes for Orders
Type:
array
Title:
Summary Attributes for Orders
The Summary Attributes for Orders resource retrieves the aggregated summary details of all purchase orders associated with a requisition. The summary details include the ordered, in transit, in receiving, delivered, and invoiced amounts that help you track the fulfillment of your request.
Show Source
Nested Schema : Purchase Order History Details
Type:
array
Title:
Purchase Order History Details
Detailed history of all actions such as submit purchase order or submit purchase order change taken on a purchase order.
Show Source
Nested Schema : Receipts
Type:
array
Title:
Receipts
The receipts details, if any, that are associated with purchase order schedules.
Show Source
Nested Schema : Requisition History Details
Type:
array
Title:
Requisition History Details
The detailed history of all actions such as submit or cancel taken on a requisition.
Show Source
Nested Schema : Requisition Lines
Type:
array
Title:
Requisition Lines
The Requisition Lines resource retrieves the approved requisition lines that are sourced externally along with the details of the purchase order schedules associated with the requisition lines. This resource helps you track the quantity ordered, shipped, received, delivered, and invoiced for each purchase order schedule.
Show Source
Nested Schema : Shipments
Type:
array
Title:
Shipments
The Shipments resource retrieves the details of the shipments, if any, that are associated with purchase order schedules.
Show Source
Nested Schema : Transfer Order History Details
Type:
array
Title:
Transfer Order History Details
The detailed history of all actions taken on a transfer order such as create or cancel.
Show Source
Nested Schema : requisitionLifecycleDetails-invoices-item-response
Type:
Show Source
object
-
CurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the requisition line currency. -
HoldReason: string
Read Only:
true
Maximum Length:100
Reason for the invoice hold. -
InvoicedDate: string
(date)
Read Only:
true
Date on which the goods or services are invoiced. -
InvoiceHeaderId: integer
Read Only:
true
Value that uniquely identifies the invoice. -
InvoiceNumber: string
Read Only:
true
Maximum Length:255
Number that identifies the invoice. -
InvoiceStatus: string
Read Only:
true
Maximum Length:4000
Status of the invoice. -
LineDescription: string
Read Only:
true
Maximum Length:240
Description of the goods or services being purchased. -
LineType: string
Read Only:
true
Maximum Length:25
Line type of the purchase order schedule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MatchedAmount: number
Read Only:
true
Invoiced amount matched against the purchase order schedule. -
MatchedQuantity: number
Read Only:
true
Invoiced quantity matched against the purchase order schedule. -
POHeaderId: integer
Read Only:
true
Value that uniquely identifies the purchase order. -
POLineNumber: integer
Read Only:
true
Number that uniquely identifies the purchase order line. -
POScheduleId: integer
Read Only:
true
Value that uniquely identifies the purchase schedule. -
ReceiptHeaderId: integer
Read Only:
true
Value that uniquely identifies the receipt. -
ReceiptNumber: string
Read Only:
true
Maximum Length:30
Number that uniquely identifies the receipt. -
RequisitionLineId: integer
Read Only:
true
Value that uniquely identifies the requisition line. -
RequisitionLineNumber: integer
Read Only:
true
Number that uniquely identifies the requisition line. -
ScheduleNumber: integer
Read Only:
true
Number that uniquely identifies the purchase order schedule for the purchase order line. -
TotalInvoiceAmount: number
Read Only:
true
Total invoiced amount against the purchase order schedules. -
UOM: string
Read Only:
true
Maximum Length:25
Unit of measure for the item quantity.
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 : requisitionLifecycleDetails-negotiations-item-response
Type:
Show Source
object
-
Buyer: string
Title:
Name
Read Only:true
Maximum Length:240
Name of the person who created the negotiation. -
CloseDate: string
(date-time)
Title:
Close Date
Read Only:true
Date when the negotiation stops accepting replies from suppliers. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Negotiation: string
Maximum Length:
40
Number that identifies the negotiation. -
NegotiationHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the negotiation associated with the requisition line. -
NegotiationStyle: string
Read Only:
true
Maximum Length:80
Name of the negotiation style. -
OpenDate: string
(date-time)
Title:
Open Date
Read Only:true
Date when the negotiation starts accepting replies from suppliers. -
POHeaderId: integer
(int64)
Value that uniquely identifies the purchase order associated with the requisition line.
-
ProcurementBU: string
Title:
Organization
Read Only:true
Maximum Length:240
Name of the procurement business unit that owns the negotiation. -
RequisitionLineDescription: string
Maximum Length:
240
Description of the requisition line. -
RequisitionLineId: integer
(int64)
Value that uniquely identifies the requisition line.
-
RequisitionLineNumber: number
Line number of the requisition line.
-
Status: string
Read Only:
true
Maximum Length:255
Status of the negotiation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : requisitionLifecycleDetails-orderSummaryAttributes-item-response
Type:
Show Source
object
-
CurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the purchase order currency. -
DeliveredAmount: number
Read Only:
true
Value of the goods and services delivered to the buying organization. -
FunctionalCurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the currency of the sold-to legal entity. -
FunctionalOrderedAmount: number
Read Only:
true
Value of the order in the currency of the sold-to legal entity. -
HasOnlyAmountBasedLinesFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether all the lines are services billed by amount. If true, then all the lines are services billed by amount. If false, then all the lines aren't services billed by amount. -
InReceivingAmount: number
Read Only:
true
Value of the goods received by the buying organization, currently in receiving, not delivered or returned. -
InTransitAmount: number
Read Only:
true
Value of goods shipped by the supplier but yet to be received at the buying organization. -
InvoicedAmount: number
Read Only:
true
Amount equivalent of the matched invoice lines based on the purchase price. -
InvoiceUnpaidAmount: number
Read Only:
true
Unpaid amount of the invoice. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OpenDate: string
(date)
Read Only:
true
Date when the purchase order is open for execution. -
OrderedAmount: number
Read Only:
true
Value of the order in the purchase order currency. -
PartiallyPaidInvoiceAmount: number
Read Only:
true
Partially paid amount of the invoice. -
POHeaderId: number
Read Only:
true
Value that uniquely identifies the purchase order. -
ProcessingStatusCode: string
Read Only:
true
Maximum Length:11
Abbreviation that identifies whether requisition lines are processed in an open purchase order. Valid values are PROCESSED and UNPROCESSED. -
PurchaseOrder: string
Read Only:
true
Maximum Length:30
Number that uniquely identifies the purchase order in the sold-to legal entity. - relatedDocuments: array Related Documents of a Purchase Order
-
RequisitionHeaderId: number
Read Only:
true
Value that uniquely identifies the requisition. -
Supplier: string
Read Only:
true
Maximum Length:360
Supplier who fulfills the purchase order.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : requisitionLifecycleDetails-purchaseOrderHistoryDetails-item-response
Type:
Show Source
object
-
Action: string
Title:
Meaning
Read Only:true
Maximum Length:80
Name of the action performed on a document. -
ActionCode: string
Maximum Length:
25
Abbreviation that identifies the action performed on a document. -
ActionDate: string
(date-time)
Read Only:
true
Date and time when the action is executed. -
AdditionalInformation: string
Additional information related to the approval or control action.
-
ChangeOrderNumber: string
Title:
Change Order
Read Only:true
Maximum Length:80
Number that uniquely identifies the change order for a document. -
ChangeOrderSequenceNumber: integer
Title:
Change Order
Read Only:true
Number that uniquely identifies the change order for a document. -
DocumentNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the document. -
DocumentType: string
Maximum Length:
25
Abbreviation that identifies the document type. -
IdentificationKey: string
Maximum Length:
80
Identification key for approval actions. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectId: integer
(int64)
Value that uniquely identifies a requisition or purchase order.
-
PerformedBy: string
Title:
Name
Read Only:true
Maximum Length:240
Display name of the person taking the action. -
PerformedById: integer
(int64)
Unique identifier of the person taking the action.
-
purchaseOrderApprovalHistoryDetails: array
Purchase Order Approval History Details
Title:
Purchase Order Approval History Details
The detailed history of all actions such as approve or reject taken on a purchase order. -
RequisitionHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the requisition. -
SequenceNumber: integer
(int64)
Sequence of the approval or control action for a document.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Purchase Order Approval History Details
Type:
array
Title:
Purchase Order Approval History Details
The detailed history of all actions such as approve or reject taken on a purchase order.
Show Source
Nested Schema : requisitionLifecycleDetails-purchaseOrderHistoryDetails-purchaseOrderApprovalHistoryDetails-item-response
Type:
Show Source
object
-
Action: string
Title:
Meaning
Read Only:true
Maximum Length:80
Name of the action performed on a document. -
ActionCode: string
Maximum Length:
25
Abbreviation that identifies the approval action performed on a document. -
ActionDate: string
(date-time)
Read Only:
true
Date and time when the action is executed. -
AdditionalInformation: string
Additional information related to the approval or control action.
-
approvalTaskComments: array
Approval Task Comments
Title:
Approval Task Comments
The comments entered by the approver, if any, while approving or rejecting an approval task. -
ChangeOrderNumber: string
Title:
Change Order
Read Only:true
Maximum Length:80
Number that uniquely identifies the change order for a document. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PerformedBy: string
Display name of the person taking the action.
-
PerformedById: integer
Unique identifier of the person taking the action.
-
SequenceNumber: integer
(int64)
Sequence of the approval or control action for a document.
Nested Schema : Approval Task Comments
Type:
array
Title:
Approval Task Comments
The comments entered by the approver, if any, while approving or rejecting an approval task.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : requisitionLifecycleDetails-purchaseOrderHistoryDetails-purchaseOrderApprovalHistoryDetails-approvalTaskComments-item-response
Type:
Show Source
object
-
CommentDate: string
(date-time)
Read Only:
true
Date on which the user who performed the approval action entered the comment. -
IdentificationKey: string
Read Only:
true
Maximum Length:80
Identification key for comments from action history. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectId: integer
(int64)
Read Only:
true
Value that uniquely identifies a requisition or purchase order. -
ObjectTypeCode: string
Read Only:
true
Maximum Length:25
Abbreviation that identifies the document type. -
PerformedById: integer
(int64)
Read Only:
true
Unique identifier of the person entering the comment. -
SequenceNumber: integer
(int32)
Read Only:
true
Sequence of the comment entered for a task. -
UserComment: string
Read Only:
true
Comments entered by the user who performed the approval action.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : requisitionLifecycleDetails-receipts-item-response
Type:
Show Source
object
-
AmountDelivered: number
Read Only:
true
Amount for the services that are delivered against the purchase order schedule. -
AmountReceived: number
Read Only:
true
Amount for the services that are received against the purchase order schedule. -
CurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the requisition line currency. -
DeliveredQuantity: number
Read Only:
true
Quantity delivered against the purchase order schedule. -
Invoiced: number
Read Only:
true
Amount or quantity invoiced for the services or goods against the purchase order schedule. -
LineDescription: string
Read Only:
true
Maximum Length:240
Description of the goods or services being purchased. -
LineType: string
Read Only:
true
Maximum Length:25
Line type of the purchase order schedule. Value can be Fixed Price or Quantity. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Notes: string
Read Only:
true
Maximum Length:4000
Notes entered by the receiver in the receipt. -
POHeaderId: number
Read Only:
true
Value that uniquely identifies the purchase order. -
POLineId: number
Read Only:
true
Value that uniquely identifies the purchase order line. -
POLineNumber: number
Read Only:
true
Number that uniquely identifies the purchase order line. -
POScheduleId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order schedule. -
Receipt: string
Read Only:
true
Maximum Length:30
Number that uniquely identifies the receipt. -
ReceiptDate: string
(date)
Read Only:
true
Date on which the goods or services are received or delivered. -
ReceiptHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the receipt. -
ReceivedBy: string
Read Only:
true
Maximum Length:240
Name the person who receives the goods. -
ReceivedQuantity: number
Read Only:
true
Quantity received against the purchase order schedule. -
RequisitionHeaderId: number
Read Only:
true
Value that uniquely identifies the requisition. -
RequisitionLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the requisition line. -
RequisitionLineNumber: number
Read Only:
true
Number that uniquely identifies the requisition line. -
ReturnedQuantity: number
Read Only:
true
Quantity returned against the purchase order schedule. -
ScheduleNumber: number
Read Only:
true
Number that uniquely identifies the purchase order schedule for the purchase order line. -
TotalInvoice: number
Read Only:
true
Total invoice amount or quantity against the purchase order schedule. -
UOM: string
Read Only:
true
Maximum Length:25
Unit of measure for the item quantity.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : requisitionLifecycleDetails-requisitionHistoryDetails-item-response
Type:
Show Source
object
-
Action: string
Title:
Meaning
Read Only:true
Maximum Length:80
Name of the action performed on a document. -
ActionCode: string
Maximum Length:
25
Abbreviation that identifies the action performed on a document. -
ActionDate: string
(date-time)
Read Only:
true
Date and time when the action is executed. -
AdditionalInformation: string
Maximum Length:
4000
Additional information related to the approval or control action. -
approvalHistoryDetails: array
Requisition Approval History Details
Title:
Requisition Approval History Details
The detailed history of all actions such as approve or reject taken on a requisition. -
DocumentNumber: string
Read Only:
true
Maximum Length:64
Number that identifies the document. -
DocumentType: string
Maximum Length:
25
Abbreviation that identifies the document type. -
IdentificationKey: string
Read Only:
true
Maximum Length:80
Identification key for approval actions. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectId: integer
(int64)
Value that uniquely identifies a requisition or purchase order.
-
PerformedBy: string
Title:
Name
Read Only:true
Maximum Length:240
Display name of the person taking the action. -
PerformedById: integer
(int64)
Unique identifier of the person taking the action.
-
RequisitionHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the requisition. -
SequenceNumber: integer
(int64)
Sequence of the approval or control action for a document.
Nested Schema : Requisition Approval History Details
Type:
array
Title:
Requisition Approval History Details
The detailed history of all actions such as approve or reject taken on a requisition.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : requisitionLifecycleDetails-requisitionHistoryDetails-approvalHistoryDetails-item-response
Type:
Show Source
object
-
Action: string
Title:
Meaning
Read Only:true
Maximum Length:80
Name of the action performed on a document. -
ActionCode: string
Maximum Length:
25
Abbreviation that identifies the approval action performed on a document. -
ActionDate: string
(date-time)
Read Only:
true
Date and time when the action is executed. -
AdditionalInformation: string
Maximum Length:
4000
Additional information related to the approval or control action. -
approvalTaskComments: array
Approval Task Comments
Title:
Approval Task Comments
The comments entered by the approver, if any, while approving or rejecting an approval task. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PerformedBy: string
Title:
Name
Read Only:true
Maximum Length:240
Display name of the person taking the action. -
PerformedById: integer
(int64)
Unique identifier of the person taking the action.
-
SequenceNumber: integer
(int64)
Sequence of the approval or control action for a document.
Nested Schema : Approval Task Comments
Type:
array
Title:
Approval Task Comments
The comments entered by the approver, if any, while approving or rejecting an approval task.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : requisitionLifecycleDetails-requisitionHistoryDetails-approvalHistoryDetails-approvalTaskComments-item-response
Type:
Show Source
object
-
CommentDate: string
(date-time)
Read Only:
true
Date on which the user who performed the approval action entered the comment. -
IdentificationKey: string
Read Only:
true
Maximum Length:80
Identification key for comments from action history. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectId: integer
(int64)
Read Only:
true
Value that uniquely identifies a requisition or purchase order. -
ObjectTypeCode: string
Read Only:
true
Maximum Length:25
Abbreviation that identifies the document type. -
PerformedById: integer
(int64)
Read Only:
true
Unique identifier of the person entering the comment. -
SequenceNumber: integer
(int32)
Read Only:
true
Sequence of the comment entered for a task. -
UserComment: string
Read Only:
true
Comments entered by the user who performed the approval action.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : requisitionLifecycleDetails-requisitionLines-item-response
Type:
Show Source
object
-
Amount: number
Read Only:
true
Amount of the requested service in the transactional currency. -
AmountDelivered: number
Read Only:
true
Amount delivered against the purchase order schedule for service lines. -
AnticipatedDeliveryDate: string
(date)
Read Only:
true
Date on which the goods are anticipated to be delivered. -
CurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the requisition line currency. -
DeliveredQuantity: number
Read Only:
true
Quantity delivered against the purchase order schedule. -
InvoicedAmount: number
Read Only:
true
Amount equivalent of the matched invoice lines based on the purchase price. -
LineDescription: string
Read Only:
true
Maximum Length:240
Description of the goods or services being purchased. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
POHeaderId: number
Read Only:
true
Value that uniquely identifies the purchase order. -
POLineId: number
Read Only:
true
Value that uniquely identifies the purchase order line. -
POLineNumber: number
Read Only:
true
Number that uniquely identifies the purchase order line. -
POScheduleId: number
Read Only:
true
Value that uniquely identifies the purchase order schedule. -
PromisedDeliveryDate: string
(date)
Read Only:
true
Date when the supplier promises to deliver the item to the buyer. -
Quantity: number
Read Only:
true
Quantity of the goods being purchased. -
ReceivedQuantity: number
Read Only:
true
Quantity received against the purchase order schedule. -
RequestedDeliveryDate: string
(date)
Read Only:
true
Date when the buyer requests that the supplier deliver the item. -
RequisitionHeaderId: integer
Read Only:
true
Value that uniquely identifies the requisition. -
RequisitionLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the requisition line. -
RequisitionLineNumber: number
Read Only:
true
Number that uniquely identifies the requisition line. -
ScheduleAmount: number
Read Only:
true
Amount for the service on the purchase order schedule. -
ScheduleAmountCancelled: number
Read Only:
true
Amount canceled for service lines. -
ScheduleCurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the purchase order currency. -
ScheduleNumber: number
Read Only:
true
Number that uniquely identifies the purchase order schedule for the purchase order line. -
SchedulePrice: number
Read Only:
true
Price of the purchase order line. -
ScheduleQuantity: number
Read Only:
true
Quantity of the item scheduled to be shipped or delivered. -
ScheduleQuantityCancelled: number
Read Only:
true
Quantity that was canceled. -
ScheduleUOM: string
Read Only:
true
Maximum Length:25
Unit of measure for the item quantity. -
ScheduleValueBasis: string
Read Only:
true
Maximum Length:25
Value basis of the schedule. -
ShippedQuantity: number
Read Only:
true
Quantity shipped against the purchase order schedule. -
UnitPrice: number
Read Only:
true
Price of the requested item in the transactional currency. -
UOM: string
Read Only:
true
Maximum Length:25
Unit of measure for the item quantity.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : requisitionLifecycleDetails-shipments-item-response
Type:
Show Source
object
-
Carrier: string
Read Only:
true
Maximum Length:360
Name of the shipping method. -
DeliveredDate: string
(date)
Read Only:
true
Date on which item or goods are delivered. -
LineDescription: string
Read Only:
true
Maximum Length:240
Goods or services being purchased. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
POHeaderId: integer
Read Only:
true
Value that uniquely identifies the purchase order. -
POLineNumber: integer
Read Only:
true
Purchase Order Line number that uniquely identifies the purchase order line. -
QuantityShipped: number
Read Only:
true
Quantity shipped against the shipment header. -
RequisitionLineId: integer
Read Only:
true
Value that uniquely identifies the requisition line. -
RequisitionLineNumber: integer
Read Only:
true
Number that uniquely identifies the requisition line. -
ScheduleNumber: integer
Read Only:
true
Number that uniquely identifies the purchase order schedule for the purchase order line. -
ShipmentHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the shipment header. -
ShipmentLineId: integer
Read Only:
true
Value that uniquely identifies the shipment line. -
ShipmentNumber: string
Read Only:
true
Maximum Length:30
Number that uniquely identifies the shipment header. -
ShipmentTrackingURL: string
Read Only:
true
URL to track the shipment. -
ShippedDate: string
(date)
Read Only:
true
Date on which goods are shipped. -
Tracking: string
Read Only:
true
Maximum Length:20
Alphanumeric value used for tracking a waybill. -
UOM: string
Read Only:
true
Maximum Length:25
Unit of measure for the item quantity.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : requisitionLifecycleDetails-transferOrderHistoryDetails-item-response
Type:
Show Source
object
-
ActionCode: string
Maximum Length:
25
Abbreviation that identifies the action performed on a document. -
ActionDate: string
(date-time)
Read Only:
true
Date and time when the action is executed. -
AdditionalInformation: string
Maximum Length:
4000
Additional information related to the approval or control action. -
DocumentNumber: string
Read Only:
true
Maximum Length:50
Number that identifies the document. -
DocumentType: string
Maximum Length:
25
Abbreviation that identifies the document type. -
IdentificationKey: string
Maximum Length:
80
Identification key for approval actions. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectId: integer
(int64)
Value that uniquely identifies a requisition or purchase order.
-
PerformedBy: string
Title:
Name
Read Only:true
Maximum Length:240
Display name of the person taking the action. -
PerformedById: integer
(int64)
Unique identifier of the person taking the action.
-
RequisitionHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the requisition. -
SequenceNumber: integer
(int64)
Sequence of the approval or control action for a document.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source