Jump to

• Request
• Response

Post a collection of payment plan eligibility data

post

/fscmRestApi/resources/11.13.18.05/paymentPlanSetups/{PaymentPlanId}/child/eligibilities

Request

Path Parameters

• PaymentPlanId(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=

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AcademicPeriodId(required): 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.
• eligiblePrograms: array Eligible Programs
  Title: Eligible Programs

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

  Maximum Length: 30

  The code for the eligible student setting.
• MinimumAmount: number
  Title: Minimum Amount

  The minimum aggregate amount of eligible fees for a payer to enroll in the plan.
• RecalculationTimingCode(required): string
  Title: Recalculation Timing Code

  Maximum Length: 30

  The code denoting when to recalculate a plan to include new or increased eligible fees.

{
    "required":[
        "AcademicPeriodId",
        "EligibleStudentCode",
        "RecalculationTimingCode"
    ],
    "type":"object",
    "properties":{
        "RecalculationTimingCode":{
            "title":"Recalculation Timing Code",
            "maxLength":30,
            "type":"string",
            "description":"The code denoting when to recalculate a plan to include new or increased eligible fees.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AcademicPeriodName":{
            "title":"Academic Period",
            "maxLength":50,
            "type":"string",
            "description":"The name of the academic period that an eligibility is associated with.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "eligiblePrograms":{
            "title":"Eligible Programs",
            "type":"array",
            "description":"Program requirements for payment plan eligibility.",
            "items":{
                "$ref":"#/components/schemas/paymentPlanSetups-eligibilities-eligiblePrograms-item-post-request"
            }
        },
        "ChargePriorityId":{
            "title":"Charge Priority ID",
            "type":"integer",
            "description":"Unique identifier of the charge priority mapping used to define eligible fees.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ChargePriorityCode"
                ]
            }
        },
        "MinimumAmount":{
            "title":"Minimum Amount",
            "type":"number",
            "description":"The minimum aggregate amount of eligible fees for a payer to enroll in the plan.",
            "nullable":true
        },
        "ChargePriorityCode":{
            "title":"Charge Priority Code",
            "maxLength":30,
            "type":"string",
            "description":"Code identifying the charge priority mapping used to define eligible fees.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AcademicPeriodId":{
            "title":"Academic Period ID",
            "type":"integer",
            "description":"The unique identifier of the academic period that an eligibility is associated with.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EligibleStudentCode":{
            "title":"Eligible Student Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the eligible student setting.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : Eligible Programs

Type: array

Title: Eligible Programs

Program requirements for payment plan eligibility.

Show Source

• Array of: object schema

{
    "title":"Eligible Programs",
    "type":"array",
    "description":"Program requirements for payment plan eligibility.",
    "items":{
        "$ref":"#/components/schemas/paymentPlanSetups-eligibilities-eligiblePrograms-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• CurriculumId: integer (int64)
  Title: Curriculum ID

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

  Maximum Length: 255

  Name of an eligible or ineligible program.

{
    "type":"object",
    "properties":{
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"Unique identifier of a curriculum for an eligible or ineligible program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "CurriculumName"
                ]
            }
        },
        "CurriculumName":{
            "title":"Curriculum Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of an eligible or ineligible program.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : paymentPlanSetups-eligibilities-item-response

Type: object

Show Source

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

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

  Maximum Length: 50

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

  Maximum Length: 30

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

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

  Read Only: true

  Maximum Length: 50

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

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

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 80

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

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

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

  Read Only: true

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

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 80

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

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

Nested Schema : Eligible Programs

Type: array

Title: Eligible Programs

Program requirements for payment plan eligibility.

Show Source

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

{
    "title":"Eligible Programs",
    "type":"array",
    "description":"Program requirements for payment plan eligibility.",
    "items":{
        "$ref":"#/components/schemas/paymentPlanSetups-eligibilities-eligiblePrograms-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : paymentPlanSetups-eligibilities-eligiblePrograms-item-response

Type: object

Show Source

• CurriculumId: integer (int64)
  Title: Curriculum ID

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

  Maximum Length: 255

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

  Read Only: true

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

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"Unique identifier of a curriculum for an eligible or ineligible program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "CurriculumName"
                ]
            },
            "x-queryable":true
        },
        "CurriculumName":{
            "title":"Curriculum Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of an eligible or ineligible program.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EligibleProgramId":{
            "title":"Eligible Program ID",
            "type":"integer",
            "description":"Unique Identifier of a program included or excluded from eligibility in the plan. Used when the eligible student's setting isn't All Students.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

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."
        }
    }
}

Links

academicPeriodNamesLOV

Operation: /fscmRestApi/resources/11.13.18.05/academicPeriodsLOV

Parameters:

• finder: ByPeriodCategoryCodeFinder

Academic periods are used in calculating when a plan is available, when due dates are calculated, and which students are eligible.

chargePriorityCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/chargePriorityMappingsLOV

Parameters:

• finder: FindByActiveDateAndBusinessUnit%3BBusinessUnitName%3D{BusinessUnitId}

Charge priorities define lists of fees. Fees can be included in a payment plan when they're part of the configured charge priority mapping.

eligiblePrograms

Operation: /fscmRestApi/resources/11.13.18.05/paymentPlanSetups/{PaymentPlanId}/child/eligibilities/{PlanEligibilityId}/child/eligiblePrograms

Parameters:

• PaymentPlanId: $request.path.PaymentPlanId
• PlanEligibilityId: $request.path.PlanEligibilityId

Program requirements for payment plan eligibility.

eligibleStudentCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/genericLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HES_ELIGIBLE_STUDENT_CODE

Code that determines how student eligibility is calculated.

recalculationTimingCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/genericLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HES_RECALC_TIMING_CODE

Eligible fees can change after a student enrolls in a payment plan. The recalculation timing code determines how the application handles new or increased fees.

Back to Top