Jump to

• Request
• Response

Get all purchase orders requiring acknowledgment

get

/fscmRestApi/resources/11.13.18.05/purchaseOrderAcknowledgments

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 the purchase order requiring acknowledgment with the specified primary key.
    Finder Variables
    • POHeaderId; integer; Unique identifier of the purchase order requiring acknowledgment.
• 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:
  

  • AcknowledgmentDueDate; string; Date on which the application requests the supplier to acknowledge the purchase order.
  • OrderNumber; string; Number that uniquely identifies the purchase order in the sold-to legal entity.
  • POHeaderId; integer; Value that uniquely identifies the purchase order.
  • SoldToLegalEntity; string; Legal entity that's financially responsible for purchases on the purchase order.
  • SoldToLegalEntityId; integer; Value that uniquely identifies the legal entity that's financially responsible for purchases on the purchase order.
• 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: 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 Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : purchaseOrderAcknowledgments

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/purchaseOrderAcknowledgments-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object purchaseOrderAcknowledgments-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/purchaseOrderAcknowledgments-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : purchaseOrderAcknowledgments-item-response

Type: object

Show Source

• AcknowledgmentDueDate: string (date)
  Title: Acknowledgment Due Date

  Read Only: true

  Date on which the application requests the supplier to acknowledge the purchase order.
• AcknowledgmentNote: string
  Title: Acknowledgment Note

  Maximum Length: 4000

  Note with details regarding the acknowledgment, required if the order is being rejected.
• AcknowledgmentResponse: string
  Title: Acknowledgment Response

  Maximum Length: 1

  Acknowledgment response for the purchase order. Values are ACCEPT when the order is accepted or REJECT when the order is rejected.
• AcknowledgmentWithinDays: number
  Title: Acknowledge Within Days

  Read Only: true

  Number of days the supplier can decide to accept or reject the purchase order.
• 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.
• OrderNumber: string
  Title: Order

  Read Only: true

  Maximum Length: 30

  Number that uniquely identifies the purchase order in the sold-to legal entity.
• POHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchase order.
• RequiredAcknowledgment: string
  Title: Required Acknowledgment

  Read Only: true

  Maximum Length: 80

  The application requires an acknowledgment from the supplier. Possible values include Document and Schedule: The supplier must acknowledge both the header and schedule of the purchase order. Document: Supplier must acknowledge the header of the purchase order. None: Purchase order doesn't require acknowledgment.
• RequiredAcknowledgmentCode: string
  Read Only: true

  Maximum Length: 1

  Abbreviation identifying the acknowledgment required from the supplier for the purchase order. Values include:Y: Document and Schedule, D: Document, and N: None.
• schedules: array Schedules
  Title: Schedules

  Acknowledgment response at the schedule level are recorded.
• SoldToLegalEntity: string
  Title: Sold-to Legal Entity

  Read Only: true

  Maximum Length: 240

  Legal entity that's financially responsible for purchases on the purchase order.
• SoldToLegalEntityId: integer (int64)
  Read Only: true

  Value that uniquely identifies the legal entity that's financially responsible for purchases on the purchase order.
• SupplierOrder: string
  Title: Supplier Order

  Maximum Length: 25

  Number that identifies the document that the supplier created for the purchase order.

{
    "type":"object",
    "properties":{
        "SupplierOrder":{
            "title":"Supplier Order",
            "maxLength":25,
            "type":"string",
            "description":"Number that identifies the document that the supplier created for the purchase order.",
            "nullable":true,
            "x-queryable":false
        },
        "AcknowledgmentWithinDays":{
            "title":"Acknowledge Within Days",
            "type":"number",
            "description":"Number of days the supplier can decide to accept or reject the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SoldToLegalEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the legal entity that's financially responsible for purchases on the purchase order.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrderNumber":{
            "title":"Order",
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the purchase order in the sold-to legal entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SoldToLegalEntity":{
            "title":"Sold-to Legal Entity",
            "maxLength":240,
            "type":"string",
            "description":"Legal entity that's financially responsible for purchases on the purchase order.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AcknowledgmentResponse":{
            "title":"Acknowledgment Response",
            "maxLength":1,
            "type":"string",
            "description":"Acknowledgment response for the purchase order. Values are ACCEPT when the order is accepted or REJECT when the order is rejected.",
            "nullable":true,
            "x-queryable":false
        },
        "AcknowledgmentDueDate":{
            "title":"Acknowledgment Due Date",
            "type":"string",
            "description":"Date on which the application requests the supplier to acknowledge the purchase order.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "POHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChangeOrderNumber":{
            "title":"Change Order",
            "maxLength":80,
            "type":"string",
            "description":"Number that uniquely identifies the change order for a document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RequiredAcknowledgmentCode":{
            "maxLength":1,
            "type":"string",
            "description":"Abbreviation identifying the acknowledgment required from the supplier for the purchase order. Values include:Y: Document and Schedule, D: Document, and N: None.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "schedules":{
            "title":"Schedules",
            "type":"array",
            "description":"Acknowledgment response at the schedule level are recorded.",
            "items":{
                "$ref":"#/components/schemas/purchaseOrderAcknowledgments-schedules-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AcknowledgmentNote":{
            "title":"Acknowledgment Note",
            "maxLength":4000,
            "type":"string",
            "description":"Note with details regarding the acknowledgment, required if the order is being rejected.",
            "nullable":true,
            "x-queryable":false
        },
        "RequiredAcknowledgment":{
            "title":"Required Acknowledgment",
            "maxLength":80,
            "type":"string",
            "description":"The application requires an acknowledgment from the supplier. Possible values include Document and Schedule: The supplier must acknowledge both the header and schedule of the purchase order. Document: Supplier must acknowledge the header of the purchase order. None: Purchase order doesn't require acknowledgment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Schedules

Type: array

Title: Schedules

Acknowledgment response at the schedule level are recorded.

Show Source

• Array of: object purchaseOrderAcknowledgments-schedules-item-response

{
    "title":"Schedules",
    "type":"array",
    "description":"Acknowledgment response at the schedule level are recorded.",
    "items":{
        "$ref":"#/components/schemas/purchaseOrderAcknowledgments-schedules-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : purchaseOrderAcknowledgments-schedules-item-response

Type: object

Show Source

• LineLocationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchase order schedule.
• LineNumber: number
  Title: Line

  Read Only: true

  Number that uniquely identifies the purchase order line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• POHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchase order.
• POLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the parent line of the schedule. This attribute is used when the schedule is split.
• RejectionReason: string
  Title: Rejection Reason

  Maximum Length: 240

  Reason for rejecting the schedule.
• Response: string
  Title: Response

  Maximum Length: 1

  Acknowledgment response for the schedule. Values include ACCEPT when the schedule is accepted or REJECT when the schedule is rejected.
• ScheduleNumber: number
  Title: Schedule

  Read Only: true

  Number that uniquely identifies the purchase order schedule for the purchase order line.
• SupplierOrderLineNumber: string
  Title: Supplier Order Line

  Maximum Length: 25

  Number or text that the supplier uses to identify a purchase order schedule.

{
    "type":"object",
    "properties":{
        "Response":{
            "title":"Response",
            "maxLength":1,
            "type":"string",
            "description":"Acknowledgment response for the schedule. Values include ACCEPT when the schedule is accepted or REJECT when the schedule is rejected.",
            "nullable":true,
            "x-queryable":false
        },
        "ScheduleNumber":{
            "title":"Schedule",
            "type":"number",
            "description":"Number that uniquely identifies the purchase order schedule for the purchase order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "POHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LineLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order schedule.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierOrderLineNumber":{
            "title":"Supplier Order Line",
            "maxLength":25,
            "type":"string",
            "description":"Number or text that the supplier uses to identify a purchase order schedule.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "POLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent line of the schedule. This attribute is used when the schedule is split.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Line",
            "type":"number",
            "description":"Number that uniquely identifies the purchase order line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RejectionReason":{
            "title":"Rejection Reason",
            "maxLength":240,
            "type":"string",
            "description":"Reason for rejecting the schedule.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Back to Top