REST API for Oracle Fusion Cloud Financials

Get all standing early payment offer

get

/fscmRestApi/resources/11.13.18.05/buyerInitiatedEarlyPaymentOffers

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 offer with the specified primary key.
  Finder Variables:
  - discountOfferId; integer; The unique offer identifier.
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:
- createdBy; string; The user who created the record.
- creationDate; string; The date when the record was created.
- description; string; Description of the early payment offer made to the supplier.
- discountOfferId; integer; The unique offer identifier that is generated while creating an offer.
- discountRate; number; Active discount percent rate for the dynamic discount calculation.
- discountRateUnitCode; string; The type of the offer. The default value is set to Annual.
- discountsTaken; integer; Total discount taken.
- enabledFlag; boolean; Indicates the record is active and in use. The default value is true.
- endDateActive; string; Date at the end of the offer period range.
- enrolledSuppliers; integer; Total 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 when the early payment offer notification was last sent to the suppliers in the campaign.
- lastUpdateDate; string; The date when the record was last updated.
- lastUpdateLogin; string; The session login associated to the user who last updated the record.
- lastUpdatedBy; string; The user who last updated the record.
- name; string; Name of the early payment offer made to the supplier.
- startDateActive; string; Date at the start of the offer period range. The default value is set to system date.
- totalSuppliers; integer; Total number of suppliers added to the campaign. Early payment offers are sent via email to all the suppliers in the campaign.
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.

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.

Root Schema : buyerInitiatedEarlyPaymentOffers

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/buyerInitiatedEarlyPaymentOffers-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object buyerInitiatedEarlyPaymentOffers-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/buyerInitiatedEarlyPaymentOffers-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 : buyerInitiatedEarlyPaymentOffers-item-response

Type: object

Show Source

assignments: array Early Payment Offer Assignments

Title: Early Payment Offer Assignments

The 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: true

Maximum Length: 64

The user who created the record.
creationDate: string (date-time)

Read Only: true

The date when the record was created.
description: string

Title: Offer Description

Maximum Length: 240

Description 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: Rate

Active discount percent rate for the dynamic discount calculation.
discountRateUnitCode: string

Maximum Length: 30

Default Value: ORA_ANNUAL

The type of the offer. The default value is set to Annual.
discountsTaken: integer

Title: Discounts Taken

Read Only: true

Total discount taken.
enabledFlag: boolean

Title: Initiated

Maximum Length: 1

Default Value: true

Indicates the record is active and in use. The default value is true.
endDateActive: string (date)

Title: Expiration Date

Date at the end of the offer period range.
enrolledSuppliers: integer

Title: Enrolled Suppliers

Read Only: true

Total 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 Date

Date when the early payment offer notification was last sent to the suppliers in the campaign.
lastUpdateDate: string (date-time)

Read Only: true

The date when the record was last updated.
lastUpdatedBy: string

Read Only: true

Maximum Length: 64

The user who last updated the record.
lastUpdateLogin: string

Read Only: true

Maximum Length: 32

The session login associated to the user who last updated the record.
links: array Links

Title: Links

The link relations associated with the resource instance.
name: string

Title: Offer Name

Maximum Length: 60

Name of the early payment offer made to the supplier.
startDateActive: string (date)

Title: Offer Start Date

Date at the start of the offer period range. The default value is set to system date.
totalSuppliers: integer

Title: Total Suppliers

Read Only: true

Total number of suppliers added to the campaign. Early payment offers are sent via email to all the suppliers in the campaign.

{
    "type":"object",
    "properties":{
        "lastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "discountRate":{
            "title":"Rate",
            "type":"number",
            "description":"Active discount percent rate for the dynamic discount calculation.",
            "nullable":false,
            "x-queryable":true
        },
        "startDateActive":{
            "title":"Offer Start Date",
            "type":"string",
            "description":"Date at the start of the offer period range. The default value is set to system date.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "assignments":{
            "title":"Early Payment Offer Assignments",
            "type":"array",
            "description":"The early payment offer assignments resource is used to manage details about supplier assignment to the standing discount offers which includes descriptive flexfields.",
            "items":{
                "$ref":"#/components/schemas/buyerInitiatedEarlyPaymentOffers-assignments-item-response"
            }
        },
        "totalSuppliers":{
            "title":"Total Suppliers",
            "type":"integer",
            "description":"Total number of suppliers added to the campaign. Early payment offers are sent via email to all the suppliers in the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "lastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "lastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "enrolledSuppliers":{
            "title":"Enrolled Suppliers",
            "type":"integer",
            "description":"Total number of suppliers who have enrolled into standing offers. All invoices for these suppliers are eligible for early payment in exchange for a discount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "discountsTaken":{
            "title":"Discounts Taken",
            "type":"integer",
            "description":"Total discount taken.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "description":{
            "title":"Offer Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the early payment offer made to the supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "enabledFlag":{
            "title":"Initiated",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the record is active and in use. The default value is true.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "creationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "discountRateUnitCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of the offer. The default value is set to Annual.",
            "nullable":true,
            "default":"ORA_ANNUAL",
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "lastNotificationDate":{
            "title":"Last Notification Date",
            "type":"string",
            "description":"Date when the early payment offer notification was last sent to the suppliers in the campaign.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "endDateActive":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date at the end of the offer period range.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "createdBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "name":{
            "title":"Offer Name",
            "maxLength":"60",
            "type":"string",
            "description":"Name of the early payment offer made to the supplier.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_USER_KEY":"true",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "discountOfferId":{
            "type":"integer",
            "description":"The unique offer identifier that is generated while creating an offer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Early Payment Offer Assignments

Type: array

Title: Early Payment Offer Assignments

The early payment offer assignments resource is used to manage details about supplier assignment to the standing discount offers which includes descriptive flexfields.

Show Source

Array of: object buyerInitiatedEarlyPaymentOffers-assignments-item-response

{
    "title":"Early Payment Offer Assignments",
    "type":"array",
    "description":"The early payment offer assignments resource is used to manage details about supplier assignment to the standing discount offers which includes descriptive flexfields.",
    "items":{
        "$ref":"#/components/schemas/buyerInitiatedEarlyPaymentOffers-assignments-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 : buyerInitiatedEarlyPaymentOffers-assignments-item-response

Type: object

Show Source

assignmentDff: array Early Payment Offers Descriptive Flexfields

Title: Early Payment Offers Descriptive Flexfields

The early payment offers descriptive flexfields resource is used to manage details about the descriptive flexfield references for an assignment.
assignmentTypeCode: string

Title: Assignment Type Code

Maximum Length: 30

Type of discount offer assigned to the supplier. Indicates that the supplier is either assigned to campaign or has accepted standing offer.
billToBUId: integer

Title: Business Unit

The unique identifier of the business unit.
billToBUName: string

The business unit of the supplier site name assigned to the offer.
comments: string

Title: Comments

Maximum Length: 240

Comments for an assignment.
country: string

The location of the supplier site name assigned to the offer.
createdBy: string

Read Only: true

Maximum Length: 64

The user who created the record.
creationDate: string (date-time)

Read Only: true

The date when the record was created.
discountOfferId: integer

The unique offer identifier that is generated while creating an offer.
discountRate: number

Title: Rate

Active discount percent rate for the dynamic discount calculation.
emailAddress: string

Title: Email

Maximum Length: 320

The email associated to the assigned supplier.
enabledFlag: boolean

Title: Initiated

Maximum Length: 1

Default Value: true

Indicates the record is active and in use. The default value is true.
endDateActive: string (date)

Title: Expiration Date

Date at the end of the offer assignment period range.
lastUpdateDate: string (date-time)

Read Only: true

The user who last updated the record.
lastUpdatedBy: string

Read Only: true

Maximum Length: 64

The session login associated to the user who last updated the record.
lastUpdateLogin: string

Read Only: true

Maximum Length: 32

The date when the record was last updated.
links: array Links

Title: Links

The link relations associated with the resource instance.
offerAssignmentId: integer (int64)

Title: Offer Assignment ID

The unique offer assignment identifier that is generated while creating an offer assignment.
startDateActive: string (date)

Title: Offer Start Date

Date at the start of the offer assignment period range. The default value is set to system date.
vendorContactId: integer

Title: Contact

The unique identifier of the supplier contact who receives the offer notifications.
vendorContactName: string

Title: Supplier Contact Name

The name of the supplier contact who receives the offer notifications.
vendorId: integer

Title: Supplier

The 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 Site

The 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: 30

Type associated to the supplier.

{
    "type":"object",
    "properties":{
        "discountRate":{
            "title":"Rate",
            "type":"number",
            "description":"Active discount percent rate for the dynamic discount calculation.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "country":{
            "type":"string",
            "description":"The location of the supplier site name assigned to the offer.",
            "nullable":true,
            "x-queryable":false
        },
        "startDateActive":{
            "title":"Offer Start Date",
            "type":"string",
            "description":"Date at the start of the offer assignment period range. The default value is set to system date.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "vendorSiteId":{
            "title":"Supplier Site",
            "type":"integer",
            "description":"The unique identifier of the supplier site.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.financials.payables.paymentsSetup.dynamicDiscount.restModel.view.SupplierSiteDetailsPVO",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"VendorSiteCode",
                "fnd:FND_AUDIT_FK_WHEREATTR":"VendorSiteId"
            },
            "x-queryable":true
        },
        "lastUpdateDate":{
            "type":"string",
            "description":"The user who last updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "lastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The date when the record was last updated.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "vendorId":{
            "title":"Supplier",
            "type":"integer",
            "description":"The unique identifier of the supplier.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.financials.payables.paymentsSetup.dynamicDiscount.restModel.view.SupplierPVO",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"PartyName",
                "fnd:FND_AUDIT_FK_VIEWOBJECT_QRY_FORCEEXEC":"true",
                "fnd:FND_AUDIT_FK_WHEREATTR":"VendorId"
            },
            "x-queryable":true
        },
        "enabledFlag":{
            "title":"Initiated",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the record is active and in use. The default value is true.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "vendorContactId":{
            "title":"Contact",
            "type":"integer",
            "description":"The unique identifier of the supplier contact who receives the offer notifications.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "billToBUId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.financials.payables.paymentsSetup.dynamicDiscount.restModel.view.BusinessUnitPVO",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"BuName",
                "fnd:FND_AUDIT_FK_VIEWOBJECT_QRY_FORCEEXEC":"true",
                "fnd:FND_AUDIT_FK_WHEREATTR":"BuId"
            },
            "x-queryable":true
        },
        "emailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email associated to the assigned supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "discountOfferId":{
            "type":"integer",
            "description":"The unique offer identifier that is generated while creating an offer.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "lastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "assignmentTypeCode":{
            "title":"Assignment Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Type of discount offer assigned to the supplier. Indicates that the supplier is either assigned to campaign or has accepted standing offer.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "comments":{
            "title":"Comments",
            "maxLength":"240",
            "type":"string",
            "description":"Comments for an assignment.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "vendorSiteName":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "vendorContactName":{
            "title":"Supplier Contact Name",
            "type":"string",
            "description":"The name of the supplier contact who receives the offer notifications.",
            "nullable":true,
            "x-queryable":false
        },
        "assignmentDff":{
            "title":"Early Payment Offers Descriptive Flexfields",
            "type":"array",
            "description":"The early payment offers descriptive flexfields resource is used to manage details about the descriptive flexfield references for an assignment.",
            "items":{
                "$ref":"#/components/schemas/buyerInitiatedEarlyPaymentOffers-assignments-assignmentDff-item-response"
            },
            "x-cardinality":"1"
        },
        "creationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "vendorName":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "endDateActive":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date at the end of the offer assignment period range.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "billToBUName":{
            "type":"string",
            "description":"The business unit of the supplier site name assigned to the offer.",
            "nullable":true,
            "x-queryable":false
        },
        "createdBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "vendorTypeLookupCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Type associated to the supplier.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "offerAssignmentId":{
            "title":"Offer Assignment ID",
            "type":"integer",
            "description":"The unique offer assignment identifier that is generated while creating an offer assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_USER_KEY":"true",
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Early Payment Offers Descriptive Flexfields

Type: array

Title: Early Payment Offers Descriptive Flexfields

The early payment offers descriptive flexfields resource is used to manage details about the descriptive flexfield references for an assignment.

Show Source

Array of: object buyerInitiatedEarlyPaymentOffers-assignments-assignmentDff-item-response

{
    "title":"Early Payment Offers Descriptive Flexfields",
    "type":"array",
    "description":"The early payment offers descriptive flexfields resource is used to manage details about the descriptive flexfield references for an assignment.",
    "items":{
        "$ref":"#/components/schemas/buyerInitiatedEarlyPaymentOffers-assignments-assignmentDff-item-response"
    },
    "x-cardinality":"1"
}

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 : buyerInitiatedEarlyPaymentOffers-assignments-assignmentDff-item-response

Type: object

Show Source

__FLEX_Context: string

Title: Context Value

Maximum Length: 30

The descriptive flexfield context name for the assignment.
__FLEX_Context_DisplayValue: string

Title: Context Value

The descriptive flexfield context display value for the assignment.
links: array Links

Title: Links

The link relations associated with the resource instance.
OfferAssignmentId: integer (int64)

The unique offer assignment identifier that is generated while creating an offer assignment.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OfferAssignmentId":{
            "type":"integer",
            "description":"The unique offer assignment identifier that is generated while creating an offer assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"The descriptive flexfield context display value for the assignment.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":"30",
            "type":"string",
            "description":"The descriptive flexfield context name for the assignment.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

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

Links

getCampaignDetailsUsingVendorId: Operation: /fscmRestApi/resources/11.13.18.05/buyerInitiatedEarlyPaymentOffers/action/getCampaignDetailsUsingVendorId

Retrieves the list of campaigns to which a supplier is assigned.
getSupplierContacts: Operation: /fscmRestApi/resources/11.13.18.05/buyerInitiatedEarlyPaymentOffers/action/getSupplierContacts

Retrieves the list of supplier contacts for a vendor. The campaign manager can choose the appropriate contact for sending early payment offers from the list.
sendEarlyPaymentOffers: Operation: /fscmRestApi/resources/11.13.18.05/buyerInitiatedEarlyPaymentOffers/action/sendEarlyPaymentOffers

Sends early payment offers to suppliers. An email is sent to each supplier in the campaign with the details of the early payment offer and the list of eligible invoices. Suppliers can respond by accepting the offer, declining it, or enrolling into a standing offer.
updateSupplierAssignments: Operation: /fscmRestApi/resources/11.13.18.05/buyerInitiatedEarlyPaymentOffers/action/updateSupplierAssignments

Updates supplier contact who receives early payment offers. An email is sent to the selected supplier contact with the details of the early payment offer and the list of eligible invoices.