Jump to

• Request
• Response

Get setup data for payment plans

get

/fscmRestApi/resources/11.13.18.05/paymentPlanSetups

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
  
  

  • EligiblePlanFinder Find the payment plans for which the student is eligible.
    Finder Variables
  • FindByPaymentPlanId Finds payment plan setups that match the specified criteria.
    Finder Variables
    • PaymentPlanId; integer; Finds the payment plan setup with the specified primary key.
  • PrimaryKey Finds payment plan setups that match the specified criteria.
    Finder Variables
    • PaymentPlanId; integer; Finds the payment plan setup with the specified primary key.
• 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:
  

  • ChargeFeeCode; string; Code that identifies the fee that's charged to payers who enroll in the payment plan.
  • ChargeFeeDueCode; string; Code for the fee due date setting.
  • ChargeFeeFlag; boolean; Flag that determines if a fee will be charged to payers who enroll in the payment plan.
  • ChargeFeeId; integer; Unique identifier of the fee that's charged to payers who enroll in the payment plan.
  • ChargeFeeName; string; Name of the fee charged to payers who enroll in the payment plan.
  • CollectSignatureFlag; boolean; Flag that determines if an e-signature is required during the payment plan enrollment process.
  • EndDate; string; The end of the availability date range for a fixed availability plan.
  • EndPivotCode; string; The code for the academic period attribute used as the pivot for the end of the payment plan availability date range.
  • EndPivotDirectionCode; string; The code for the direction used in calculating the payment plan availability end date.
  • EndPivotUnitCode; string; The code for the time unit used in calculating the plan availability end date.
  • EndPivotUnitQuantity; number; The number of days weeks or months between the academic period attribute and the calculated plan availability end date.
  • LastModifiedDate; string; Date the plan was last updated.
  • Name; string; Name of the plan.
  • Notes; string; Notes displayed about the payment setup. Notes aren't displayed to payers.
  • OrganizationId; integer; Unique identifier of the business unit.
  • OrganizationName; string; Name of the business unit.
  • PaymentPlanCode; string; Code for the payment plan artifact group. Used in versioning.
  • PaymentPlanId; integer; Unique identifier of the payment plan.
  • PlanAvailabilityCode; string; Code for the plan availability setting.
  • ScheduleDueFrequencyCode; string; The code for frequency of plan due dates for a calculated plan.
  • ScheduleDueFrequencyDays; string; The days of the week that weekly payments are due. Days are represented as integers. Monday is 1.
  • ScheduleDueFrequencyOrdinalCode; string; The code for the week payments are due when a plan has monthly recurring payments. Values represent the first, second, third, fourth, or last week of the month.
  • ScheduleDueFrequencyQuantity; number; The number of days, weeks, or months between payment due dates.
  • ScheduleDueFrequencyRepeatCode; string; The code for the repeat type for monthly payment due dates.
  • ScheduleDueFrequencyRepeatDate; string; The date a payment is due each month. Used when a custom plan has monthly payments that fall on the same date of the month. When a month has fewer days than the specified date, the payment due date is on the last day of the month.
  • ScheduleDueFrequencyRepeatDayCode; string; The code for the day a payment is due. Used when a custom plan has monthly payments that fall on the same day each month.
  • ScheduleEndDate; string; Date before which all due dates for the payment plan must fall so that included fees are paid-in full by the time the plan ends.
  • ScheduleEndDateCode; string; The code for the type of schedule end date.
  • ScheduleEndPivotCode; string; The code for the method used to determine when the plan should end.
  • ScheduleEndPivotDirectionCode; string; The code for the direction between the pivot date and the end date.
  • ScheduleEndPivotUnitCode; string; The code for the unit of time used when calculating the end date from a pivot date.
  • ScheduleEndPivotUnitQuantity; number; The number of days, weeks, or months between the pivot date and the plan end date, or the number of payments if the plan includes a specific number of payments.
  • ScheduleFirstPaymentAmountCode; string; Code for the method used to determine the amount due on the first due date for calculated plans.
  • ScheduleFirstPaymentPercentage; number; The percentage of the first payment in a calculated plan when included fees aren't divided into equal payments.
  • ScheduleStartDate; string; The earliest date a payment plan can start. Used for plans set to start on a specific date.
  • ScheduleStartDateCode; string; The code for the method used to determine the earliest date the plan should start.
  • ScheduleStartPivotCode; string; The code for the method used to determine when the plan should start.
  • ScheduleStartPivotDirectionCode; string; The code for the direction between the pivot date and the start date.
  • ScheduleStartPivotUnitCode; string; The code for the unit of time used when calculating the start date from a pivot date.
  • ScheduleStartPivotUnitQuantity; number; The number of days, weeks, or months between the pivot date and the plan start date.
  • ScheduleTypeCode; string; The code for the type of payment due schedule.
  • StartDate; string; The start of the availability date range for a fixed availability plan.
  • StartPivotCode; string; The code for the academic period attribute used as the pivot for the start of the payment plan availability date range.
  • StartPivotDirectionCode; string; The code for the direction used in calculating the payment plan availability start date.
  • StartPivotUnitCode; string; The code for the time unit used in calculating the plan availability start date.
  • StartPivotUnitQuantity; number; The number of days weeks, or months between the academic period attribute and the calculated plan availability start date.
  • StatusCode; string; Code for the version status.
  • StatusMeaning; string; Status of the payment plan. The status can be draft, published, or unpublished.
  • VersionDescription; string; Description of the payment plan version.
  • VersionName; string; Name of the payment plan version.
  • VersionNumber; integer; Number of the payment plan version.
• 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: 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 : paymentPlanSetups

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":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/paymentPlanSetups-item-response"
            }
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"HED"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object paymentPlanSetups-item-response

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

Type: object

Show Source

• additionalTexts: array Additional Texts
  Title: Additional Texts

  Rich text fields presented to the payer during enrollment that allow the school to describe the details of the plan and the terms and conditions associated with enrollment in the plan.
• ChargeFeeCode: string
  Title: Charge Fee Code

  Maximum Length: 30

  Code that identifies the fee that's charged to payers who enroll in the payment plan.
• ChargeFeeDueCode: string
  Title: Charge Fee Due Code

  Maximum Length: 30

  Code for the fee due date setting.
• ChargeFeeDueMeaning: string
  Title: Charge Fee Due

  Read Only: true

  Maximum Length: 80

  Description of the fee due date setting. Fees can be due entirely with the first payment, or the fee can be due with each payment and evenly distributed.
• ChargeFeeFlag: boolean
  Title: Charge Fee Flag

  Maximum Length: 1

  Default Value: false

  Flag that determines if a fee will be charged to payers who enroll in the payment plan.
• ChargeFeeId: integer (int64)
  Title: Charge Fee ID

  Unique identifier of the fee that's charged to payers who enroll in the payment plan.
• ChargeFeeName: string
  Title: Fee Name

  Read Only: true

  Maximum Length: 50

  Name of the fee charged to payers who enroll in the payment plan.
• CollectSignatureFlag: boolean
  Title: Collect E-signature

  Maximum Length: 1

  Default Value: false

  Flag that determines if an e-signature is required during the payment plan enrollment process.
• eligibilities: array Eligibility Data
  Title: Eligibility Data

  Eligibility is the criteria that the application uses to determine if a payer is eligible for a particular payment plan.
• EndDate: string (date)
  Title: End Date

  The end of the availability date range for a fixed availability plan.
• EndPivotCode: string
  Title: End Pivot Code

  Maximum Length: 30

  The code for the academic period attribute used as the pivot for the end of the payment plan availability date range.
• EndPivotDirectionCode: string
  Title: End Pivot Direction Code

  Maximum Length: 30

  The code for the direction used in calculating the payment plan availability end date.
• EndPivotDirectionMeaning: string
  Title: End Pivot Direction

  Read Only: true

  Maximum Length: 80

  Determines if the payment plan end date is before or after the selected academic period attribute.
• EndPivotMeaning: string
  Title: End Pivot

  Read Only: true

  Maximum Length: 80

  The name of the academic period attribute used when the application calculates the end of the payment plan availability date range.
• EndPivotUnitCode: string
  Title: End Pivot Unit Code

  Maximum Length: 30

  The code for the time unit used in calculating the plan availability end date.
• EndPivotUnitMeaning: string
  Title: End Pivot Unit

  Read Only: true

  Maximum Length: 80

  The time unit used in calculating the plan availability end date. The calculation can be based on days, weeks, or months.
• EndPivotUnitQuantity: number
  Title: Increment

  The number of days weeks or months between the academic period attribute and the calculated plan availability end date.
• LastModifiedDate: string (date-time)
  Title: Last Updated

  Read Only: true

  Date the plan was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Payment Plan Name

  Maximum Length: 50

  Name of the plan.
• Notes: string
  Title: Notes

  Maximum Length: 1000

  Notes displayed about the payment setup. Notes aren't displayed to payers.
• OrganizationId: integer (int64)
  Title: Organization ID

  Unique identifier of the business unit.
• OrganizationName: string
  Title: Academic Business Unit

  Maximum Length: 240

  Name of the business unit.
• PaymentPlanCode: string
  Title: Payment Plan Code

  Maximum Length: 30

  Code for the payment plan artifact group. Used in versioning.
• PaymentPlanId: integer (int64)
  Title: Payment Plan ID

  Read Only: true

  Unique identifier of the payment plan.
• paymentSchedules: array Payment Schedules
  Title: Payment Schedules

  The schedules that are applied to a payer's account when they complete enrollment in a payment plan.
• PlanAvailabilityCode: string
  Title: Plan Availability Code

  Maximum Length: 30

  Code for the plan availability setting.
• PlanAvailabilityMeaning: string
  Title: Plan Availability

  Read Only: true

  Maximum Length: 80

  Payment plan availability setting. Plans can be available for a fixed date range, or the application can calculate availability for each defined academic period based on a pivot date.
• ScheduleDueFrequencyCode: string
  Title: Schedule Due Frequency Code

  Maximum Length: 30

  The code for frequency of plan due dates for a calculated plan.
• ScheduleDueFrequencyDays: string
  Title: Schedule Due Frequency Days

  Maximum Length: 100

  The days of the week that weekly payments are due. Days are represented as integers. Monday is 1.
• ScheduleDueFrequencyMeaning: string
  Title: Schedule Due Frequency

  Read Only: true

  Maximum Length: 80

  The frequency of plan due dates for a calculated plan. Payment due dates can occur daily, weekly, or monthly.
• ScheduleDueFrequencyOrdinalCode: string
  Title: Schedule Due Frequency Ordinal Code

  Maximum Length: 30

  The code for the week payments are due when a plan has monthly recurring payments. Values represent the first, second, third, fourth, or last week of the month.
• ScheduleDueFrequencyOrdinalMeaning: string
  Title: Schedule Due Frequency Ordinal

  Read Only: true

  Maximum Length: 80

  The week payments are due when a plan has monthly payments that fall on certain days of a week. Possible values are first, second, third, fourth, and last.
• ScheduleDueFrequencyQuantity: number
  Title: Schedule Due Frequency Quantity

  The number of days, weeks, or months between payment due dates.
• ScheduleDueFrequencyRepeatCode: string
  Title: Plan Availability

  Maximum Length: 30

  The code for the repeat type for monthly payment due dates.
• ScheduleDueFrequencyRepeatDate: string (date)
  Title: Schedule Due Frequency Repeat Date

  The date a payment is due each month. Used when a custom plan has monthly payments that fall on the same date of the month. When a month has fewer days than the specified date, the payment due date is on the last day of the month.
• ScheduleDueFrequencyRepeatDayCode: string
  Title: Schedule Due Frequency Repeat Day Code

  Maximum Length: 100

  The code for the day a payment is due. Used when a custom plan has monthly payments that fall on the same day each month.
• ScheduleDueFrequencyRepeatDayMeaning: string
  Title: Schedule Due Frequency Repeat Day

  Read Only: true

  Maximum Length: 80

  The day a payment is due. Used when a custom plan has monthly payments that fall on the same day. For example, the first Monday each month.
• ScheduleDueFrequencyRepeatMeaning: string
  Title: Schedule Due Frequency Repeat

  Read Only: true

  Maximum Length: 80

  The type of repeat for monthly payment due dates. Monthly payments can be due on the same day of the month, for example the first Thursday. Or they can be due on the same date every month. For example, the 20th of the month.
• ScheduleEndDate: string (date)
  Title: Schedule End Date

  Date before which all due dates for the payment plan must fall so that included fees are paid-in full by the time the plan ends.
• ScheduleEndDateCode: string
  Title: Schedule End Date Code

  Maximum Length: 30

  The code for the type of schedule end date.
• ScheduleEndDateMeaning: string
  Title: Schedule End Date

  Read Only: true

  Maximum Length: 80

  The method used to calculate when a recurring payment due date schedule should end.
• ScheduleEndPivotCode: string
  Title: Schedule End Pivot Code

  Maximum Length: 30

  The code for the method used to determine when the plan should end.
• ScheduleEndPivotDirectionCode: string
  Title: Schedule End Pivot Direction Code

  Maximum Length: 30

  The code for the direction between the pivot date and the end date.
• ScheduleEndPivotDirectionMeaning: string
  Title: Schedule End Pivot Direction

  Read Only: true

  Maximum Length: 80

  The direction used in the end date calculation. The end date can be calculated before or after the pivot date.
• ScheduleEndPivotMeaning: string
  Title: End Date Pivot

  Read Only: true

  Maximum Length: 80

  The method used to determine when the plan should end. For custom plans, you can set a specific end date or define a pivot calculation. For calculated plans, you can use a specific date, a pivot calculation, or set the number of payments in the plan.
• ScheduleEndPivotUnitCode: string
  Title: Schedule End Pivot Unit Code

  Maximum Length: 30

  The code for the unit of time used when calculating the end date from a pivot date.
• ScheduleEndPivotUnitMeaning: string
  Title: Schedule End Pivot Unit

  Read Only: true

  Maximum Length: 80

  The unit of time used when calculating the end date from a pivot date. There can be days, weeks, or months between the pivot date and the end date.
• ScheduleEndPivotUnitQuantity: number
  Title: Schedule End Pivot Unit Quantity

  The number of days, weeks, or months between the pivot date and the plan end date, or the number of payments if the plan includes a specific number of payments.
• ScheduleFirstPaymentAmountCode: string
  Title: Schedule First Payment Amount Code

  Maximum Length: 30

  Code for the method used to determine the amount due on the first due date for calculated plans.
• ScheduleFirstPaymentAmountMeaning: string
  Title: First Payment Amount

  Read Only: true

  Maximum Length: 80

  Calculated plans can be set to divide included fees into equal payments or to calculate a smaller or larger percentage for the first payment.
• ScheduleFirstPaymentPercentage: number
  Title: Percentage

  The percentage of the first payment in a calculated plan when included fees aren't divided into equal payments.
• ScheduleStartDate: string (date)
  Title: Schedule Start Date

  The earliest date a payment plan can start. Used for plans set to start on a specific date.
• ScheduleStartDateCode: string
  Title: Plan Availability

  Maximum Length: 30

  The code for the method used to determine the earliest date the plan should start.
• ScheduleStartDateMeaning: string
  Title: Plan Availability

  Read Only: true

  Maximum Length: 80

  The method used to determine the earliest date the plan should start. For custom plans, you can set a specific start date or define a pivot calculation. For calculated plans, you can use a specific date, a pivot calculation, or set the number of payments in the plan.
• ScheduleStartPivotCode: string
  Title: Plan Availability

  Maximum Length: 30

  The code for the method used to determine when the plan should start.
• ScheduleStartPivotDirectionCode: string
  Title: Schedule Start Pivot Direction Code

  Maximum Length: 30

  The code for the direction between the pivot date and the start date.
• ScheduleStartPivotDirectionMeaning: string
  Title: Schedule Start Pivot Direction

  Read Only: true

  Maximum Length: 80

  The direction used in the start date calculation. The start date can be calculated before or after the pivot date.
• ScheduleStartPivotMeaning: string
  Title: Plan Availability

  Read Only: true

  Maximum Length: 80

  The method used to determine when the plan should end. For custom plans, you can set a specific start date or define a pivot calculation. For calculated plans, you can use a specific date, a pivot calculation, or set the number of payments in the plan.
• ScheduleStartPivotUnitCode: string
  Title: Schedule Start Pivot Unit Code

  Maximum Length: 30

  The code for the unit of time used when calculating the start date from a pivot date.
• ScheduleStartPivotUnitMeaning: string
  Title: Schedule Start Pivot Unit

  Read Only: true

  Maximum Length: 80

  The unit of time used when calculating the start date from a pivot date. There can be days, weeks, or months between the pivot date and the start date.
• ScheduleStartPivotUnitQuantity: number
  Title: Schedule Start Pivot Unit Quantity

  The number of days, weeks, or months between the pivot date and the plan start date.
• ScheduleTypeCode: string
  Title: Schedule Type Code

  Maximum Length: 30

  The code for the type of payment due schedule.
• ScheduleTypeMeaning: string
  Title: Schedule Type

  Read Only: true

  Maximum Length: 80

  Type of payment plan schedule. Schedules can be based on fixed dates, a general recurrence pattern, or a student-specific recurrence pattern.
• StartDate: string (date)
  Title: Start Date

  The start of the availability date range for a fixed availability plan.
• StartPivotCode: string
  Title: Start Pivot Code

  Maximum Length: 30

  The code for the academic period attribute used as the pivot for the start of the payment plan availability date range.
• StartPivotDirectionCode: string
  Title: Start Pivot Direction Code

  Maximum Length: 30

  The code for the direction used in calculating the payment plan availability start date.
• StartPivotDirectionMeaning: string
  Title: Start Pivot Direction Code

  Read Only: true

  Maximum Length: 80

  Determines if the payment plan start date is before or after the selected academic period attribute.
• StartPivotMeaning: string
  Title: Start Pivot

  Read Only: true

  Maximum Length: 80

  The name of the academic period attribute used when the application calculates the start of the payment plan availability date range.
• StartPivotUnitCode: string
  Title: Start Pivot Unit Code

  Maximum Length: 30

  The code for the time unit used in calculating the plan availability start date.
• StartPivotUnitMeaning: string
  Title: Start Pivot Unit

  Read Only: true

  Maximum Length: 80

  The time unit used in calculating the plan availability start date. The calculation can be based on days, weeks, or months.
• StartPivotUnitQuantity: number
  Title: Start Pivot Unit Quantity

  The number of days weeks, or months between the academic period attribute and the calculated plan availability start date.
• StatusCode: string
  Title: Status Code

  Maximum Length: 30

  Code for the version status.
• StatusMeaning: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  Status of the payment plan. The status can be draft, published, or unpublished.
• tagAssignments: array Tag Assignments
  Title: Tag Assignments

  Tags assigned to a plan.
• VersionDescription: string
  Title: Version Description

  Maximum Length: 240

  Description of the payment plan version.
• VersionName: string
  Title: Version Name

  Read Only: true

  Maximum Length: 50

  Default Value: test

  Name of the payment plan version.
• VersionNumber: integer (int32)
  Title: Version Number

  Read Only: true

  Default Value: 1

  Number of the payment plan version.

{
    "type":"object",
    "properties":{
        "ChargeFeeCode":{
            "title":"Charge Fee Code",
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the fee that's charged to payers who enroll in the payment plan.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "OrganizationName"
                ]
            },
            "x-queryable":true
        },
        "ChargeFeeDueCode":{
            "title":"Charge Fee Due Code",
            "maxLength":30,
            "type":"string",
            "description":"Code for the fee due date setting.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChargeFeeDueMeaning":{
            "title":"Charge Fee Due",
            "maxLength":80,
            "type":"string",
            "description":"Description of the fee due date setting. Fees can be due entirely with the first payment, or the fee can be due with each payment and evenly distributed.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ChargeFeeFlag":{
            "title":"Charge Fee Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Flag that determines if a fee will be charged to payers who enroll in the payment plan.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ChargeFeeId":{
            "title":"Charge Fee ID",
            "type":"integer",
            "description":"Unique identifier of the fee that's charged to payers who enroll in the payment plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ChargeFeeCode"
                ]
            },
            "x-queryable":true
        },
        "ChargeFeeName":{
            "title":"Fee Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the fee charged to payers who enroll in the payment plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CollectSignatureFlag":{
            "title":"Collect E-signature",
            "maxLength":1,
            "type":"boolean",
            "description":"Flag that determines if an e-signature is required during the payment plan enrollment process.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end of the availability date range for a fixed availability plan.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EndPivotCode":{
            "title":"End Pivot Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the academic period attribute used as the pivot for the end of the payment plan availability date range.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndPivotDirectionCode":{
            "title":"End Pivot Direction Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the direction used in calculating the payment plan availability end date.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndPivotDirectionMeaning":{
            "title":"End Pivot Direction",
            "maxLength":80,
            "type":"string",
            "description":"Determines if the payment plan end date is before or after the selected academic period attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "EndPivotMeaning":{
            "title":"End Pivot",
            "maxLength":80,
            "type":"string",
            "description":"The name of the academic period attribute used when the application calculates the end of the payment plan availability date range.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "EndPivotUnitCode":{
            "title":"End Pivot Unit Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the time unit used in calculating the plan availability end date.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndPivotUnitMeaning":{
            "title":"End Pivot Unit",
            "maxLength":80,
            "type":"string",
            "description":"The time unit used in calculating the plan availability end date. The calculation can be based on days, weeks, or months.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "EndPivotUnitQuantity":{
            "title":"Increment",
            "type":"number",
            "description":"The number of days weeks or months between the academic period attribute and the calculated plan availability end date.",
            "nullable":true,
            "x-queryable":true
        },
        "LastModifiedDate":{
            "title":"Last Updated",
            "type":"string",
            "description":"Date the plan was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Payment Plan Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the plan.",
            "nullable":false,
            "x-queryable":true
        },
        "Notes":{
            "title":"Notes",
            "maxLength":1000,
            "type":"string",
            "description":"Notes displayed about the payment setup. Notes aren't displayed to payers.",
            "nullable":false,
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Organization ID",
            "type":"integer",
            "description":"Unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "OrganizationName"
                ]
            },
            "x-queryable":true
        },
        "OrganizationName":{
            "title":"Academic Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"Name of the business unit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PaymentPlanCode":{
            "title":"Payment Plan Code",
            "maxLength":30,
            "type":"string",
            "description":"Code for the payment plan artifact group. Used in versioning.",
            "nullable":false,
            "x-queryable":true
        },
        "PaymentPlanId":{
            "title":"Payment Plan ID",
            "type":"integer",
            "description":"Unique identifier of the payment plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PlanAvailabilityCode":{
            "title":"Plan Availability Code",
            "maxLength":30,
            "type":"string",
            "description":"Code for the plan availability setting.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PlanAvailabilityMeaning":{
            "title":"Plan Availability",
            "maxLength":80,
            "type":"string",
            "description":"Payment plan availability setting. Plans can be available for a fixed date range, or the application can calculate availability for each defined academic period based on a pivot date.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduleDueFrequencyCode":{
            "title":"Schedule Due Frequency Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for frequency of plan due dates for a calculated plan.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScheduleDueFrequencyDays":{
            "title":"Schedule Due Frequency Days",
            "maxLength":100,
            "type":"string",
            "description":"The days of the week that weekly payments are due. Days are represented as integers. Monday is 1.",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduleDueFrequencyMeaning":{
            "title":"Schedule Due Frequency",
            "maxLength":80,
            "type":"string",
            "description":"The frequency of plan due dates for a calculated plan. Payment due dates can occur daily, weekly, or monthly.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduleDueFrequencyOrdinalCode":{
            "title":"Schedule Due Frequency Ordinal Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the week payments are due when a plan has monthly recurring payments. Values represent the first, second, third, fourth, or last week of the month.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScheduleDueFrequencyOrdinalMeaning":{
            "title":"Schedule Due Frequency Ordinal",
            "maxLength":80,
            "type":"string",
            "description":"The week payments are due when a plan has monthly payments that fall on certain days of a week. Possible values are first, second, third, fourth, and last.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduleDueFrequencyQuantity":{
            "title":"Schedule Due Frequency Quantity",
            "type":"number",
            "description":"The number of days, weeks, or months between payment due dates.",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduleDueFrequencyRepeatCode":{
            "title":"Plan Availability",
            "maxLength":30,
            "type":"string",
            "description":"The code for the repeat type for monthly payment due dates.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScheduleDueFrequencyRepeatDate":{
            "title":"Schedule Due Frequency Repeat Date",
            "type":"string",
            "description":"The date a payment is due each month. Used when a custom plan has monthly payments that fall on the same date of the month. When a month has fewer days than the specified date, the payment due date is on the last day of the month.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduleDueFrequencyRepeatDayCode":{
            "title":"Schedule Due Frequency Repeat Day Code",
            "maxLength":100,
            "type":"string",
            "description":"The code for the day a payment is due. Used when a custom plan has monthly payments that fall on the same day each month.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScheduleDueFrequencyRepeatDayMeaning":{
            "title":"Schedule Due Frequency Repeat Day",
            "maxLength":80,
            "type":"string",
            "description":"The day a payment is due. Used when a custom plan has monthly payments that fall on the same day. For example, the first Monday each month.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduleDueFrequencyRepeatMeaning":{
            "title":"Schedule Due Frequency Repeat",
            "maxLength":80,
            "type":"string",
            "description":"The type of repeat for monthly payment due dates. Monthly payments can be due on the same day of the month, for example the first Thursday. Or they can be due on the same date every month. For example, the 20th of the month.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduleEndDate":{
            "title":"Schedule End Date",
            "type":"string",
            "description":"Date before which all due dates for the payment plan must fall so that included fees are paid-in full by the time the plan ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduleEndDateCode":{
            "title":"Schedule End Date Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the type of schedule end date.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScheduleEndDateMeaning":{
            "title":"Schedule End Date",
            "maxLength":80,
            "type":"string",
            "description":"The method used to calculate when a recurring payment due date schedule should end.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduleEndPivotCode":{
            "title":"Schedule End Pivot Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the method used to determine when the plan should end.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScheduleEndPivotDirectionCode":{
            "title":"Schedule End Pivot Direction Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the direction between the pivot date and the end date.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScheduleEndPivotDirectionMeaning":{
            "title":"Schedule End Pivot Direction",
            "maxLength":80,
            "type":"string",
            "description":"The direction used in the end date calculation. The end date can be calculated before or after the pivot date.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduleEndPivotMeaning":{
            "title":"End Date Pivot",
            "maxLength":80,
            "type":"string",
            "description":"The method used to determine when the plan should end. For custom plans, you can set a specific end date or define a pivot calculation. For calculated plans, you can use a specific date, a pivot calculation, or set the number of payments in the plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduleEndPivotUnitCode":{
            "title":"Schedule End Pivot Unit Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the unit of time used when calculating the end date from a pivot date.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScheduleEndPivotUnitMeaning":{
            "title":"Schedule End Pivot Unit",
            "maxLength":80,
            "type":"string",
            "description":"The unit of time used when calculating the end date from a pivot date. There can be days, weeks, or months between the pivot date and the end date.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduleEndPivotUnitQuantity":{
            "title":"Schedule End Pivot Unit Quantity",
            "type":"number",
            "description":"The number of days, weeks, or months between the pivot date and the plan end date, or the number of payments if the plan includes a specific number of payments.",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduleFirstPaymentAmountCode":{
            "title":"Schedule First Payment Amount Code",
            "maxLength":30,
            "type":"string",
            "description":"Code for the method used to determine the amount due on the first due date for calculated plans.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScheduleFirstPaymentAmountMeaning":{
            "title":"First Payment Amount",
            "maxLength":80,
            "type":"string",
            "description":"Calculated plans can be set to divide included fees into equal payments or to calculate a smaller or larger percentage for the first payment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduleFirstPaymentPercentage":{
            "title":"Percentage",
            "type":"number",
            "description":"The percentage of the first payment in a calculated plan when included fees aren't divided into equal payments.",
            "nullable":true,
            "x-hints":{
                "precision":5,
                "scale":2
            },
            "x-queryable":true
        },
        "ScheduleStartDate":{
            "title":"Schedule Start Date",
            "type":"string",
            "description":"The earliest date a payment plan can start. Used for plans set to start on a specific date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduleStartDateCode":{
            "title":"Plan Availability",
            "maxLength":30,
            "type":"string",
            "description":"The code for the method used to determine the earliest date the plan should start.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScheduleStartDateMeaning":{
            "title":"Plan Availability",
            "maxLength":80,
            "type":"string",
            "description":"The method used to determine the earliest date the plan should start. For custom plans, you can set a specific start date or define a pivot calculation. For calculated plans, you can use a specific date, a pivot calculation, or set the number of payments in the plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduleStartPivotCode":{
            "title":"Plan Availability",
            "maxLength":30,
            "type":"string",
            "description":"The code for the method used to determine when the plan should start.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScheduleStartPivotDirectionCode":{
            "title":"Schedule Start Pivot Direction Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the direction between the pivot date and the start date.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScheduleStartPivotDirectionMeaning":{
            "title":"Schedule Start Pivot Direction",
            "maxLength":80,
            "type":"string",
            "description":"The direction used in the start date calculation. The start date can be calculated before or after the pivot date.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduleStartPivotMeaning":{
            "title":"Plan Availability",
            "maxLength":80,
            "type":"string",
            "description":"The method used to determine when the plan should end. For custom plans, you can set a specific start date or define a pivot calculation. For calculated plans, you can use a specific date, a pivot calculation, or set the number of payments in the plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduleStartPivotUnitCode":{
            "title":"Schedule Start Pivot Unit Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the unit of time used when calculating the start date from a pivot date.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScheduleStartPivotUnitMeaning":{
            "title":"Schedule Start Pivot Unit",
            "maxLength":80,
            "type":"string",
            "description":"The unit of time used when calculating the start date from a pivot date. There can be days, weeks, or months between the pivot date and the start date.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduleStartPivotUnitQuantity":{
            "title":"Schedule Start Pivot Unit Quantity",
            "type":"number",
            "description":"The number of days, weeks, or months between the pivot date and the plan start date.",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduleTypeCode":{
            "title":"Schedule Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the type of payment due schedule.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScheduleTypeMeaning":{
            "title":"Schedule Type",
            "maxLength":80,
            "type":"string",
            "description":"Type of payment plan schedule. Schedules can be based on fixed dates, a general recurrence pattern, or a student-specific recurrence pattern.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start of the availability date range for a fixed availability plan.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "StartPivotCode":{
            "title":"Start Pivot Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the academic period attribute used as the pivot for the start of the payment plan availability date range.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StartPivotDirectionCode":{
            "title":"Start Pivot Direction Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the direction used in calculating the payment plan availability start date.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StartPivotDirectionMeaning":{
            "title":"Start Pivot Direction Code",
            "maxLength":80,
            "type":"string",
            "description":"Determines if the payment plan start date is before or after the selected academic period attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "StartPivotMeaning":{
            "title":"Start Pivot",
            "maxLength":80,
            "type":"string",
            "description":"The name of the academic period attribute used when the application calculates the start of the payment plan availability date range.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "StartPivotUnitCode":{
            "title":"Start Pivot Unit Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the time unit used in calculating the plan availability start date.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StartPivotUnitMeaning":{
            "title":"Start Pivot Unit",
            "maxLength":80,
            "type":"string",
            "description":"The time unit used in calculating the plan availability start date. The calculation can be based on days, weeks, or months.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "StartPivotUnitQuantity":{
            "title":"Start Pivot Unit Quantity",
            "type":"number",
            "description":"The number of days weeks, or months between the academic period attribute and the calculated plan availability start date.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Code for the version status.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"Status of the payment plan. The status can be draft, published, or unpublished.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VersionDescription":{
            "title":"Version Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the payment plan version.",
            "nullable":true,
            "x-queryable":true
        },
        "VersionName":{
            "title":"Version Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the payment plan version.",
            "nullable":false,
            "readOnly":true,
            "default":"test",
            "x-queryable":true
        },
        "VersionNumber":{
            "title":"Version Number",
            "type":"integer",
            "description":"Number of the payment plan version.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":1,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "additionalTexts":{
            "title":"Additional Texts",
            "type":"array",
            "description":"Rich text fields presented to the payer during enrollment that allow the school to describe the details of the plan and the terms and conditions associated with enrollment in the plan.",
            "items":{
                "$ref":"#/components/schemas/paymentPlanSetups-additionalTexts-item-response"
            }
        },
        "eligibilities":{
            "title":"Eligibility Data",
            "type":"array",
            "description":"Eligibility is the criteria that the application uses to determine if a payer is eligible for a particular payment plan.",
            "items":{
                "$ref":"#/components/schemas/paymentPlanSetups-eligibilities-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "paymentSchedules":{
            "title":"Payment Schedules",
            "type":"array",
            "description":"The schedules that are applied to a payer's account when they complete enrollment in a payment plan.",
            "items":{
                "$ref":"#/components/schemas/paymentPlanSetups-paymentSchedules-item-response"
            }
        },
        "tagAssignments":{
            "title":"Tag Assignments",
            "type":"array",
            "description":"Tags assigned to a plan.",
            "items":{
                "$ref":"#/components/schemas/paymentPlanSetups-tagAssignments-item-response"
            }
        }
    }
}

Nested Schema : Additional Texts

Type: array

Title: Additional Texts

Rich text fields presented to the payer during enrollment that allow the school to describe the details of the plan and the terms and conditions associated with enrollment in the plan.

Show Source

• Array of: object paymentPlanSetups-additionalTexts-item-response

{
    "title":"Additional Texts",
    "type":"array",
    "description":"Rich text fields presented to the payer during enrollment that allow the school to describe the details of the plan and the terms and conditions associated with enrollment in the plan.",
    "items":{
        "$ref":"#/components/schemas/paymentPlanSetups-additionalTexts-item-response"
    }
}

Nested Schema : Eligibility Data

Type: array

Title: Eligibility Data

Eligibility is the criteria that the application uses to determine if a payer is eligible for a particular payment plan.

Show Source

• Array of: object paymentPlanSetups-eligibilities-item-response

{
    "title":"Eligibility Data",
    "type":"array",
    "description":"Eligibility is the criteria that the application uses to determine if a payer is eligible for a particular payment plan.",
    "items":{
        "$ref":"#/components/schemas/paymentPlanSetups-eligibilities-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 : Payment Schedules

Type: array

Title: Payment Schedules

The schedules that are applied to a payer's account when they complete enrollment in a payment plan.

Show Source

• Array of: object paymentPlanSetups-paymentSchedules-item-response

{
    "title":"Payment Schedules",
    "type":"array",
    "description":"The schedules that are applied to a payer's account when they complete enrollment in a payment plan.",
    "items":{
        "$ref":"#/components/schemas/paymentPlanSetups-paymentSchedules-item-response"
    }
}

Nested Schema : Tag Assignments

Type: array

Title: Tag Assignments

Tags assigned to a plan.

Show Source

• Array of: object paymentPlanSetups-tagAssignments-item-response

{
    "title":"Tag Assignments",
    "type":"array",
    "description":"Tags assigned to a plan.",
    "items":{
        "$ref":"#/components/schemas/paymentPlanSetups-tagAssignments-item-response"
    }
}

Nested Schema : paymentPlanSetups-additionalTexts-item-response

Type: object

Show Source

• AdditionalTextTypeCode: string
  Title: Additional Text Type Code

  Maximum Length: 30

  The code for the type of descriptive text.
• AdditionalTextTypeMeaning: string
  Title: Additional Text Type

  Read Only: true

  Maximum Length: 80

  The type of descriptive rich-text provided to payers during enrollment. Text can be a summary, a longer plain-language description, or formal terms and condition.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlanAdditionalTextId: integer (int64)
  Title: Plan Additional Text ID

  Read Only: true

  The unique identifier of a rich-text field describing the plan or plan terms and conditions.
• Sequence: integer (int32)
  Title: Sequence

  Default Value: 1

  The sequence of the descriptive text.
• TextContent: string (byte)
  Title: Text Content

  The content of the descriptive text.

{
    "type":"object",
    "properties":{
        "AdditionalTextTypeCode":{
            "title":"Additional Text Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the type of descriptive text.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdditionalTextTypeMeaning":{
            "title":"Additional Text Type",
            "maxLength":80,
            "type":"string",
            "description":"The type of descriptive rich-text provided to payers during enrollment. Text can be a summary, a longer plain-language description, or formal terms and condition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PlanAdditionalTextId":{
            "title":"Plan Additional Text ID",
            "type":"integer",
            "description":"The unique identifier of a rich-text field describing the plan or plan terms and conditions.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Sequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence of the descriptive text.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "TextContent":{
            "title":"Text Content",
            "type":"string",
            "description":"The content of the descriptive text.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : paymentPlanSetups-eligibilities-item-response

Type: object

Show Source

• AcademicPeriodId: integer (int64)
  Title: Academic Period ID

  The unique identifier of the academic period that an eligibility is associated with.
• AcademicPeriodName: string
  Title: Academic Period

  Maximum Length: 50

  The name of the academic period that an eligibility is associated with.
• ChargePriorityCode: string
  Title: Charge Priority Code

  Maximum Length: 30

  Code identifying the charge priority mapping used to define eligible fees.
• ChargePriorityId: integer (int64)
  Title: Charge Priority ID

  Unique identifier of the charge priority mapping used to define eligible fees.
• ChargePriorityName: string
  Title: Charge Priority Name

  Read Only: true

  Maximum Length: 50

  Name of the charge priority mapping used to define eligible fees.
• eligiblePrograms: array Eligible Programs
  Title: Eligible Programs

  Program requirements for payment plan eligibility.
• EligibleStudentCode: string
  Title: Eligible Student Code

  Maximum Length: 30

  The code for the eligible student setting.
• EligibleStudentMeaning: string
  Title: Eligible Student

  Read Only: true

  Maximum Length: 80

  The eligible student setting for each associated academic period. All students with qualifying fees might be eligible, or the plan can be set to require a student to be active or not active on a program or a list of programs.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MinimumAmount: number
  Title: Minimum Amount

  The minimum aggregate amount of eligible fees for a payer to enroll in the plan.
• PlanEligibilityId: integer (int64)
  Title: Plan Eligibility ID

  Read Only: true

  Unique identifier of a plan eligibility configuration.
• RecalculationTimingCode: string
  Title: Recalculation Timing Code

  Maximum Length: 30

  The code denoting when to recalculate a plan to include new or increased eligible fees.
• RecalculationTimingMeaning: string
  Title: Recalculation Timing

  Read Only: true

  Maximum Length: 80

  When a payment plan is recalculated to include new or increased eligible fees. Options are to always include new fees, to include them after the payer has given permission, or to never include them.

{
    "type":"object",
    "properties":{
        "AcademicPeriodId":{
            "title":"Academic Period ID",
            "type":"integer",
            "description":"The unique identifier of the academic period that an eligibility is associated with.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AcademicPeriodName":{
            "title":"Academic Period",
            "maxLength":50,
            "type":"string",
            "description":"The name of the academic period that an eligibility is associated with.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChargePriorityCode":{
            "title":"Charge Priority Code",
            "maxLength":30,
            "type":"string",
            "description":"Code identifying the charge priority mapping used to define eligible fees.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChargePriorityId":{
            "title":"Charge Priority ID",
            "type":"integer",
            "description":"Unique identifier of the charge priority mapping used to define eligible fees.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ChargePriorityCode"
                ]
            },
            "x-queryable":true
        },
        "ChargePriorityName":{
            "title":"Charge Priority Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the charge priority mapping used to define eligible fees.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EligibleStudentCode":{
            "title":"Eligible Student Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the eligible student setting.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EligibleStudentMeaning":{
            "title":"Eligible Student",
            "maxLength":80,
            "type":"string",
            "description":"The eligible student setting for each associated academic period. All students with qualifying fees might be eligible, or the plan can be set to require a student to be active or not active on a program or a list of programs.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "MinimumAmount":{
            "title":"Minimum Amount",
            "type":"number",
            "description":"The minimum aggregate amount of eligible fees for a payer to enroll in the plan.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanEligibilityId":{
            "title":"Plan Eligibility ID",
            "type":"integer",
            "description":"Unique identifier of a plan eligibility configuration.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RecalculationTimingCode":{
            "title":"Recalculation Timing Code",
            "maxLength":30,
            "type":"string",
            "description":"The code denoting when to recalculate a plan to include new or increased eligible fees.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RecalculationTimingMeaning":{
            "title":"Recalculation Timing",
            "maxLength":80,
            "type":"string",
            "description":"When a payment plan is recalculated to include new or increased eligible fees. Options are to always include new fees, to include them after the payer has given permission, or to never include them.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "eligiblePrograms":{
            "title":"Eligible Programs",
            "type":"array",
            "description":"Program requirements for payment plan eligibility.",
            "items":{
                "$ref":"#/components/schemas/paymentPlanSetups-eligibilities-eligiblePrograms-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Eligible Programs

Type: array

Title: Eligible Programs

Program requirements for payment plan eligibility.

Show Source

• Array of: object paymentPlanSetups-eligibilities-eligiblePrograms-item-response

{
    "title":"Eligible Programs",
    "type":"array",
    "description":"Program requirements for payment plan eligibility.",
    "items":{
        "$ref":"#/components/schemas/paymentPlanSetups-eligibilities-eligiblePrograms-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 : paymentPlanSetups-eligibilities-eligiblePrograms-item-response

Type: object

Show Source

• CurriculumId: integer (int64)
  Title: Curriculum ID

  Unique identifier of a curriculum for an eligible or ineligible program.
• CurriculumName: string
  Title: Curriculum Name

  Maximum Length: 255

  Name of an eligible or ineligible program.
• EligibleProgramId: integer (int64)
  Title: Eligible Program ID

  Read Only: true

  Unique Identifier of a program included or excluded from eligibility in the plan. Used when the eligible student's setting isn't All Students.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"Unique identifier of a curriculum for an eligible or ineligible program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "CurriculumName"
                ]
            },
            "x-queryable":true
        },
        "CurriculumName":{
            "title":"Curriculum Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of an eligible or ineligible program.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EligibleProgramId":{
            "title":"Eligible Program ID",
            "type":"integer",
            "description":"Unique Identifier of a program included or excluded from eligibility in the plan. Used when the eligible student's setting isn't All Students.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "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 : paymentPlanSetups-paymentSchedules-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PaymentDate: string (date)
  Title: Payment Date

  Specific date of a payment for a fixed dates schedule.
• PaymentScheduleId: integer (int64)
  Title: Payment Schedule ID

  Read Only: true

  Unique identifier of a fixed-dates payment plan schedule.
• Percentage: number
  Title: Percentage

  Percentage allocated to a payment in a fixed dates schedule

{
    "type":"object",
    "properties":{
        "PaymentDate":{
            "title":"Payment Date",
            "type":"string",
            "description":"Specific date of a payment for a fixed dates schedule.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentScheduleId":{
            "title":"Payment Schedule ID",
            "type":"integer",
            "description":"Unique identifier of a fixed-dates payment plan schedule.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Percentage":{
            "title":"Percentage",
            "type":"number",
            "description":"Percentage allocated to a payment in a fixed dates schedule",
            "nullable":true,
            "x-hints":{
                "precision":5,
                "scale":2
            },
            "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 : paymentPlanSetups-tagAssignments-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TagAssignmentId: integer (int64)
  Title: Tag Assignment ID

  Unique identifier of the assignment of a tag to the payment plan.
• TagCode: string
  Title: Tag Code

  Maximum Length: 30

  Code of a tag assigned to a payment plan.
• TagId: integer (int64)
  Title: Tag ID

  Unique identifier of a tag assigned to the payment plan.
• TagName: string
  Title: Tag Name

  Read Only: true

  Maximum Length: 64

  Name of a tag assigned to a payment plan.

{
    "type":"object",
    "properties":{
        "TagAssignmentId":{
            "title":"Tag Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the assignment of a tag to the payment plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TagCode":{
            "title":"Tag Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of a tag assigned to a payment plan.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TagId":{
            "title":"Tag ID",
            "type":"integer",
            "description":"Unique identifier of a tag assigned to the payment plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TagName":{
            "title":"Tag Name",
            "maxLength":64,
            "type":"string",
            "description":"Name of a tag assigned to a payment plan.",
            "nullable":false,
            "readOnly":true,
            "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"
    }
}

Back to Top