Jump to

• Request
• Response

Get all purchase agreements requiring acknowledgment

get

/fscmRestApi/resources/11.13.18.05/purchaseAgreementAcknowledgments

Request

Query Parameters

• effectiveDate: string
  This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
• 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 agreement requiring acknowledgment with the specified primary key.
    Finder Variables
    • AgreementHeaderId; integer; Unique identifier of the purchase agreement 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 agreement.
  • AcknowledgmentWithinDays; number; Number of days the supplier can decide to accept or reject the purchase agreement.
  • AgreementHeaderId; integer; Value that uniquely identifies the purchase agreement.
  • AgreementNumber; string; Number that uniquely identifies the purchase agreement in the procurement business unit.
  • ChangeOrderNumber; string; Number that uniquely identifies the change order for a document.
  • ProcurementBU; string; Business unit that manages and owns the purchase agreement.
  • ProcurementBUId; integer; Value that uniquely identifies the procurement business unit.
  • RequiredAcknowledgment; string; Acknowledgment from the supplier. Possible values include: Document and Line: The supplier must acknowledge both the header and line of the purchase agreement. Document: The supplier must acknowledge the header of the purchase agreement. None: The purchase agreement doesn't require acknowledgment.
  • RequiredAcknowledgmentCode; string; Abbreviation identifying the acknowledgment required from the supplier for the purchase agreement. Values include:Y: Document and Line, D: Document, and N: None.
  • SupplierAgreement; string; Number that indicates the supplier document number.
• 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

• Effective-Of: string
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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 : purchaseAgreementAcknowledgments

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":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/purchaseAgreementAcknowledgments-item-response"
            }
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object purchaseAgreementAcknowledgments-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/purchaseAgreementAcknowledgments-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 : purchaseAgreementAcknowledgments-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 agreement.
• AcknowledgmentNote: string
  Title: Acknowledgment Note

  Maximum Length: 4000

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

  Maximum Length: 25

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

  Read Only: true

  Number of days the supplier can decide to accept or reject the purchase agreement.
• AgreementHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchase agreement.
• AgreementNumber: string
  Title: Agreement

  Read Only: true

  Maximum Length: 30

  Number that uniquely identifies the purchase agreement in the procurement business unit.
• ChangeOrderNumber: string
  Title: Change Order

  Read Only: true

  Maximum Length: 80

  Number that uniquely identifies the change order for a document.
• lines: array Lines
  Title: Lines

  Acknowledgment response at the line level are recorded.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProcurementBU: string
  Title: Procurement BU

  Read Only: true

  Maximum Length: 240

  Business unit that manages and owns the purchase agreement.
• ProcurementBUId: integer (int64)
  Read Only: true

  Value that uniquely identifies the procurement business unit.
• RequiredAcknowledgment: string
  Title: Required Acknowledgment

  Read Only: true

  Maximum Length: 80

  Acknowledgment from the supplier. Possible values include: Document and Line: The supplier must acknowledge both the header and line of the purchase agreement. Document: The supplier must acknowledge the header of the purchase agreement. None: The purchase agreement doesn't require acknowledgment.
• RequiredAcknowledgmentCode: string
  Read Only: true

  Maximum Length: 1

  Abbreviation identifying the acknowledgment required from the supplier for the purchase agreement. Values include:Y: Document and Line, D: Document, and N: None.
• SupplierAgreement: string
  Title: Supplier Agreement

  Maximum Length: 25

  Number that indicates the supplier document number.

{
    "type":"object",
    "properties":{
        "AcknowledgmentDueDate":{
            "title":"Acknowledgment Due Date",
            "type":"string",
            "description":"Date on which the application requests the supplier to acknowledge the purchase agreement.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcknowledgmentNote":{
            "title":"Acknowledgment Note",
            "maxLength":4000,
            "type":"string",
            "description":"Note with details regarding the acknowledgment, required if the agreement is being rejected.",
            "nullable":true,
            "x-queryable":false
        },
        "AcknowledgmentResponse":{
            "title":"Acknowledgment Response",
            "maxLength":25,
            "type":"string",
            "description":"Acknowledgment response for the purchase agreement. Values are ACCEPT when the agreement is accepted or REJECT when the agreement is rejected.",
            "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 agreement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgreementHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase agreement.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AgreementNumber":{
            "title":"Agreement",
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the purchase agreement in the procurement business unit.",
            "nullable":false,
            "readOnly":true,
            "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":true
        },
        "ProcurementBU":{
            "title":"Procurement BU",
            "maxLength":240,
            "type":"string",
            "description":"Business unit that manages and owns the purchase agreement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequiredAcknowledgment":{
            "title":"Required Acknowledgment",
            "maxLength":80,
            "type":"string",
            "description":"Acknowledgment from the supplier. Possible values include: Document and Line: The supplier must acknowledge both the header and line of the purchase agreement. Document: The supplier must acknowledge the header of the purchase agreement. None: The purchase agreement doesn't require acknowledgment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequiredAcknowledgmentCode":{
            "maxLength":1,
            "type":"string",
            "description":"Abbreviation identifying the acknowledgment required from the supplier for the purchase agreement. Values include:Y: Document and Line, D: Document, and N: None.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierAgreement":{
            "title":"Supplier Agreement",
            "maxLength":25,
            "type":"string",
            "description":"Number that indicates the supplier document number.",
            "nullable":true,
            "x-queryable":true
        },
        "lines":{
            "title":"Lines",
            "type":"array",
            "description":"Acknowledgment response at the line level are recorded.",
            "items":{
                "$ref":"#/components/schemas/purchaseAgreementAcknowledgments-lines-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Lines

Type: array

Title: Lines

Acknowledgment response at the line level are recorded.

Show Source

• Array of: object purchaseAgreementAcknowledgments-lines-item-response

{
    "title":"Lines",
    "type":"array",
    "description":"Acknowledgment response at the line level are recorded.",
    "items":{
        "$ref":"#/components/schemas/purchaseAgreementAcknowledgments-lines-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 : purchaseAgreementAcknowledgments-lines-item-response

Type: object

Show Source

• AgreementHeaderId: integer (int64)
  Value that uniquely identifies the purchase agreement.
• AgreementLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchase agreement line.
• LineNumber: number
  Title: Line

  Read Only: true

  Value that uniquely identifies the purchase order or agreement line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RejectionReason: string
  Title: Rejection Reason

  Maximum Length: 240

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

  Maximum Length: 25

  Acknowledgment response for the line. Values include ACCEPT when the line is accepted, or REJECT when the line is rejected.

{
    "type":"object",
    "properties":{
        "AgreementHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase agreement.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AgreementLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase agreement line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Line",
            "type":"number",
            "description":"Value that uniquely identifies the purchase order or agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RejectionReason":{
            "title":"Rejection Reason",
            "maxLength":240,
            "type":"string",
            "description":"Reason for rejecting the line.",
            "nullable":true,
            "x-queryable":true
        },
        "Response":{
            "title":"Response",
            "maxLength":25,
            "type":"string",
            "description":"Acknowledgment response for the line. Values include ACCEPT when the line is accepted, or REJECT when the line is rejected.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : 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."
        }
    }
}

Back to Top