Jump to

• Request
• Response

Get all lump-sum programs

get

/fscmRestApi/resources/11.13.18.05/channelCustomerLumpSumPrograms

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 customer lump-sum program with the specified primary key.
    Finder Variables:
    • ProgramId; integer; Unique identifier of the customer lump-sum program.
• 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:
  

  • AccountedLumpsumAmount; number; Indicates the amount defined for the lump-sum program in the functional currency.
  • ApprovedDate; string; Date when the program is approved and moved to active status.
  • BillToAccountId; integer; Value that uniquely identifies the bill-to customer.
  • BillToAccountNumber; string; Number of the bill-to customer account.
  • BillToSite; string; Name of the bill-to customer account site.
  • BillToSiteAddress; string; Address of the bill-to customer account site.
  • BillToSiteId; integer; Value that uniquely identifies the bill-to customer account site.
  • BusinessUnit; string; Name of the business unit.
  • BusinessUnitId; integer; Value that uniquely identifies the business unit.
  • CreatedBy; string; User who created the record.
  • CreationDate; string; Date and time when the user created the record.
  • Currency; string; Name of the currency used for the customer lump-sum program.
  • CurrencyCode; string; Abbreviation that identifies the currency used for the customer lump-sum program.
  • Customer; string; Name of the customer.
  • CustomerType; string; Customer type for the lump-sum program. A list of accepted values is defined in the lookup type ORA_CJM_LS_QUALIFIER.
  • CustomerTypeCode; string; Abbreviation that identifies the customer type for the lump-sum program.
  • Description; string; Description of the lump-sum program.
  • DistributionType; string; Distribution type used in the lump-sum program.
  • DistributionTypeCode; string; Abbreviation that identifies the distribution type used in the lump-sum program.
  • LastUpdateDate; string; Date and time when the user most recently updated the record.
  • LastUpdatedBy; string; User who most recently updated the record.
  • LumpsumAmount; number; Lump-sum program amount.
  • Owner; string; Name of the person who owns the customer lump-sum program. This attribute defaults to the name of the person who creates the program.
  • OwnerId; integer; Value that uniquely identifies the person who owns the customer lump-sum program.
  • OwnerPersonNumber; string; Number that uniquely identifies the person who owns the customer lump-sum program.
  • ProgramId; integer; Value that uniquely identifies the customer lump-sum program.
  • ProgramName; string; Name of the customer lump-sum program.
  • ProgramTemplate; string; Name of the predefined program template on which the customer lump-sum program is based. A list of accepted values is defined in the lookup type ORA_CJM_PROGRAM_TYPE.
  • ProgramTemplateCode; string; Abbreviation that identifies the predefined program template on which the customer lump-sum program is based.
  • ProgramType; string; Type of program on which the customer lump-sum program is based.
  • ProgramTypeId; integer; Value that uniquely identifies the type of program on which the customer lump-sum program is based.
  • PromotionCode; string; Abbreviation that uniquely identifies the customer lump-sum program.
  • RejectedDate; string; Date when the program is rejected.
  • StartDate; string; Date from when the program is applicable.
  • Status; string; Status of the customer lump-sum program.
  • StatusId; integer; Value that uniquely identifies the status of the customer lump-sum program.
  • SubmittedBy; string; Name that identifies the user who submitted the program for approval.
  • SubmittedDate; string; Date when the program is submitted.
  • SystemStatus; string; System status of the customer lump-sum program.
  • SystemStatusCode; string; Abbreviation that identifies the system status of the customer lump-sum program.
  • SystemStatusId; integer; Value that uniquely identifies the system status of the customer lump-sum program.
• 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.

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 : channelCustomerLumpSumPrograms

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/channelCustomerLumpSumPrograms-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"OrderManagement",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object channelCustomerLumpSumPrograms-item-response

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

Type: object

Show Source

• AccountedLumpsumAmount: number
  Read Only: true

  Indicates the amount defined for the lump-sum program in the functional currency.
• ApprovedDate: string (date)
  Read Only: true

  Date when the program is approved and moved to active status.
• attachments: array Attachments
  Title: Attachments

  The Attachments resource is used to view, create, and update attachments.
• BillToAccountId: integer (int64)
  Value that uniquely identifies the bill-to customer.
• BillToAccountNumber: string
  Maximum Length: 255

  Number of the bill-to customer account.
• BillToSite: string
  Read Only: true

  Maximum Length: 255

  Name of the bill-to customer account site.
• BillToSiteAddress: string
  Read Only: true

  Maximum Length: 255

  Address of the bill-to customer account site.
• BillToSiteId: integer
  Read Only: true

  Value that uniquely identifies the bill-to customer account site.
• BusinessUnit: string
  Maximum Length: 255

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

  Comments submitted to provide additional information to the approvers.
• 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 customer lump-sum program.
• CurrencyCode: string
  Maximum Length: 15

  Abbreviation that identifies the currency used for the customer lump-sum program.
• Customer: string
  Maximum Length: 255

  Name of the customer.
• CustomerType: string
  Maximum Length: 255

  Customer type for the lump-sum program. A list of accepted values is defined in the lookup type ORA_CJM_LS_QUALIFIER.
• CustomerTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the customer type for the lump-sum program.
• Description: string
  Maximum Length: 1000

  Description of the lump-sum program.
• DFF: array Channel Customer Lump-Sum Program Descriptive Flexfields
  Title: Channel Customer Lump-Sum Program Descriptive Flexfields

  The Channel Customer Lump-Sum Program Descriptive Flexfields resource manages additional details for a program.
• DistributionType: string
  Maximum Length: 255

  Distribution type used in the lump-sum program.
• DistributionTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the distribution type used in the lump-sum program.
• 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.
• LumpsumAmount: number
  Lump-sum program amount.
• notes: array Notes
  Title: Notes

  The Notes resource is used to view, create, and update notes.
• Owner: string
  Maximum Length: 255

  Name of the person who owns the customer lump-sum program. This attribute defaults to the name of the person who creates the program.
• OwnerId: integer (int64)
  Value that uniquely identifies the person who owns the customer lump-sum program.
• OwnerPersonNumber: string
  Maximum Length: 255

  Number that uniquely identifies the person who owns the customer lump-sum program.
• productDistributions: array Product Distributions
  Title: Product Distributions

  The Product Distributions resource manages eligible products for a lump-sum program and their amount distribution.
• ProgramId: integer (int64)
  Read Only: true

  Value that uniquely identifies the customer lump-sum program.
• ProgramName: string
  Title: Name

  Maximum Length: 240

  Name of the customer lump-sum program.
• ProgramTemplate: string
  Read Only: true

  Maximum Length: 255

  Name of the predefined program template on which the customer lump-sum program is based. A list of accepted values is defined in the lookup type ORA_CJM_PROGRAM_TYPE.
• ProgramTemplateCode: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the predefined program template on which the customer lump-sum program is based.
• ProgramType: string
  Maximum Length: 255

  Type of program on which the customer lump-sum program is based.
• ProgramTypeId: integer (int64)
  Value that uniquely identifies the type of program on which the customer lump-sum program is based.
• PromotionCode: string
  Maximum Length: 30

  Abbreviation that uniquely identifies the customer lump-sum program.
• RejectedDate: string (date)
  Read Only: true

  Date when the program is rejected.
• StartDate: string (date)
  Read Only: true

  Date from when the program is applicable.
• Status: string
  Maximum Length: 255

  Status of the customer lump-sum program.
• StatusId: integer (int64)
  Value that uniquely identifies the status of the customer lump-sum program.
• SubmittedBy: string
  Read Only: true

  Maximum Length: 255

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

  Date when the program is submitted.
• SystemStatus: string
  Read Only: true

  Maximum Length: 255

  System status of the customer lump-sum program.
• SystemStatusCode: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the system status of the customer lump-sum program.
• SystemStatusId: integer (int64)
  Read Only: true

  Value that uniquely identifies the system status of the customer lump-sum program.

{
    "type":"object",
    "properties":{
        "RejectedDate":{
            "type":"string",
            "description":"Date when the program is rejected.",
            "format":"date",
            "nullable":true,
            "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
        },
        "Owner":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the person who owns the customer lump-sum program. This attribute defaults to the name of the person who creates the program.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the lump-sum program.",
            "nullable":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/channelCustomerLumpSumPrograms-attachments-item-response"
            }
        },
        "notes":{
            "title":"Notes",
            "type":"array",
            "description":"The Notes resource is used to view, create, and update notes.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerLumpSumPrograms-notes-item-response"
            }
        },
        "Customer":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the customer.",
            "nullable":true,
            "x-queryable":true
        },
        "DFF":{
            "title":"Channel Customer Lump-Sum Program Descriptive Flexfields",
            "type":"array",
            "description":"The Channel Customer Lump-Sum Program Descriptive Flexfields resource manages additional details for a program.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerLumpSumPrograms-DFF-item-response"
            }
        },
        "SystemStatusId":{
            "type":"integer",
            "description":"Value that uniquely identifies the system status of the customer lump-sum program.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"255"
            },
            "x-queryable":true
        },
        "SubmittedDate":{
            "type":"string",
            "description":"Date when the program is submitted.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToAccountNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number of the bill-to customer account.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date from when the program is applicable.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the currency used for the customer lump-sum program.",
            "nullable":false,
            "x-queryable":true
        },
        "BillToSite":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the bill-to customer account site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LumpsumAmount":{
            "type":"number",
            "description":"Lump-sum program amount.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the person who owns the customer lump-sum program.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Currency":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the currency used for the customer lump-sum program.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProgramType":{
            "maxLength":"255",
            "type":"string",
            "description":"Type of program on which the customer lump-sum program is based.",
            "nullable":true,
            "x-queryable":true
        },
        "DistributionType":{
            "maxLength":"255",
            "type":"string",
            "description":"Distribution type used in the lump-sum program.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemStatus":{
            "maxLength":"255",
            "type":"string",
            "description":"System status of the customer lump-sum program.",
            "nullable":true,
            "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
        },
        "Status":{
            "maxLength":"255",
            "type":"string",
            "description":"Status of the customer lump-sum program.",
            "nullable":true,
            "x-queryable":true
        },
        "DistributionTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the distribution type used in the lump-sum program.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApprovedDate":{
            "type":"string",
            "description":"Date when the program is approved and moved to active status.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountedLumpsumAmount":{
            "type":"number",
            "description":"Indicates the amount defined for the lump-sum program in the functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramTemplateCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the predefined program template on which the customer lump-sum program is based.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SystemStatusCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the system status of the customer lump-sum program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PromotionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the customer lump-sum program.",
            "nullable":true,
            "x-queryable":true
        },
        "SubmittedBy":{
            "maxLength":"255",
            "type":"string",
            "description":"Name that identifies the user who submitted the program for approval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerPersonNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that uniquely identifies the person who owns the customer lump-sum program.",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer lump-sum program.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProgramName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the customer lump-sum program.",
            "nullable":false,
            "x-queryable":true
        },
        "CustomerType":{
            "maxLength":"255",
            "type":"string",
            "description":"Customer type for the lump-sum program. A list of accepted values is defined in the lookup type ORA_CJM_LS_QUALIFIER.",
            "nullable":true,
            "x-queryable":true
        },
        "productDistributions":{
            "title":"Product Distributions",
            "type":"array",
            "description":"The Product Distributions resource manages eligible products for a lump-sum program and their amount distribution.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerLumpSumPrograms-productDistributions-item-response"
            }
        },
        "BillToSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill-to customer account site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the type of program on which the customer lump-sum program is based.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CustomerTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the customer type for the lump-sum program.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessUnit":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "BillToAccountId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill-to customer.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StatusId":{
            "type":"integer",
            "description":"Value that uniquely identifies the status of the customer lump-sum program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProgramTemplate":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the predefined program template on which the customer lump-sum program is based. A list of accepted values is defined in the lookup type ORA_CJM_PROGRAM_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToSiteAddress":{
            "maxLength":"255",
            "type":"string",
            "description":"Address of the bill-to customer account site.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "CommentsForApprovers":{
            "maxLength":"4000",
            "type":"string",
            "description":"Comments submitted to provide additional information to the approvers.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

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

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

Nested Schema : Channel Customer Lump-Sum Program Descriptive Flexfields

Type: array

Title: Channel Customer Lump-Sum Program Descriptive Flexfields

The Channel Customer Lump-Sum Program Descriptive Flexfields resource manages additional details for a program.

Show Source

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

{
    "title":"Channel Customer Lump-Sum Program Descriptive Flexfields",
    "type":"array",
    "description":"The Channel Customer Lump-Sum Program Descriptive Flexfields resource manages additional details for a program.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerLumpSumPrograms-DFF-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 : Notes

Type: array

Title: Notes

The Notes resource is used to view, create, and update notes.

Show Source

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

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

Nested Schema : Product Distributions

Type: array

Title: Product Distributions

The Product Distributions resource manages eligible products for a lump-sum program and their amount distribution.

Show Source

• Array of: object channelCustomerLumpSumPrograms-productDistributions-item-response

{
    "title":"Product Distributions",
    "type":"array",
    "description":"The Product Distributions resource manages eligible products for a lump-sum program and their amount distribution.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerLumpSumPrograms-productDistributions-item-response"
    }
}

Nested Schema : channelCustomerLumpSumPrograms-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Unique identifier used for tracking the uploaded files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

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

  Maximum Length: 30

  Name of the category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared. The default value is false.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

  User name of the person who uploaded the image.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

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

  Maximum Length: 30

  Default Value: FILE

  Code indicating the type of data in the attachment. For example, FILE, WEB_PAGE, or TEXT.
• Description: string
  Title: Description

  Maximum Length: 255

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

  Unique identifier of the attached document.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  Current version number of the attachment.
• 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

  Code indicating the type of error, 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

  Date when the contents in the attachment expire.
• 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

  URL of the attachment.
• 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 name of the person who last updated the image.
• 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

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

  Name of the attachment file.
• UploadedText: string
  Title: Uploaded Text

  Text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL of the attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  Login associated with the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the attachment record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":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"
            }
        },
        "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
        },
        "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":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"URI of the 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 the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "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
        },
        "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"
            }
        },
        "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"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"User name of the person who uploaded the image.",
            "nullable":true,
            "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"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Length of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Current version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "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
        },
        "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"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"Login associated with the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Code indicating the type of data in the attachment. For example, FILE, WEB_PAGE, or TEXT.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "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"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"User name of the person who last updated the image.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the contents in the attachment expire.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Code indicating the type of error, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"Folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "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
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Unique identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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 : channelCustomerLumpSumPrograms-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Descriptive flexfield context name for the customer lump-sum program.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Descriptive flexfield context display value for the customer lump-sum program.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProgramHeaderId: integer (int64)
  Value that uniquely identifies the customer lump-sum program.

{
    "type":"object",
    "properties":{
        "ProgramHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer lump-sum program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Descriptive flexfield context display value for the customer lump-sum program.",
            "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":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive flexfield context name for the customer lump-sum program.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "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":"HIDDEN"
            },
            "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 : channelCustomerLumpSumPrograms-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 of the note creator.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  Type of currency conversion rate 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
  Title: Primary Email

  Read Only: true

  Maximum Length: 320

  Email address of the user who created the note.
• FormattedAddress: string
  Title: Primary Address

  Read Only: true

  Address of the user who created the note.
• FormattedPhoneNumber: string
  Title: Primary Phone

  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 last updated the record
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  Login of 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

  Unique identifier of the note. It's the primary key of the notes table.
• NoteNumber: string
  Maximum Length: 30

  Alternate unique identifier of the note. A user key that's 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 note text.
• NoteTypeCode: string
  Title: Type

  Maximum Length: 30

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

  Unique identifier of the parent source object associated with the note.
• PartyId: integer (int64)
  Title: Party ID

  Read Only: true

  Unique identifier of 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

  Unique identifier of the parent source object associated with the note.
• 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":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Author",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of currency conversion rate for extensibility.",
            "nullable":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
        },
        "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
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"Currency code for extensibility.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UpdateFlag":{
            "title":"Update Indicator",
            "type":"boolean",
            "description":"Indicates whether the user can update the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Alternate unique identifier of the note. A user key that's system generated or from an external system.",
            "nullable":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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Primary Phone",
            "type":"string",
            "description":"Phone number of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"Corporate currency code for extensibility.",
            "nullable":true,
            "x-queryable":false
        },
        "NoteTxt":{
            "title":"Note",
            "type":"string",
            "description":"Column that stores the note text.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            },
            "x-queryable":true
        },
        "NoteTitle":{
            "title":"Title",
            "maxLength":"500",
            "type":"string",
            "description":"Title of the note entered by the user.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the record",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteId":{
            "title":"Note ID",
            "type":"integer",
            "description":"Unique identifier of the note. It's the primary key of the notes table.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "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
        },
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"Party ID of the note creator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Primary Address",
            "type":"string",
            "description":"Address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteTypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Note type code for categorization of the note.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjectCode"
                ]
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Primary Email",
            "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
        },
        "DeleteFlag":{
            "title":"Delete Indicator",
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":"64",
            "type":"string",
            "description":"Unique identifier of the parent source object associated with the note.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"Unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentNoteId":{
            "title":"Parent Note ID",
            "type":"integer",
            "description":"Unique identifier of the parent source object associated with the note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "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":"Login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "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 : channelCustomerLumpSumPrograms-productDistributions-item-response

Type: object

Show Source

• Amount: number
  Value that identifies the product distribution in amount.
• 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.
• Item: string
  Maximum Length: 255

  Name of the item in the inventory.
• ItemDescription: string
  Maximum Length: 255

  Description of the item in the inventory.
• ItemId: integer (int64)
  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.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login of the user who last updated the record.
• LineNumber: integer (int64)
  Number that indicates the product distribution line.
• LineType: string
  Read Only: true

  Maximum Length: 255

  Level at which product distributions are defined. Valid value includes Item. A list of accepted values is defined in the lookup type ORA_CJM_PROG_ITEM_LEVEL.
• LineTypeCode: string
  Read Only: true

  Maximum Length: 30

  Default Value: ORA_ITEM

  Abbreviation that identifies the level at which product distributions are defined.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Percent: number
  Value that identifies the product distribution in percentage.
• ProductDistributionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the product distribution. It's a primary key that the application generates when it creates the product distribution.
• ProgramId: integer (int64)
  Value that uniquely identifies the customer lump-sum program.

{
    "type":"object",
    "properties":{
        "LineTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the level at which product distributions are defined.",
            "nullable":true,
            "readOnly":true,
            "default":"ORA_ITEM",
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated 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
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Percent":{
            "type":"number",
            "description":"Value that identifies the product distribution in percentage.",
            "nullable":true,
            "x-queryable":false
        },
        "Amount":{
            "type":"number",
            "description":"Value that identifies the product distribution in amount.",
            "nullable":true,
            "x-queryable":false
        },
        "ProductDistributionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the product distribution. It's a primary key that the application generates when it creates the product distribution.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer lump-sum program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item in the inventory.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"Description of the item in the inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "LineNumber":{
            "type":"integer",
            "description":"Number that indicates the product distribution line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Item":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the item in the inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LineType":{
            "maxLength":"255",
            "type":"string",
            "description":"Level at which product distributions are defined. Valid value includes Item. A list of accepted values is defined in the lookup type ORA_CJM_PROG_ITEM_LEVEL.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "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"
    }
}

Back to Top