Jump to

• Request
• Response

Get a payment plan enrollment

get

/fscmRestApi/resources/11.13.18.05/paymentPlanEnrollments/{PlanEnrollmentId}

Request

Path Parameters

• PlanEnrollmentId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 : paymentPlanEnrollments-item-response

Type: object

Show Source

• CustomerAccountNumbers: string
  Title: Customer Account Numbers

  Read Only: true

  Maximum Length: 255

  Customer account number for the transactions included in the payment plan.
• EmailAddress: string
  Title: Email Address

  Read Only: true

  Maximum Length: 255

  Email address for the student enrolled in the payment plan.
• EnrollmentDate: string (date)
  Title: Enrollment Date

  Read Only: true

  Date the student enrolled in the payment plan.
• invoices: array Invoices
  Title: Invoices

  Invoices included in the payment plan.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartyId: integer (int64)
  Title: Party ID

  The party ID of the student enrolled in the payment plan.
• PartyName: string
  Title: Party Name

  Read Only: true

  Maximum Length: 255

  The name of the student enrolled in the payment plan.
• PaymentPlanCode: string
  Title: Payment Plan Code

  Maximum Length: 30

  Code for the payment plan.
• PaymentPlanId: integer (int64)
  Title: Payment Plan ID

  Unique identifier of the payment plan.
• PaymentPlanName: string
  Title: Payment Plan Name

  Read Only: true

  Maximum Length: 50

  Name of the payment plan.
• PlanEnrollmentId: integer (int64)
  Title: Plan Enrollment ID

  Read Only: true

  Unique identifier of the payment plan enrollment.
• PlanStatusCode: string
  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.
• PlanStatusMeaning: string
  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: array Schedules
  Title: Schedules

  Schedule of required payments for the payment plan.
• StatusCode: string
  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.
• StatusMeaning: string
  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.

{
    "type":"object",
    "properties":{
        "CustomerAccountNumbers":{
            "title":"Customer Account Numbers",
            "maxLength":255,
            "type":"string",
            "description":"Customer account number for the transactions included in the payment plan.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Party Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the student enrolled in the payment plan.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            },
            "x-queryable":true
        },
        "PlanStatusMeaning":{
            "title":"Plan Status",
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "PlanEnrollmentId":{
            "title":"Plan Enrollment ID",
            "type":"integer",
            "description":"Unique identifier of the payment plan enrollment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email Address",
            "maxLength":255,
            "type":"string",
            "description":"Email address for the student enrolled in the payment plan.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            },
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnrollmentDate":{
            "title":"Enrollment Date",
            "type":"string",
            "description":"Date the student enrolled in the payment plan.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The party ID of the student enrolled in the payment plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanStatusCode":{
            "title":"Plan Status Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "invoices":{
            "title":"Invoices",
            "type":"array",
            "description":"Invoices included in the payment plan.",
            "items":{
                "$ref":"#/components/schemas/paymentPlanEnrollments-invoices-item-response"
            }
        },
        "PaymentPlanName":{
            "title":"Payment Plan Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the payment plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentPlanCode":{
            "title":"Payment Plan Code",
            "maxLength":30,
            "type":"string",
            "description":"Code for the payment plan.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "schedules":{
            "title":"Schedules",
            "type":"array",
            "description":"Schedule of required payments for the payment plan.",
            "items":{
                "$ref":"#/components/schemas/paymentPlanEnrollments-schedules-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PaymentPlanId":{
            "title":"Payment Plan ID",
            "type":"integer",
            "description":"Unique identifier of the payment plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "PaymentPlanCode"
                ]
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Invoices

Type: array

Title: Invoices

Invoices included in the payment plan.

Show Source

• Array of: object paymentPlanEnrollments-invoices-item-response

{
    "title":"Invoices",
    "type":"array",
    "description":"Invoices included in the payment plan.",
    "items":{
        "$ref":"#/components/schemas/paymentPlanEnrollments-invoices-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 : Schedules

Type: array

Title: Schedules

Schedule of required payments for the payment plan.

Show Source

• Array of: object paymentPlanEnrollments-schedules-item-response

{
    "title":"Schedules",
    "type":"array",
    "description":"Schedule of required payments for the payment plan.",
    "items":{
        "$ref":"#/components/schemas/paymentPlanEnrollments-schedules-item-response"
    }
}

Nested Schema : paymentPlanEnrollments-invoices-item-response

Type: object

Show Source

• Amount: number
  Title: Amount

  Read Only: true

  Default Value: 0

  Amount of the invoice included in the plan. The amount can be less than the overall invoice amount.
• invoiceDetails: array Details
  Title: Details

  Details about invoices in the payment plan.
• InvoiceId: integer (int64)
  Title: Invoice ID

  Unique identifier of the invoice included in the payment plan.
• InvoiceNumber: string
  Title: Invoice Number

  Read Only: true

  Maximum Length: 255

  Invoice number associated with the invoice in the payment plan.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlanInvoiceId: integer (int64)
  Title: Plan Invoice ID

  Read Only: true

  Unique identifier for the header of an invoice in the payment plan.

{
    "type":"object",
    "properties":{
        "PlanInvoiceId":{
            "title":"Plan Invoice ID",
            "type":"integer",
            "description":"Unique identifier for the header of an invoice in the payment plan.",
            "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"
            }
        },
        "InvoiceNumber":{
            "title":"Invoice Number",
            "maxLength":255,
            "type":"string",
            "description":"Invoice number associated with the invoice in the payment plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "InvoiceId"
                ]
            }
        },
        "invoiceDetails":{
            "title":"Details",
            "type":"array",
            "description":"Details about invoices in the payment plan.",
            "items":{
                "$ref":"#/components/schemas/paymentPlanEnrollments-invoices-invoiceDetails-item-response"
            }
        },
        "InvoiceId":{
            "title":"Invoice ID",
            "type":"integer",
            "description":"Unique identifier of the invoice included in the payment plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount of the invoice included in the plan. The amount can be less than the overall invoice amount.",
            "nullable":false,
            "readOnly":true,
            "default":0,
            "x-queryable":true
        }
    }
}

Nested Schema : Details

Type: array

Title: Details

Details about invoices in the payment plan.

Show Source

• Array of: object paymentPlanEnrollments-invoices-invoiceDetails-item-response

{
    "title":"Details",
    "type":"array",
    "description":"Details about invoices in the payment plan.",
    "items":{
        "$ref":"#/components/schemas/paymentPlanEnrollments-invoices-invoiceDetails-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 : paymentPlanEnrollments-invoices-invoiceDetails-item-response

Type: object

Show Source

• Amount: number
  Title: Amount

  Read Only: true

  Amount of the invoice expected to be paid on the due date.
• DueDate: string (date)
  Title: Due Date

  Read Only: true

  Due date for an invoice in the payment plan.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PaidFlag: boolean
  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.
• PlanInvoiceDetailId: integer (int64)
  Title: Plan Invoice Detail ID

  Read Only: true

  Unique identifier for the payment plan invoice detail.

{
    "type":"object",
    "properties":{
        "PlanInvoiceDetailId":{
            "title":"Plan Invoice Detail ID",
            "type":"integer",
            "description":"Unique identifier for the payment plan invoice detail.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PaidFlag":{
            "title":"Paid Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "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"
            }
        },
        "DueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"Due date for an invoice in the payment plan.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount of the invoice expected to be paid on the due date.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : 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 : paymentPlanEnrollments-schedules-item-response

Type: object

Show Source

• Amount: number
  Title: Amount

  Read Only: true

  Amount in the payment plan that's expected to be paid on the due date.
• DueDate: string (date)
  Title: Due Date

  Read Only: true

  The scheduled due date for a payment plan payment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PaidFlag: boolean
  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.
• PlanEnrollmentScheduleId: integer (int64)
  Title: Plan Enrollment Schedule ID

  Read Only: true

  Unique identifier of the payment schedule for the payment plan enrollment.

{
    "type":"object",
    "properties":{
        "PaidFlag":{
            "title":"Paid Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "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"
            }
        },
        "DueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The scheduled due date for a payment plan payment.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount in the payment plan that's expected to be paid on the due date.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanEnrollmentScheduleId":{
            "title":"Plan Enrollment Schedule ID",
            "type":"integer",
            "description":"Unique identifier of the payment schedule for the payment plan enrollment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Links

invoices

Operation: /fscmRestApi/resources/11.13.18.05/paymentPlanEnrollments/{PlanEnrollmentId}/child/invoices

Parameters:

• PlanEnrollmentId: $request.path.PlanEnrollmentId

Invoices included in the payment plan.

paymentPlanCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/paymentPlanSetups

Parameters:

• finder: EligiblePlanFinder

The following properties are defined on the LOV link relation:

• Source Attribute: PaymentPlanCode; Target Attribute: PaymentPlanCode
• Display Attribute: Name

schedules

Operation: /fscmRestApi/resources/11.13.18.05/paymentPlanEnrollments/{PlanEnrollmentId}/child/schedules

Parameters:

• PlanEnrollmentId: $request.path.PlanEnrollmentId

Schedule of required payments for the payment plan.

Back to Top