Jump to

• Request
• Response

Get one special price agreement

get

/fscmRestApi/resources/11.13.18.05/channelSpecialPriceAgreements/{SpecialPriceAgreementId}

Request

Path Parameters

• SpecialPriceAgreementId(required): integer(int64)
  Value that uniquely identifies the special price agreement.

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 : channelSpecialPriceAgreements-item-response

Type: object

Show Source

• AccountedEstimatedAmount: number
  Read Only: true

  Estimated amount in the ledger currency.
• ApprovedDate: string (date)
  Read Only: true

  Date when the special price agreement is approved.
• attachments: array Attachments
  Title: Attachments

  The Attachments resource is used to view, create, and update attachments.
• BusinessUnit: string
  Maximum Length: 255

  Name of the business unit.
• BusinessUnitId: integer (int64)
  Value that uniquely identifies the business unit.
• Competitor: string
  Maximum Length: 255

  Value that uniquely identifies the competitor.
• CompetitorAddress: string
  Read Only: true

  Maximum Length: 255

  Address of the competitor.
• CompetitorContact: string
  Maximum Length: 1440

  Name of the competitor contact.
• CompetitorContactEmail: string
  Maximum Length: 1280

  Competitor's contact email address.
• CompetitorContactPhoneCountryCode: string
  Maximum Length: 10

  Competitor's contact phone country code.
• CompetitorContactPhoneExtension: string
  Maximum Length: 20

  Competitor's contact phone number extension.
• CompetitorContactPhoneNumber: string
  Maximum Length: 160

  Competitor's contact phone number.
• CompetitorId: integer (int64)
  Name of the competitor.
• CompetitorRegistryId: string
  Maximum Length: 255

  Number that uniquely identifies the competitor.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the record.
• Currency: string
  Maximum Length: 255

  Name of the currency used for the special price agreement.
• CurrencyCode: string
  Maximum Length: 15

  Abbreviation that identifies the currency used for the special price agreement.
• DateContextType: string
  Maximum Length: 255

  Name of the effective date type used for evaluating the special price agreement eligibility. A list of accepted values is defined in the lookup ORA_CJM_SPA_DATE_QUAL.
• DateContextTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the effective date type used for evaluating the special price agreement eligibility.
• Description: string
  Maximum Length: 1000

  Description of the special price agreement.
• DFF: array Channel Special Price Agreements Descriptive Flexfields
  Title: Channel Special Price Agreements Descriptive Flexfields

  The Descriptive Flexfields for Channel Special Price Agreements resource manages additional details.
• Distributor: string
  Maximum Length: 255

  Name of the distributor.
• DistributorBillToAccountAddress: string
  Read Only: true

  Maximum Length: 255

  Primary bill-to account address of the distributor's bill-to customer account.
• DistributorBillToAccountId: integer (int64)
  Value that uniquely identifies the bill-to customer account of the distributor.
• DistributorBillToAccountNumber: string
  Maximum Length: 255

  Number that identifies the bill-to customer account of the distributor.
• DistributorContact: string
  Maximum Length: 255

  Name of the distributor's bill-to customer account's contact.
• DistributorContactEmail: string
  Read Only: true

  Maximum Length: 255

  Email of the distributor's bill-to customer account's contact.
• DistributorContactId: integer (int64)
  Value that uniquely represents the distributor's bill-to customer account's contact.
• DistributorContactNumber: string
  Maximum Length: 255

  Number that identifies the distributor's bill-to customer account's contact.
• DistributorContactPhoneNumber: string
  Read Only: true

  Maximum Length: 255

  Phone number of the distributor's bill-to customer account's contact.
• DistributorContactPhoneNumberExtension: string
  Read Only: true

  Maximum Length: 255

  Phone number extension of the distributor's bill-to customer account's contact.
• EndCustomer: string
  Maximum Length: 255

  Name of the end customer.
• EndCustomerAddress: string
  Read Only: true

  Maximum Length: 255

  Address of the end customer.
• EndCustomerContact: string
  Maximum Length: 1440

  Name of the end customer contact.
• EndCustomerContactEmail: string
  Maximum Length: 1280

  End customer's contact email address.
• EndCustomerContactPhoneCountryCode: string
  Maximum Length: 10

  End customer's contact phone country code.
• EndCustomerContactPhoneExtension: string
  Maximum Length: 20

  End customer's contact phone number extension.
• EndCustomerContactPhoneNumber: string
  Maximum Length: 160

  End customer's contact phone number.
• EndCustomerId: integer (int64)
  Value that uniquely identifies the end customer.
• EndCustomerRegistryId: string
  Maximum Length: 255

  Number that uniquely identifies the end customer.
• EndDate: string (date)
  Date until when the special price agreement is applicable.
• EstimatedAmount: number
  Read Only: true

  Estimated amount for the special price agreement.
• FunctionalCurrency: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the functional currency used for the special price agreement.
• FunctionalCurrencyCode: string
  Read Only: true

  Maximum Length: 255

  Name of the functional currency used for the special price agreement.
• Justification: string
  Maximum Length: 4000

  Comments submitted to provide additional information to the approvers.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• notes: array Notes
  Title: Notes

  The Notes resource captures comments, information, or instructions for a special price agreement.
• Outcome: string
  Maximum Length: 255

  Outcome of the special price agreement. A list of accepted values is defined in the lookup ORA_CJM_SPA_OUTCOME.
• OutcomeCode: string
  Maximum Length: 30

  Abbreviation that identifies the outcome of the special price agreement.
• Owner: string
  Maximum Length: 255

  Name of the person who owns the special price agreement. This attribute defaults to the name of the person who creates the special price agreement.
• OwnerId: integer (int64)
  Value that uniquely identifies the person who owns the special price agreement.
• OwnerPersonNumber: string
  Maximum Length: 255

  Number that uniquely identifies the person who owns the special price agreement.
• products: array Products
  Title: Products

  Manages products of a special price agreement.
• ProgramTemplate: string
  Read Only: true

  Maximum Length: 255

  Name of the predefined program template on which the special price agreement is based. A list of accepted values is defined in the lookup ORA_CJM_PROGRAM_TYPE.
• ProgramTemplateCode: string
  Read Only: true

  Maximum Length: 30

  Default Value: SPECIAL_PRICE_AGREEMENT

  Abbreviation that identifies the predefined program template on which the special price agreement is based.
• ProgramType: string
  Maximum Length: 255

  Type of program on which the special price agreement is based.
• ProgramTypeId: integer (int64)
  Value that uniquely identifies the type of program on which the special price agreement is based.
• RejectedDate: string (date)
  Read Only: true

  Date when the special price agreement is rejected.
• RequestType: string
  Maximum Length: 255

  Request type for special price agreements. A list of accepted values is defined in the lookup ORA_CJM_SPA_REQUEST_TYPE.
• RequestTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the request type for special price agreements.
• ShipFromDistributorInventoryFlag: boolean
  Read Only: true

  Maximum Length: 1

  Default Value: true

  Contains one of the following values: true or false. If true, then the special price agreement is for the distributor's existing inventory. If false, then the special price agreement is for a new inventory. This attribute is defaulted to true.
• SpecialPriceAgreementId: integer (int64)
  Read Only: true

  Value that uniquely identifies the special price agreement.
• SpecialPriceAgreementName: string
  Maximum Length: 240

  Name of the special price agreement.
• SpecialPriceAgreementNumber: string
  Maximum Length: 30

  Number that uniquely identifies the special price agreement.
• StartDate: string (date)
  Date from when the special price agreement is applicable.
• Status: string
  Maximum Length: 255

  Status of the special price agreement.
• StatusId: integer (int64)
  Value that uniquely identifies the status of the special price agreement.
• SubmittedBy: string
  Read Only: true

  Maximum Length: 255

  Name that identifies the user who submitted the special price agreement for approval.
• SubmittedDate: string (date)
  Read Only: true

  Date when the special price agreement is submitted.
• SystemStatus: string
  Read Only: true

  Maximum Length: 255

  System status of the special price agreement.
• SystemStatusCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the system status of the special price agreement.

{
    "type":"object",
    "properties":{
        "AccountedEstimatedAmount":{
            "type":"number",
            "description":"Estimated amount in the ledger currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApprovedDate":{
            "type":"string",
            "description":"Date when the special price agreement is approved.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnit":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "Competitor":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the competitor.",
            "nullable":true,
            "x-queryable":true
        },
        "CompetitorAddress":{
            "maxLength":255,
            "type":"string",
            "description":"Address of the competitor.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CompetitorContact":{
            "maxLength":1440,
            "type":"string",
            "description":"Name of the competitor contact.",
            "nullable":true,
            "x-queryable":true
        },
        "CompetitorContactEmail":{
            "maxLength":1280,
            "type":"string",
            "description":"Competitor's contact email address.",
            "nullable":true,
            "x-queryable":true
        },
        "CompetitorContactPhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"Competitor's contact phone country code.",
            "nullable":true,
            "x-queryable":true
        },
        "CompetitorContactPhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"Competitor's contact phone number extension.",
            "nullable":true,
            "x-queryable":true
        },
        "CompetitorContactPhoneNumber":{
            "maxLength":160,
            "type":"string",
            "description":"Competitor's contact phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "CompetitorId":{
            "type":"integer",
            "description":"Name of the competitor.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CompetitorRegistryId":{
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies the competitor.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Currency":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the currency used for the special price agreement.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the currency used for the special price agreement.",
            "nullable":true,
            "x-queryable":true
        },
        "DFF":{
            "title":"Channel Special Price Agreements Descriptive Flexfields",
            "type":"array",
            "description":"The Descriptive Flexfields for Channel Special Price Agreements resource manages additional details.",
            "items":{
                "$ref":"#/components/schemas/channelSpecialPriceAgreements-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "DateContextType":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the effective date type used for evaluating  the special price agreement eligibility. A list of accepted values is defined in the lookup ORA_CJM_SPA_DATE_QUAL.",
            "nullable":true,
            "x-queryable":true
        },
        "DateContextTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the effective date type used for evaluating the special price agreement eligibility.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"Description of the special price agreement.",
            "nullable":true,
            "x-queryable":false
        },
        "Distributor":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the distributor.",
            "nullable":true,
            "x-queryable":true
        },
        "DistributorBillToAccountAddress":{
            "maxLength":255,
            "type":"string",
            "description":"Primary bill-to account address of the distributor's bill-to customer account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DistributorBillToAccountId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill-to customer account of the distributor.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "DistributorBillToAccountNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the bill-to customer account of the distributor.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DistributorContact":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the distributor's bill-to customer account's contact.",
            "nullable":true,
            "x-queryable":true
        },
        "DistributorContactEmail":{
            "maxLength":255,
            "type":"string",
            "description":"Email of the distributor's bill-to customer account's contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DistributorContactId":{
            "type":"integer",
            "description":"Value that uniquely represents the distributor's bill-to customer account's contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "DistributorContactNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the distributor's bill-to customer account's contact.",
            "nullable":true,
            "x-queryable":true
        },
        "DistributorContactPhoneNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Phone number of the distributor's bill-to customer account's contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DistributorContactPhoneNumberExtension":{
            "maxLength":255,
            "type":"string",
            "description":"Phone number extension of the distributor's bill-to customer account's contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndCustomer":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the end customer.",
            "nullable":true,
            "x-queryable":true
        },
        "EndCustomerAddress":{
            "maxLength":255,
            "type":"string",
            "description":"Address of the end customer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndCustomerContact":{
            "maxLength":1440,
            "type":"string",
            "description":"Name of the end customer contact.",
            "nullable":true,
            "x-queryable":true
        },
        "EndCustomerContactEmail":{
            "maxLength":1280,
            "type":"string",
            "description":"End customer's contact email address.",
            "nullable":true,
            "x-queryable":true
        },
        "EndCustomerContactPhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"End customer's contact phone country code.",
            "nullable":true,
            "x-queryable":true
        },
        "EndCustomerContactPhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"End customer's contact phone number extension.",
            "nullable":true,
            "x-queryable":true
        },
        "EndCustomerContactPhoneNumber":{
            "maxLength":160,
            "type":"string",
            "description":"End customer's contact phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "EndCustomerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the end customer.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndCustomerRegistryId":{
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies the end customer.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date until when the special price agreement is applicable.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "EstimatedAmount":{
            "type":"number",
            "description":"Estimated amount for the special price agreement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FunctionalCurrency":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the functional currency used for the special price agreement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FunctionalCurrencyCode":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the functional currency used for the special price agreement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Justification":{
            "maxLength":4000,
            "type":"string",
            "description":"Comments submitted to provide additional information to the approvers.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Outcome":{
            "maxLength":255,
            "type":"string",
            "description":"Outcome of the special price agreement. A list of accepted values is defined in the lookup ORA_CJM_SPA_OUTCOME.",
            "nullable":true,
            "x-queryable":true
        },
        "OutcomeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the outcome of the special price agreement.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Owner":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the person who owns the special price agreement. This attribute defaults to the name of the person who creates the special price agreement.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the person who owns the special price agreement.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "OwnerPersonNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies the person who owns the special price agreement.",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramTemplate":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the predefined program template on which the special price agreement is based. A list of accepted values is defined in the lookup ORA_CJM_PROGRAM_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramTemplateCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the predefined program template on which the special price agreement is based.",
            "nullable":false,
            "readOnly":true,
            "default":"SPECIAL_PRICE_AGREEMENT",
            "x-queryable":true
        },
        "ProgramType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of program on which the special price agreement is based.",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the type of program on which the special price agreement is based.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "RejectedDate":{
            "type":"string",
            "description":"Date when the special price agreement is rejected.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestType":{
            "maxLength":255,
            "type":"string",
            "description":"Request type for special price agreements. A list of accepted values is defined in the lookup ORA_CJM_SPA_REQUEST_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the request type for special price agreements.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ShipFromDistributorInventoryFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the special price agreement is for the distributor's existing inventory. If false, then the special price agreement is for a new inventory. This attribute is defaulted to true.",
            "nullable":true,
            "readOnly":true,
            "default":true,
            "x-queryable":true
        },
        "SpecialPriceAgreementId":{
            "type":"integer",
            "description":"Value that uniquely identifies the special price agreement.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SpecialPriceAgreementName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the special price agreement.",
            "nullable":false,
            "x-queryable":true
        },
        "SpecialPriceAgreementNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the special price agreement.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date from when the special price agreement is applicable.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "Status":{
            "maxLength":255,
            "type":"string",
            "description":"Status of the special price agreement.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusId":{
            "type":"integer",
            "description":"Value that uniquely identifies the status of the special price agreement.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "SubmittedBy":{
            "maxLength":255,
            "type":"string",
            "description":"Name that identifies the user who submitted the special price agreement for approval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmittedDate":{
            "type":"string",
            "description":"Date when the special price agreement is submitted.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SystemStatus":{
            "maxLength":255,
            "type":"string",
            "description":"System status of the special price agreement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SystemStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the system status of the special price agreement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/channelSpecialPriceAgreements-attachments-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "notes":{
            "title":"Notes",
            "type":"array",
            "description":"The Notes resource captures comments, information, or instructions for a special price agreement.",
            "items":{
                "$ref":"#/components/schemas/channelSpecialPriceAgreements-notes-item-response"
            }
        },
        "products":{
            "title":"Products",
            "type":"array",
            "description":"Manages products of a special price agreement.",
            "items":{
                "$ref":"#/components/schemas/channelSpecialPriceAgreements-products-item-response"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The Attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object channelSpecialPriceAgreements-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The Attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/channelSpecialPriceAgreements-attachments-item-response"
    }
}

Nested Schema : Channel Special Price Agreements Descriptive Flexfields

Type: array

Title: Channel Special Price Agreements Descriptive Flexfields

The Descriptive Flexfields for Channel Special Price Agreements resource manages additional details.

Show Source

• Array of: object channelSpecialPriceAgreements-DFF-item-response

{
    "title":"Channel Special Price Agreements Descriptive Flexfields",
    "type":"array",
    "description":"The Descriptive Flexfields for Channel Special Price Agreements resource manages additional details.",
    "items":{
        "$ref":"#/components/schemas/channelSpecialPriceAgreements-DFF-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 : Notes

Type: array

Title: Notes

The Notes resource captures comments, information, or instructions for a special price agreement.

Show Source

• Array of: object channelSpecialPriceAgreements-notes-item-response

{
    "title":"Notes",
    "type":"array",
    "description":"The Notes resource captures comments, information, or instructions for a special price agreement.",
    "items":{
        "$ref":"#/components/schemas/channelSpecialPriceAgreements-notes-item-response"
    }
}

Nested Schema : Products

Type: array

Title: Products

Manages products of a special price agreement.

Show Source

• Array of: object channelSpecialPriceAgreements-products-item-response

{
    "title":"Products",
    "type":"array",
    "description":"Manages products of a special price agreement.",
    "items":{
        "$ref":"#/components/schemas/channelSpecialPriceAgreements-products-item-response"
    }
}

Nested Schema : channelSpecialPriceAgreements-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Value that uniquely identifies the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  User who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  User who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  Document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  Contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  File name of the attachment.
• FileUrl: string
  Title: File Url

  URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  Base64 encoded image of the file displayed in .png format, if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  User who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  User who most recently updated the record.
• links: array Links
  Title: Links

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

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  Text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  Session login associated with the user who created the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Value that uniquely identifies the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"User who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"Base64 encoded image of the file displayed in .png format, if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"The base64 encoded image of the file displayed in .png format if the source is a convertible image."
                },
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"User who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"Session login associated with the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":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"
            }
        }
    }
}

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

Nested Schema : channelSpecialPriceAgreements-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Descriptive flexfield context name for special price agreement.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Descriptive flexfield context display value for special price agreement.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SpecialPriceAgreementId: integer (int64)
  Value that uniquely identifies the special price agreement.

{
    "type":"object",
    "properties":{
        "SpecialPriceAgreementId":{
            "type":"integer",
            "description":"Value that uniquely identifies the special price agreement.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield context name for special price agreement.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "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
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Descriptive flexfield context display value for special price agreement.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "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
        },
        "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 : channelSpecialPriceAgreements-notes-item-response

Type: object

Show Source

• ContactRelationshipId: integer (int64)
  Title: Contact Relationship ID

  Relationship ID populated when the note is associated with a contact.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  Corporate currency code for extensibility.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the record was created.
• CreatorPartyId: integer (int64)
  Title: Creator Party ID

  Party ID for the note creator.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  Currency conversion rate type for extensibility.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  Currency code for extensibility.
• DeleteFlag: boolean
  Title: Delete Indicator

  Read Only: true

  Indicates whether the user has access to delete the note.
• EmailAddress: string
  Read Only: true

  Maximum Length: 320

  Email address of the user who created the note.
• FormattedAddress: string
  Read Only: true

  Address of the user who created the note.
• FormattedPhoneNumber: string
  Read Only: true

  Phone number of the user who created the note.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  Session login associated with the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NoteId: integer (int64)
  Title: Note ID

  Read Only: true

  Value that uniquely identifies the note. This is the primary key of the notes table.
• NoteNumber: string
  Maximum Length: 30

  Alternate unique identifier of the note. This is a user key that is system generated or from an external system.
• NoteTitle: string
  Title: Title

  Maximum Length: 500

  Title of the note entered by the user.
• NoteTxt: string (byte)
  Title: Note

  Column that stores the actual note text.
• NoteTypeCode: string
  Title: Type

  Maximum Length: 30

  Note type code for categorization of note.
• ParentNoteId: integer (int64)
  Title: Parent Note ID

  Value that uniquely identifies the parent source object associated to the note.
• PartyId: integer (int64)
  Read Only: true

  Value that uniquely identifies the party.
• PartyName: string
  Title: Author

  Read Only: true

  Maximum Length: 360

  Name of the party.
• SourceObjectCode: string
  Title: Related Object Type

  Maximum Length: 30

  Source object code for the source object as defined in the OBJECTS metadata.
• SourceObjectId: string
  Title: Related Object

  Maximum Length: 64

  Value that uniquely identifies the parent source object associated to the note.
• SourceSystem: string
  Title: Source System

  Maximum Length: 30

  This is the source object code for the source object as defined in OBJECTS Metadata.
• UpdateFlag: boolean
  Title: Update Indicator

  Read Only: true

  Indicates whether the user can update the note.
• VisibilityCode: string
  Title: Private

  Maximum Length: 30

  Default Value: INTERNAL

  Attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.

{
    "type":"object",
    "properties":{
        "ContactRelationshipId":{
            "title":"Contact Relationship ID",
            "type":"integer",
            "description":"Relationship ID populated when the note is associated with a contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"Corporate currency code for extensibility.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"Party ID for the note creator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"Currency conversion rate type for extensibility.",
            "nullable":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"Currency code for extensibility.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DeleteFlag":{
            "title":"Delete Indicator",
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"Email address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "type":"string",
            "description":"Address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Country",
                    "IdenAddrLocationId",
                    "PersonalAddressFlag"
                ]
            }
        },
        "FormattedPhoneNumber":{
            "type":"string",
            "description":"Phone number of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"Session login associated with the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteId":{
            "title":"Note ID",
            "type":"integer",
            "description":"Value that uniquely identifies the note. This is the primary key of the notes table.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NoteNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Alternate unique identifier of the note. This is a user key that is system generated or from an external system.",
            "nullable":true,
            "x-queryable":true
        },
        "NoteTitle":{
            "title":"Title",
            "maxLength":500,
            "type":"string",
            "description":"Title of the note entered by the user.",
            "nullable":true,
            "x-queryable":true
        },
        "NoteTxt":{
            "title":"Note",
            "type":"string",
            "description":"Column that stores the actual note text.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            },
            "x-queryable":true
        },
        "NoteTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Note type code for categorization of note.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjectCode"
                ]
            },
            "x-queryable":true
        },
        "ParentNoteId":{
            "title":"Parent Note ID",
            "type":"integer",
            "description":"Value that uniquely identifies the parent source object associated to the note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Author",
            "maxLength":360,
            "type":"string",
            "description":"Name of the party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Related Object Type",
            "maxLength":30,
            "type":"string",
            "description":"Source object code for the source object as defined in the OBJECTS metadata.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies the parent source object associated to the note.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceSystem":{
            "title":"Source System",
            "maxLength":30,
            "type":"string",
            "description":"This is the source object code for the source object as defined in OBJECTS Metadata.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update Indicator",
            "type":"boolean",
            "description":"Indicates whether the user can update the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "VisibilityCode":{
            "title":"Private",
            "maxLength":30,
            "type":"string",
            "description":"Attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.",
            "nullable":false,
            "default":"INTERNAL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "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 : channelSpecialPriceAgreements-products-item-response

Type: object

Show Source

• CompetitorItem: string
  Maximum Length: 960

  Name of the competitor item.
• CompetitorItemPrice: number
  Price of the competitor item.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the record.
• EstimatedAmount: number
  Read Only: true

  Estimated rebate amount for the item.
• Item: string
  Maximum Length: 255

  Name of the item in the inventory.
• ItemDescription: string
  Read Only: true

  Maximum Length: 255

  Description of the item in the inventory.
• ItemId: string
  Maximum Length: 240

  Value that uniquely identifies the item in the inventory.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• LineNumber: number
  Number that identifies the product line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OriginalUnitSellingPrice: number
  Unit selling price of the item.
• ProductId: integer
  Value that uniquely identifies the product.
• Quantity: number
  Quantity of the items.
• RebateAmount: number
  Amount of the rebate.
• RebateType: string
  Maximum Length: 255

  Name of the rebate type.
• RebateTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the rebate type.
• SpecialPriceAgreementId: integer (int64)
  Value that uniquely identifies the special price agreement program.
• UnitOfMeasure: string
  Maximum Length: 255

  Unit of measure of the item.
• UnitOfMeasureCode: string
  Maximum Length: 30

  Abbreviation that identifies the unit of measure.

{
    "type":"object",
    "properties":{
        "CompetitorItem":{
            "maxLength":960,
            "type":"string",
            "description":"Name of the competitor item.",
            "nullable":true,
            "x-queryable":true
        },
        "CompetitorItemPrice":{
            "type":"number",
            "description":"Price of the competitor item.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedAmount":{
            "type":"number",
            "description":"Estimated rebate amount for the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Item":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the item in the inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the item in the inventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "maxLength":240,
            "type":"string",
            "description":"Value that uniquely identifies the item in the inventory.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineNumber":{
            "type":"number",
            "description":"Number that identifies the product line.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginalUnitSellingPrice":{
            "type":"number",
            "description":"Unit selling price of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductId":{
            "type":"integer",
            "description":"Value that uniquely identifies the product.",
            "nullable":false,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the items.",
            "nullable":false,
            "x-queryable":true
        },
        "RebateAmount":{
            "type":"number",
            "description":"Amount of the rebate.",
            "nullable":false,
            "x-queryable":true
        },
        "RebateType":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the rebate type.",
            "nullable":true,
            "x-queryable":true
        },
        "RebateTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the rebate type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SpecialPriceAgreementId":{
            "type":"integer",
            "description":"Value that uniquely identifies the special price agreement program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "maxLength":255,
            "type":"string",
            "description":"Unit of measure of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitOfMeasureCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "nullable":false,
            "x-queryable":true
        },
        "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"
    }
}

Links

DFF

Operation: /fscmRestApi/resources/11.13.18.05/channelSpecialPriceAgreements/{SpecialPriceAgreementId}/child/DFF

Parameters:

• SpecialPriceAgreementId: $request.path.SpecialPriceAgreementId

The Descriptive Flexfields for Channel Special Price Agreements resource manages additional details.

DateContextTypeVVO

Parameters:

• finder: findProgramTypeDateQualifiers%3BbindProgramTypeId%3D{ProgramTypeId}

The following properties are defined on the LOV link relation:

• Source Attribute: DateContextTypeCode; Target Attribute: QualifierTypeCode
• Display Attribute: QualifierType

DistributorAccountVO

Parameters:

• finder: default%3BbindOrgId%3D{BusinessUnitId}

The following properties are defined on the LOV link relation:

• Source Attribute: DistributorBillToAccountNumber; Target Attribute: AccountNumber
• Display Attribute: AccountNumber, CustomerName

DistributorContactVO

Parameters:

• finder: default%3BbindBillToCustomerId%3D{DistributorBillToAccountId}%2CbindSiteUseCode%3DBILL_TO

The following properties are defined on the LOV link relation:

• Source Attribute: DistributorContactId; Target Attribute: ContactId
• Display Attribute: Name, Email, JobTitle

DistributorVO

Parameters:

• finder: default%3BbindOrgId%3D{BusinessUnitId}

The following properties are defined on the LOV link relation:

• Source Attribute: DistributorBillToAccountId; Target Attribute: CustomerAccountId
• Display Attribute: CustomerName

FinFunBusinessUnitVO

Operation: /fscmRestApi/resources/11.13.18.05/finBusinessUnitsLOV

Parameters:

• finder: ModuleIdFinder%3BIntent%3DCJM_MANAGE_CHANNEL_PROGRAMS_DATA%2CModuleId%3D30

The following properties are defined on the LOV link relation:

• Source Attribute: BusinessUnitId; Target Attribute: BusinessUnitId
• Display Attribute: BusinessUnitName

OutcomeLookupVVO

Parameters:

• finder: LookupTypeFinder%3BbindLookupType%3DORA_CJM_SPA_OUTCOME

The following properties are defined on the LOV link relation:

• Source Attribute: OutcomeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

OwnersVVO

Operation: /fscmRestApi/resources/11.13.18.05/channelOwnersLOV

Parameters:

• finder: ActiveOwnerFinder

The following properties are defined on the LOV link relation:

• Source Attribute: OwnerId; Target Attribute: PersonId
• Display Attribute: Name, Email, BusinessTitle

ProgramTypeVO

Operation: /fscmRestApi/resources/11.13.18.05/channelProgramTypes

Parameters:

• finder: FindByProgramTemplate%3BbindProgramTemplateCode%3DSPECIAL_PRICE_AGREEMENT

The following properties are defined on the LOV link relation:

• Source Attribute: ProgramTypeId; Target Attribute: ProgramTypeId
• Display Attribute: ProgramTypeName

RequestTypeLookupVVO

Parameters:

• finder: LookupTypeFinder%3BbindLookupType%3DORA_CJM_SPA_REQUEST_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: RequestTypeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

UserStatusVO

Operation: /fscmRestApi/resources/11.13.18.05/channelUserStatuses

Parameters:

• finder: SellSideStatusFinder%3BbindUserStatusForCode%3DSPECIAL_PRICE_AGREEMENT

The following properties are defined on the LOV link relation:

• Source Attribute: StatusId; Target Attribute: UserStatusId
• Display Attribute: UserStatusName

attachments

Operation: /fscmRestApi/resources/11.13.18.05/channelSpecialPriceAgreements/{SpecialPriceAgreementId}/child/attachments

Parameters:

• SpecialPriceAgreementId: $request.path.SpecialPriceAgreementId

The Attachments resource is used to view, create, and update attachments.

notes

Operation: /fscmRestApi/resources/11.13.18.05/channelSpecialPriceAgreements/{SpecialPriceAgreementId}/child/notes

Parameters:

• SpecialPriceAgreementId: $request.path.SpecialPriceAgreementId

The Notes resource captures comments, information, or instructions for a special price agreement.

products

Operation: /fscmRestApi/resources/11.13.18.05/channelSpecialPriceAgreements/{SpecialPriceAgreementId}/child/products

Parameters:

• SpecialPriceAgreementId: $request.path.SpecialPriceAgreementId

Manages products of a special price agreement.

submit

Operation: /fscmRestApi/resources/11.13.18.05/channelSpecialPriceAgreements/{SpecialPriceAgreementId}/action/submit

Parameters:

• SpecialPriceAgreementId: $request.path.SpecialPriceAgreementId

Action to submit a special price agreement.

Back to Top