Get setup data for payment plans

get

/fscmRestApi/resources/11.13.18.05/paymentPlanSetups

Request

Query Parameters
  • 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).
  • 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
  • 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.
    • 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.
    • 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
    • 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.
    • The resource item payload will be filtered in order to contain only data (no links section, for example).
    • 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
    • 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.
    • 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
    • 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".
    • 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

    Default Response

    The following table describes the default response for this task.
    Headers
    • 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".
    • 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
    Nested Schema : Items
    Type: array
    Title: Items
    The items in the collection.
    Show Source
    Nested Schema : paymentPlanSetups-item-response
    Type: object
    Show Source
    • 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.
    • Title: Charge Fee Code
      Maximum Length: 30
      Code that identifies the fee that's charged to payers who enroll in the payment plan.
    • Title: Charge Fee Due Code
      Maximum Length: 30
      Code for the fee due date setting.
    • 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.
    • 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.
    • Title: Charge Fee ID
      Unique identifier of the fee that's charged to payers who enroll in the payment plan.
    • Title: Fee Name
      Read Only: true
      Maximum Length: 50
      Name of the fee charged to payers who enroll in the payment plan.
    • 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.
    • 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.
    • Title: End Date
      The end of the availability date range for a fixed availability plan.
    • 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.
    • Title: End Pivot Direction Code
      Maximum Length: 30
      The code for the direction used in calculating the payment plan availability end date.
    • 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.
    • 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.
    • Title: End Pivot Unit Code
      Maximum Length: 30
      The code for the time unit used in calculating the plan availability end date.
    • 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.
    • Title: Increment
      The number of days weeks or months between the academic period attribute and the calculated plan availability end date.
    • Title: Last Updated
      Read Only: true
      Date the plan was last updated.
    • Links
    • Title: Payment Plan Name
      Maximum Length: 50
      Name of the plan.
    • Title: Notes
      Maximum Length: 1000
      Notes displayed about the payment setup. Notes aren't displayed to payers.
    • Title: Organization ID
      Unique identifier of the business unit.
    • Title: Academic Business Unit
      Maximum Length: 240
      Name of the business unit.
    • Title: Payment Plan Code
      Maximum Length: 30
      Code for the payment plan artifact group. Used in versioning.
    • Title: Payment Plan ID
      Read Only: true
      Unique identifier of the payment plan.
    • Payment Schedules
      Title: Payment Schedules
      The schedules that are applied to a payer's account when they complete enrollment in a payment plan.
    • Title: Plan Availability Code
      Maximum Length: 30
      Code for the plan availability setting.
    • 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.
    • Title: Schedule Due Frequency Code
      Maximum Length: 30
      The code for frequency of plan due dates for a calculated plan.
    • 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.
    • 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.
    • 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.
    • 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.
    • Title: Schedule Due Frequency Quantity
      The number of days, weeks, or months between payment due dates.
    • Title: Plan Availability
      Maximum Length: 30
      The code for the repeat type for monthly payment due dates.
    • 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.
    • 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.
    • 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.
    • 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.
    • 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.
    • Title: Schedule End Date Code
      Maximum Length: 30
      The code for the type of schedule end date.
    • Title: Schedule End Date
      Read Only: true
      Maximum Length: 80
      The method used to calculate when a recurring payment due date schedule should end.
    • Title: Schedule End Pivot Code
      Maximum Length: 30
      The code for the method used to determine when the plan should end.
    • Title: Schedule End Pivot Direction Code
      Maximum Length: 30
      The code for the direction between the pivot date and the end date.
    • 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.
    • 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.
    • 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.
    • 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.
    • 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.
    • 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.
    • 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.
    • Title: Percentage
      The percentage of the first payment in a calculated plan when included fees aren't divided into equal payments.
    • Title: Schedule Start Date
      The earliest date a payment plan can start. Used for plans set to start on a specific date.
    • Title: Plan Availability
      Maximum Length: 30
      The code for the method used to determine the earliest date the plan should start.
    • 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.
    • Title: Plan Availability
      Maximum Length: 30
      The code for the method used to determine when the plan should start.
    • Title: Schedule Start Pivot Direction Code
      Maximum Length: 30
      The code for the direction between the pivot date and the start date.
    • 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.
    • 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.
    • 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.
    • 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.
    • Title: Schedule Start Pivot Unit Quantity
      The number of days, weeks, or months between the pivot date and the plan start date.
    • Title: Schedule Type Code
      Maximum Length: 30
      The code for the type of payment due schedule.
    • 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.
    • Title: Start Date
      The start of the availability date range for a fixed availability plan.
    • 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.
    • Title: Start Pivot Direction Code
      Maximum Length: 30
      The code for the direction used in calculating the payment plan availability start date.
    • 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.
    • 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.
    • Title: Start Pivot Unit Code
      Maximum Length: 30
      The code for the time unit used in calculating the plan availability start date.
    • 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.
    • Title: Start Pivot Unit Quantity
      The number of days weeks, or months between the academic period attribute and the calculated plan availability start date.
    • Title: Status Code
      Maximum Length: 30
      Code for the version status.
    • Title: Status
      Read Only: true
      Maximum Length: 80
      Status of the payment plan. The status can be draft, published, or unpublished.
    • Tag Assignments
      Title: Tag Assignments
      Tags assigned to a plan.
    • Title: Version Description
      Maximum Length: 240
      Description of the payment plan version.
    • Title: Version Name
      Read Only: true
      Maximum Length: 50
      Default Value: test
      Name of the payment plan version.
    • 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 : 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: object
    Show Source
    Nested Schema : paymentPlanSetups-eligibilities-item-response
    Type: object
    Show Source
    • Title: Academic Period ID
      The unique identifier of the academic period that an eligibility is associated with.
    • Title: Academic Period
      Maximum Length: 50
      The name of the academic period that an eligibility is associated with.
    • Title: Charge Priority Code
      Maximum Length: 30
      Code identifying the charge priority mapping used to define eligible fees.
    • Title: Charge Priority ID
      Unique identifier of the charge priority mapping used to define eligible fees.
    • Title: Charge Priority Name
      Read Only: true
      Maximum Length: 50
      Name of the charge priority mapping used to define eligible fees.
    • Eligible Programs
      Title: Eligible Programs
      Program requirements for payment plan eligibility.
    • Title: Eligible Student Code
      Maximum Length: 30
      The code for the eligible student setting.
    • 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
    • Title: Minimum Amount
      The minimum aggregate amount of eligible fees for a payer to enroll in the plan.
    • Title: Plan Eligibility ID
      Read Only: true
      Unique identifier of a plan eligibility configuration.
    • Title: Recalculation Timing Code
      Maximum Length: 30
      The code denoting when to recalculate a plan to include new or increased eligible fees.
    • 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 : paymentPlanSetups-eligibilities-eligiblePrograms-item-response
    Type: object
    Show Source
    Nested Schema : paymentPlanSetups-paymentSchedules-item-response
    Type: object
    Show Source
    Nested Schema : paymentPlanSetups-tagAssignments-item-response
    Type: object
    Show Source
    Back to Top