Jump to

• Request
• Response

Get one spend approval request

get

/fscmRestApi/resources/11.13.18.05/suppliers/{SupplierId}/child/spendAuthorizationApprovalRequests/{AuthorizationRequestId}

Request

Path Parameters

• AuthorizationRequestId(required): integer(int64)
  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=
• SupplierId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

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

There's no request body for this operation.

Back to 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 : suppliers-spendAuthorizationApprovalRequests-item-response

Type: object

Show Source

• ApprovedByPersonId: integer (int64)
  Value that uniquely identifies the person who last approved the spend authorization request.
• ApprovedByPersonName: string
  Value that uniquely identifies a supplier site third-party payment relationship.
• ApprovedDate: string (date)
  Title: Registration Approval Date

  Date when the spend authorization request was approved.
• AuthorizationRequestId: integer (int64)
  Value that uniquely identifies a supplier spend authorization request.
• CanceledByPersonId: integer (int64)
  Title: Canceled By

  Value that uniquely identifies who canceled the spend authorization request.
• CanceledByPersonName: string
  Title: Canceled By

  Name of the person who canceled the spend authorization request.
• CanceledDate: string (date-time)
  Date when the spend authorization request was canceled.
• CanceledReason: string
  Maximum Length: 2000

  Reason provided by the user for canceling the spend authorization request.
• CurrentFlag: boolean
  Maximum Length: 1

  Indicates whether this request is the current request or if another request was submitted after it.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NegotiationAuctionTitle: string
  Title: Negotiation Title

  Read Only: true

  Maximum Length: 80

  Title of the negotiation or auction associated with the spend authorization request.
• NegotiationDocumentNumber: string
  Title: Negotiation

  Read Only: true

  Maximum Length: 240

  Document number of the negotiation or auction.
• NegotiationOpenBiddingDate: string (date-time)
  Title: Negotiation Open Date

  Read Only: true

  Date when bidding opens for the negotiation.
• ProcurementBU: string
  Title: Procurement BU

  Read Only: true

  Maximum Length: 240

  Name of the procurement business unit associated with the spend authorization request.
• ProcurementBUId: integer (int64)
  Title: Procurement BU

  Value that uniquely identifies the procurement business unit.
• RegistrationApprovedDate: string (date-time)
  Title: Registration Approval Date

  Read Only: true

  Date when the supplier's registration for spend authorization was approved.
• RegistrationRequestNumber: integer (int64)
  Title: Registration Request

  Read Only: true

  Value that uniquely identifies the registration request.
• RejectedByPersonId: integer (int64)
  Title: Rejected By

  Value that uniquely identifies the person who rejected the spend authorization request.
• RejectedByPersonName: string
  Title: Rejected By

  Name of the person who rejected the spend authorization request.
• RejectedDate: string (date)
  Title: Rejected On

  Date when the spend authorization request was rejected.
• RejectReason: string
  Title: Additional Information

  Maximum Length: 2000

  Indicates the reason the spend authorization request was rejected.
• RequestedDate: string (date)
  Title: Request Date

  Date when the spend authorization request was submitted.
• RequesterPersonId: integer (int64)
  Title: Requested By

  Value that uniquely identifies the person who rejected the spend authorization request.
• RequesterPersonName: string
  Title: Requested By

  Name of the person who requested the spend authorization.
• RequestNumber: integer (int64)
  Title: Request

  The spend authorization request number.
• RequestSource: string
  Title: Source

  Read Only: true

  Maximum Length: 80

  The source from which the spend authorization request was raised.
• RequestSourceCode: string
  Title: Source

  Maximum Length: 30

  Abbreviation that identifies the source of the spend authorization request.
• RequestStatus: string
  Title: Approval Status

  Read Only: true

  Maximum Length: 80

  Indicates the status of the spend authorization request.
• RequestStatusCode: string
  Title: Approval Status

  Maximum Length: 30

  Abbreviation that identifies the status of the spend authorization request.
• SpendAuthorizationJustification: string
  Title: Justification

  Maximum Length: 2000

  Comments provided by the user to justify the supplier spend authorization request.

{
    "type":"object",
    "properties":{
        "ApprovedByPersonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the person who last approved the spend authorization request.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ApprovedByPersonName":{
            "type":"string",
            "description":"Value that uniquely identifies a supplier site third-party payment relationship.",
            "nullable":true,
            "x-queryable":false
        },
        "ApprovedDate":{
            "title":"Registration Approval Date",
            "type":"string",
            "description":"Date when the spend authorization request was approved.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "AuthorizationRequestId":{
            "type":"integer",
            "description":"Value that uniquely identifies a supplier spend authorization request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CanceledByPersonId":{
            "title":"Canceled By",
            "type":"integer",
            "description":"Value that uniquely identifies who canceled the spend authorization request.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CanceledByPersonName":{
            "title":"Canceled By",
            "type":"string",
            "description":"Name of the person who canceled the spend authorization request.",
            "nullable":true,
            "x-queryable":false
        },
        "CanceledDate":{
            "type":"string",
            "description":"Date when the spend authorization request was canceled.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "CanceledReason":{
            "maxLength":2000,
            "type":"string",
            "description":"Reason provided by the user for canceling the spend authorization request.",
            "nullable":true,
            "x-queryable":false
        },
        "CurrentFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this request is the current request or if another request was submitted after it.",
            "nullable":false,
            "x-queryable":true
        },
        "NegotiationAuctionTitle":{
            "title":"Negotiation Title",
            "maxLength":80,
            "type":"string",
            "description":"Title of the negotiation or auction associated with the spend authorization request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NegotiationDocumentNumber":{
            "title":"Negotiation",
            "maxLength":240,
            "type":"string",
            "description":"Document number of the negotiation or auction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NegotiationOpenBiddingDate":{
            "title":"Negotiation Open Date",
            "type":"string",
            "description":"Date when bidding opens for the negotiation.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProcurementBU":{
            "title":"Procurement BU",
            "maxLength":240,
            "type":"string",
            "description":"Name of the procurement business unit associated with the spend authorization request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBUId":{
            "title":"Procurement BU",
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RegistrationApprovedDate":{
            "title":"Registration Approval Date",
            "type":"string",
            "description":"Date when the supplier's registration for spend authorization was approved.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RegistrationRequestNumber":{
            "title":"Registration Request",
            "type":"integer",
            "description":"Value that uniquely identifies the registration request.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RejectReason":{
            "title":"Additional Information",
            "maxLength":2000,
            "type":"string",
            "description":"Indicates the reason the spend authorization request was rejected.",
            "nullable":true,
            "x-queryable":false
        },
        "RejectedByPersonId":{
            "title":"Rejected By",
            "type":"integer",
            "description":"Value that uniquely identifies the person who rejected the spend authorization request.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RejectedByPersonName":{
            "title":"Rejected By",
            "type":"string",
            "description":"Name of the person who rejected the spend authorization request.",
            "nullable":true,
            "x-queryable":false
        },
        "RejectedDate":{
            "title":"Rejected On",
            "type":"string",
            "description":"Date when the spend authorization request was rejected.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "RequestNumber":{
            "title":"Request",
            "type":"integer",
            "description":"The spend authorization request number.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RequestSource":{
            "title":"Source",
            "maxLength":80,
            "type":"string",
            "description":"The source from which the spend authorization request was raised.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "RequestSourceCode":{
            "title":"Source",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the source of the spend authorization request.",
            "nullable":true,
            "x-queryable":false
        },
        "RequestStatus":{
            "title":"Approval Status",
            "maxLength":80,
            "type":"string",
            "description":"Indicates the status of the spend authorization request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "RequestStatusCode":{
            "title":"Approval Status",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the status of the spend authorization request.",
            "nullable":true,
            "x-queryable":false
        },
        "RequestedDate":{
            "title":"Request Date",
            "type":"string",
            "description":"Date when the spend authorization request was submitted.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "RequesterPersonId":{
            "title":"Requested By",
            "type":"integer",
            "description":"Value that uniquely identifies the person who rejected the spend authorization request.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RequesterPersonName":{
            "title":"Requested By",
            "type":"string",
            "description":"Name of the person who requested the spend authorization.",
            "nullable":true,
            "x-queryable":false
        },
        "SpendAuthorizationJustification":{
            "title":"Justification",
            "maxLength":2000,
            "type":"string",
            "description":"Comments provided by the user to justify the supplier spend authorization request.",
            "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