Get all payment plan enrollments

get

/fscmRestApi/resources/11.13.18.05/paymentPlanEnrollments

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

    • PrimaryKey Finds all plan enrollments that match the specified criteria.
      Finder Variables
      • PlanEnrollmentId; integer; The unique identifier for the payment plan enrollment.
    • findByPlanEnrollmentID Finds all payment plan enrollments that match the specified enrollment ID.
      Finder Variables
      • PlanEnrollmentId; integer; Unique identifier of the payment plan enrollment.
  • 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:
    • CustomerAccountNumbers; string; Customer account number for the transactions included in the payment plan.
    • EmailAddress; string; Email address for the student enrolled in the payment plan.
    • EnrollmentDate; string; Date the student enrolled in the payment plan.
    • PartyId; integer; The party ID of the student enrolled in the payment plan.
    • PartyName; string; The name of the student enrolled in the payment plan.
    • PaymentPlanCode; string; Code for the payment plan.
    • PaymentPlanId; integer; Unique identifier of the payment plan.
    • PaymentPlanName; string; Name of the payment plan.
    • PlanEnrollmentId; integer; Unique identifier of the payment plan enrollment.
    • PlanStatusCode; string; Payment plan status code, for example enrolled, paid, or past due. A list of accepted values is defined in the lookup type ORA_HES_PAYMENT_PLAN_STATUS.
    • PlanStatusMeaning; string; The meaning of the current payment plan status code. A list of accepted values is defined in the lookup type ORA_HES_PAYMENT_PLAN_STATUS.
    • StatusCode; string; Payment plan version status code, for example, published, unpublished, or draft. A list of accepted values is defined in the lookup type ORA_HEY_VERSION_STATUS.
    • StatusMeaning; string; The meaning of the current payment plan version status code. A list of accepted values is defined in the lookup type ORA_HEY_VERSION_STATUS.
  • 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 : paymentPlanEnrollments
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : paymentPlanEnrollments-item-response
Type: object
Show Source
  • Title: Customer Account Numbers
    Read Only: true
    Maximum Length: 255
    Customer account number for the transactions included in the payment plan.
  • Title: Email Address
    Read Only: true
    Maximum Length: 255
    Email address for the student enrolled in the payment plan.
  • Title: Enrollment Date
    Read Only: true
    Date the student enrolled in the payment plan.
  • Invoices
    Title: Invoices
    Invoices included in the payment plan.
  • Links
  • Title: Party ID
    The party ID of the student enrolled in the payment plan.
  • Title: Party Name
    Read Only: true
    Maximum Length: 255
    The name of the student enrolled in the payment plan.
  • Title: Payment Plan Code
    Maximum Length: 30
    Code for the payment plan.
  • Title: Payment Plan ID
    Unique identifier of the payment plan.
  • Title: Payment Plan Name
    Read Only: true
    Maximum Length: 50
    Name of the payment plan.
  • Title: Plan Enrollment ID
    Read Only: true
    Unique identifier of the payment plan enrollment.
  • Title: Plan Status Code
    Maximum Length: 30
    Payment plan status code, for example enrolled, paid, or past due. A list of accepted values is defined in the lookup type ORA_HES_PAYMENT_PLAN_STATUS.
  • Title: Plan Status
    Read Only: true
    Maximum Length: 80
    The meaning of the current payment plan status code. A list of accepted values is defined in the lookup type ORA_HES_PAYMENT_PLAN_STATUS.
  • Schedules
    Title: Schedules
    Schedule of required payments for the payment plan.
  • Title: Status Code
    Maximum Length: 30
    Payment plan version status code, for example, published, unpublished, or draft. A list of accepted values is defined in the lookup type ORA_HEY_VERSION_STATUS.
  • Title: Status
    Read Only: true
    Maximum Length: 80
    The meaning of the current payment plan version status code. A list of accepted values is defined in the lookup type ORA_HEY_VERSION_STATUS.
Nested Schema : Invoices
Type: array
Title: Invoices
Invoices included in the payment plan.
Show Source
Nested Schema : Schedules
Type: array
Title: Schedules
Schedule of required payments for the payment plan.
Show Source
Nested Schema : paymentPlanEnrollments-invoices-item-response
Type: object
Show Source
Nested Schema : Details
Type: array
Title: Details
Details about invoices in the payment plan.
Show Source
Nested Schema : paymentPlanEnrollments-invoices-invoiceDetails-item-response
Type: object
Show Source
  • Title: Amount
    Read Only: true
    Amount of the invoice expected to be paid on the due date.
  • Title: Due Date
    Read Only: true
    Due date for an invoice in the payment plan.
  • Links
  • Title: Paid Flag
    Read Only: true
    Maximum Length: 1
    Indicates whether the invoice in the payment plan is paid. When an invoice is unpaid, students can see that a payment is due on their Enrolled Plans page and can receive reminder communications.
  • Title: Plan Invoice Detail ID
    Read Only: true
    Unique identifier for the payment plan invoice detail.
Nested Schema : paymentPlanEnrollments-schedules-item-response
Type: object
Show Source
  • Title: Amount
    Read Only: true
    Amount in the payment plan that's expected to be paid on the due date.
  • Title: Due Date
    Read Only: true
    The scheduled due date for a payment plan payment.
  • Links
  • Title: Paid Flag
    Read Only: true
    Maximum Length: 1
    Indicates whether the payment plan has been paid. When a plan isn't paid, it can be adjusted to include new charges, and enrollment in the plan can be canceled.
  • Title: Plan Enrollment Schedule ID
    Read Only: true
    Unique identifier of the payment schedule for the payment plan enrollment.
Back to Top