Get a standing early payment offer
get
/fscmRestApi/resources/11.13.18.05/buyerInitiatedEarlyPaymentOffers/{discountOfferId}
Request
Path Parameters
-
discountOfferId(required): integer(int64)
The unique offer identifier that is generated while creating an offer.
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:
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 : buyerInitiatedEarlyPaymentOffers-item-response
Type:
Show Source
object-
assignments: array
Early Payment Offer Assignments
Title:
Early Payment Offer AssignmentsThe early payment offer assignments resource is used to manage details about supplier assignment to the standing discount offers which includes descriptive flexfields. -
createdBy: string
Read Only:
trueMaximum Length:64The user who created the record. -
creationDate: string
(date-time)
Read Only:
trueThe date when the record was created. -
description: string
Title:
Offer DescriptionMaximum Length:240Description of the early payment offer made to the supplier. -
discountOfferId: integer
(int64)
The unique offer identifier that is generated while creating an offer.
-
discountRate: number
Title:
RateActive discount percent rate for the dynamic discount calculation. -
discountRateUnitCode: string
Maximum Length:
30Default Value:ORA_ANNUALThe type of the offer. The default value is set to Annual. -
discountsTaken: integer
Title:
Discounts TakenRead Only:trueTotal discount taken. -
enabledFlag: boolean
Title:
InitiatedMaximum Length:1Default Value:trueIndicates the record is active and in use. The default value is true. -
endDateActive: string
(date)
Title:
Expiration DateDate at the end of the offer period range. -
enrolledSuppliers: integer
Title:
Enrolled SuppliersRead Only:trueTotal number of suppliers who have enrolled into standing offers. All invoices for these suppliers are eligible for early payment in exchange for a discount. -
lastNotificationDate: string
(date)
Title:
Last Notification DateDate when the early payment offer notification was last sent to the suppliers in the campaign. -
lastUpdateDate: string
(date-time)
Read Only:
trueThe date when the record was last updated. -
lastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the record. -
lastUpdateLogin: string
Read Only:
trueMaximum Length:32The session login associated to the user who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
name: string
Title:
Offer NameMaximum Length:60Name of the early payment offer made to the supplier. -
startDateActive: string
(date)
Title:
Offer Start DateDate at the start of the offer period range. The default value is set to system date. -
totalSuppliers: integer
Title:
Total SuppliersRead Only:trueTotal number of suppliers added to the campaign. Early payment offers are sent via email to all the suppliers in the campaign.
Nested Schema : Early Payment Offer Assignments
Type:
arrayTitle:
Early Payment Offer AssignmentsThe early payment offer assignments resource is used to manage details about supplier assignment to the standing discount offers which includes descriptive flexfields.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : buyerInitiatedEarlyPaymentOffers-assignments-item-response
Type:
Show Source
object-
assignmentDff: array
Early Payment Offers Descriptive Flexfields
Title:
Early Payment Offers Descriptive FlexfieldsThe early payment offers descriptive flexfields resource is used to manage details about the descriptive flexfield references for an assignment. -
assignmentTypeCode: string
Title:
Assignment Type CodeMaximum Length:30The assignment type of a supplier site to a campaign. Valid values are ASSIGNED, STANDING_OFFER, UNSUBSCRIBED, and NULL. ASSIGNED indicates that the supplier is assigned to the campaign for receiving offers. STANDING_OFFER or NULL indicates that the supplier is enrolled in a standing offer. UNSUBSCRIBED indicates that the supplier doesn't want to receive any more offers. -
billToBUId: integer
Title:
Business UnitThe unique identifier of the business unit. -
billToBUName: string
The business unit of the supplier site name assigned to the offer.
-
comments: string
Title:
CommentsMaximum Length:240Comments for an assignment. -
country: string
The location of the supplier site name assigned to the offer.
-
createdBy: string
Read Only:
trueMaximum Length:64The user who created the record. -
creationDate: string
(date-time)
Read Only:
trueThe date when the record was created. -
discountOfferId: integer
The unique offer identifier that is generated while creating an offer.
-
discountRate: number
Title:
RateActive discount percent rate for the dynamic discount calculation. -
emailAddress: string
Title:
EmailMaximum Length:320The email associated to the assigned supplier. -
enabledFlag: boolean
Title:
InitiatedMaximum Length:1Default Value:trueIndicates the record is active and in use. The default value is true. -
endDateActive: string
(date)
Title:
Expiration DateDate at the end of the offer assignment period range. -
lastUpdateDate: string
(date-time)
Read Only:
trueThe user who last updated the record. -
lastUpdatedBy: string
Read Only:
trueMaximum Length:64The session login associated to the user who last updated the record. -
lastUpdateLogin: string
Read Only:
trueMaximum Length:32The date when the record was last updated. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
offerAssignmentId: integer
(int64)
Title:
Offer Assignment IDThe unique offer assignment identifier that is generated while creating an offer assignment. -
startDateActive: string
(date)
Title:
Offer Start DateDate at the start of the offer assignment period range. The default value is set to system date. -
vendorContactId: integer
Title:
ContactThe unique identifier of the supplier contact who receives the offer notifications. -
vendorContactName: string
Title:
Supplier Contact NameThe name of the supplier contact who receives the offer notifications. -
vendorId: integer
Title:
SupplierThe unique identifier of the supplier. -
vendorName: string
The supplier name assigned to the offer. The value must be provided while creating the assignment It cannot be updated once the assignment is created.
-
vendorSiteId: integer
Title:
Supplier SiteThe unique identifier of the supplier site. -
vendorSiteName: string
The supplier site name assigned to the offer. The value must be provided while creating the assignment It cannot be updated once the assignment is created.
-
vendorTypeLookupCode: string
Maximum Length:
30Type associated to the supplier.
Nested Schema : Early Payment Offers Descriptive Flexfields
Type:
arrayTitle:
Early Payment Offers Descriptive FlexfieldsThe early payment offers descriptive flexfields resource is used to manage details about the descriptive flexfield references for an assignment.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : buyerInitiatedEarlyPaymentOffers-assignments-assignmentDff-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30The descriptive flexfield context name for the assignment. -
__FLEX_Context_DisplayValue: string
Title:
Context ValueThe descriptive flexfield context display value for the assignment. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OfferAssignmentId: integer
(int64)
The unique offer assignment identifier that is generated while creating an offer assignment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Links
- assignments
-
Parameters:
- discountOfferId:
$request.path.discountOfferId
The early payment offer assignments resource is used to manage details about supplier assignment to the standing discount offers which includes descriptive flexfields. - discountOfferId: