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.
- EligiblePlanFinder Find the payment plans for which the student is eligible.
-
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : paymentPlanSetups
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : paymentPlanSetups-item-response
Type:
Show Source
object
-
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.
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
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
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
Nested Schema : Tag Assignments
Type:
array
Title:
Tag Assignments
Tags assigned to a plan.
Show Source
Nested Schema : paymentPlanSetups-additionalTexts-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : paymentPlanSetups-eligibilities-item-response
Type:
Show Source
object
-
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.
Nested Schema : Eligible Programs
Type:
array
Title:
Eligible Programs
Program requirements for payment plan eligibility.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : paymentPlanSetups-eligibilities-eligiblePrograms-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : paymentPlanSetups-paymentSchedules-item-response
Type:
Show Source
object
-
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
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : paymentPlanSetups-tagAssignments-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source