Jump to

• Request
• Response

Update a student credit period

patch

/fscmRestApi/resources/11.13.18.05/studentCreditWaivers/{studentCreditWaiversUniqID}/child/creditPeriods/{CreditPeriodId}

Request

Path Parameters

• CreditPeriodId(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=
• studentCreditWaiversUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Student Credit Waivers resource and used to uniquely identify an instance of Student Credit Waivers. The client should not generate the hash key value. Instead, the client should query on the Student Credit Waivers collection resource in order to navigate to a specific instance of Student Credit Waivers to get the hash key.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AcademicPeriodId: integer (int64)
  Unique identifier of the academic period.
• AcademicPeriodName: string
  Title: Period Name

  Maximum Length: 50

  Name of the academic period.
• Amount: number
  The amount associated with the amount type for the waiver.
• AmountTypeCode: string
  Maximum Length: 255

  The unique code of the waiver type.
• ChargePriorityCode: string
  Maximum Length: 30

  The unique code of the charge priority mapping rule.
• ChargePriorityId: integer (int64)
  The unique identifier of the charge priority mapping rule.
• CreditPeriodDescription: string
  Maximum Length: 240

  The description of the credit period.
• EligibilityEndDate: string (date)
  The date when the eligibility for waiver by amount ends.
• EndDate: string (date)
  The date when the credit period's validity ends.
• MaximumAmount: number
  Maximum amount of the credit.
• MemoLineId: integer (int64)
  The unique identifier of the memo line used when the credit is posted for the academic period.
• MemoLineName: string
  Title: Memo Line Name

  Maximum Length: 50

  The name of the memo line.
• OverrideAmountFlag: boolean
  Maximum Length: 1

  Indicates whether the default student credit amount is overridden. If the value is true, the credit has unique amount setup values.
• ReceivableActivityId: integer (int64)
  Unique identifier of the receivables activity when the credit is posted for the academic period.
• ReceivableActivityName: string
  Maximum Length: 255

  Name of the receivables activity.
• StartDate: string (date)
  The date when the credit period is active.
• TransactionTypeId: integer (int64)
  Unique identifier of the transaction type when the credit is posted for the academic period.
• TransactionTypeName: string
  Title: Transaction Type Name

  Maximum Length: 20

  Name of the transaction type.

{
    "type":"object",
    "properties":{
        "AcademicPeriodId":{
            "type":"integer",
            "description":"Unique identifier of the academic period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "AcademicPeriodName"
                ]
            }
        },
        "AcademicPeriodName":{
            "title":"Period Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the academic period.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Amount":{
            "type":"number",
            "description":"The amount associated with the amount type for the waiver.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "OverrideAmountFlag"
                ]
            }
        },
        "AmountTypeCode":{
            "maxLength":255,
            "type":"string",
            "description":"The unique code of the waiver type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "OverrideAmountFlag"
                ]
            }
        },
        "ChargePriorityCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unique code of the charge priority mapping rule.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChargePriorityId":{
            "type":"integer",
            "description":"The unique identifier of the charge priority mapping rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ChargePriorityCode"
                ]
            }
        },
        "CreditPeriodDescription":{
            "maxLength":240,
            "type":"string",
            "description":"The description of the credit period.",
            "nullable":false
        },
        "EligibilityEndDate":{
            "type":"string",
            "description":"The date when the eligibility for waiver by amount ends.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "OverrideAmountFlag"
                ]
            }
        },
        "EndDate":{
            "type":"string",
            "description":"The date when the credit period's validity ends.",
            "format":"date",
            "nullable":true
        },
        "MaximumAmount":{
            "type":"number",
            "description":"Maximum amount of the credit.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "OverrideAmountFlag"
                ]
            }
        },
        "MemoLineId":{
            "type":"integer",
            "description":"The unique identifier of the memo line used when the credit is posted for the academic period.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "MemoLineName"
                ]
            }
        },
        "MemoLineName":{
            "title":"Memo Line Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the memo line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OverrideAmountFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the default student credit amount is overridden. If the value is true, the credit has unique amount setup values.",
            "nullable":true
        },
        "ReceivableActivityId":{
            "type":"integer",
            "description":"Unique identifier of the receivables activity when the credit is posted for the academic period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ReceivableActivityName"
                ]
            }
        },
        "ReceivableActivityName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the receivables activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StartDate":{
            "type":"string",
            "description":"The date when the credit period is active.",
            "format":"date",
            "nullable":true
        },
        "TransactionTypeId":{
            "type":"integer",
            "description":"Unique identifier of the transaction type when the credit is posted for the academic period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "TransactionTypeName"
                ]
            }
        },
        "TransactionTypeName":{
            "title":"Transaction Type Name",
            "maxLength":20,
            "type":"string",
            "description":"Name of the transaction type.",
            "nullable":true,
            "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 : studentCreditWaivers-creditPeriods-item-response

Type: object

Show Source

• AcademicPeriodId: integer (int64)
  Unique identifier of the academic period.
• AcademicPeriodName: string
  Title: Period Name

  Maximum Length: 50

  Name of the academic period.
• Amount: number
  The amount associated with the amount type for the waiver.
• AmountTypeCode: string
  Maximum Length: 255

  The unique code of the waiver type.
• AmountTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  The name of the waiver type.
• ChargePriorityCode: string
  Maximum Length: 30

  The unique code of the charge priority mapping rule.
• ChargePriorityId: integer (int64)
  The unique identifier of the charge priority mapping rule.
• ChargePriorityName: string
  Read Only: true

  Maximum Length: 50

  The name of the charge priority mapping rule.
• CreditPeriodDescription: string
  Maximum Length: 240

  The description of the credit period.
• CreditPeriodId: integer (int64)
  Read Only: true

  The unique identifier of the credit period.
• EligibilityEndDate: string (date)
  The date when the eligibility for waiver by amount ends.
• EndDate: string (date)
  The date when the credit period's validity ends.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumAmount: number
  Maximum amount of the credit.
• MemoLineId: integer (int64)
  The unique identifier of the memo line used when the credit is posted for the academic period.
• MemoLineName: string
  Title: Memo Line Name

  Maximum Length: 50

  The name of the memo line.
• OverrideAmountFlag: boolean
  Maximum Length: 1

  Indicates whether the default student credit amount is overridden. If the value is true, the credit has unique amount setup values.
• ReceivableActivityId: integer (int64)
  Unique identifier of the receivables activity when the credit is posted for the academic period.
• ReceivableActivityName: string
  Maximum Length: 255

  Name of the receivables activity.
• StartDate: string (date)
  The date when the credit period is active.
• TransactionTypeId: integer (int64)
  Unique identifier of the transaction type when the credit is posted for the academic period.
• TransactionTypeName: string
  Title: Transaction Type Name

  Maximum Length: 20

  Name of the transaction type.

{
    "type":"object",
    "properties":{
        "AcademicPeriodId":{
            "type":"integer",
            "description":"Unique identifier of the academic period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "AcademicPeriodName"
                ]
            },
            "x-queryable":true
        },
        "AcademicPeriodName":{
            "title":"Period Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the academic period.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Amount":{
            "type":"number",
            "description":"The amount associated with the amount type for the waiver.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "OverrideAmountFlag"
                ]
            },
            "x-queryable":true
        },
        "AmountTypeCode":{
            "maxLength":255,
            "type":"string",
            "description":"The unique code of the waiver type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "OverrideAmountFlag"
                ]
            },
            "x-queryable":true
        },
        "AmountTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The name of the waiver type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargePriorityCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unique code of the charge priority mapping rule.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChargePriorityId":{
            "type":"integer",
            "description":"The unique identifier of the charge priority mapping rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ChargePriorityCode"
                ]
            },
            "x-queryable":true
        },
        "ChargePriorityName":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the charge priority mapping rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditPeriodDescription":{
            "maxLength":240,
            "type":"string",
            "description":"The description of the credit period.",
            "nullable":false,
            "x-queryable":true
        },
        "CreditPeriodId":{
            "type":"integer",
            "description":"The unique identifier of the credit period.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EligibilityEndDate":{
            "type":"string",
            "description":"The date when the eligibility for waiver by amount ends.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "OverrideAmountFlag"
                ]
            },
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The date when the credit period's validity ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumAmount":{
            "type":"number",
            "description":"Maximum amount of the credit.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "OverrideAmountFlag"
                ]
            },
            "x-queryable":true
        },
        "MemoLineId":{
            "type":"integer",
            "description":"The unique identifier of the memo line used when the credit is posted for the academic period.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "MemoLineName"
                ]
            },
            "x-queryable":true
        },
        "MemoLineName":{
            "title":"Memo Line Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the memo line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OverrideAmountFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the default student credit amount is overridden. If the value is true, the credit has unique amount setup values.",
            "nullable":true,
            "x-queryable":true
        },
        "ReceivableActivityId":{
            "type":"integer",
            "description":"Unique identifier of the receivables activity when the credit is posted for the academic period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ReceivableActivityName"
                ]
            },
            "x-queryable":true
        },
        "ReceivableActivityName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the receivables activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The date when the credit period is active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionTypeId":{
            "type":"integer",
            "description":"Unique identifier of the transaction type when the credit is posted for the academic period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "TransactionTypeName"
                ]
            },
            "x-queryable":true
        },
        "TransactionTypeName":{
            "title":"Transaction Type Name",
            "maxLength":20,
            "type":"string",
            "description":"Name of the transaction type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

academicPeriodsLOV

Operation: /fscmRestApi/resources/11.13.18.05/academicPeriods

Parameters:

• finder: ByReportingPeriodFinder

The following properties are defined on the LOV link relation:

• Source Attribute: AcademicPeriodName; Target Attribute: PeriodName
• Display Attribute: PeriodName

amountTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/genericLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BApplicationCode%3DHES%2CLookupType%3DORA_HES_CREDIT_AMOUNT_TYPE%2CLookupCode%3D{AmountTypeCode}

The following properties are defined on the LOV link relation:

• Source Attribute: AmountTypeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

chargePrioritiesLOV

Operation: /fscmRestApi/resources/11.13.18.05/chargePriorityMappingsLOV

Parameters:

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

The following properties are defined on the LOV link relation:

• Source Attribute: ChargePriorityCode; Target Attribute: ChargePriorityCode
• Display Attribute: ChargePriorityName

memoLinesLOV

Operation: /fscmRestApi/resources/11.13.18.05/studentMemoLinesLOV

Parameters:

• finder: ByBusinessUnitFinder%3BBusinessUnitName%3D{BusinessUnitName}

The following properties are defined on the LOV link relation:

• Source Attribute: MemoLineName; Target Attribute: MemoLineName
• Display Attribute: MemoLineName

receivableActivitiesLOV

Operation: /fscmRestApi/resources/11.13.18.05/studentReceivableTransactionsLOV

Parameters:

• finder: FindByBusinessUnitAndType%3BOrganizationName%3D{BusinessUnitName}%2CType%3DADJUST%2CFINCHRG

The following properties are defined on the LOV link relation:

• Source Attribute: ReceivableActivityName; Target Attribute: ReceivableActivityName
• Display Attribute: ReceivableActivityName

transactionTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/studentTransactionTypesLOV

Parameters:

• finder: CreditMemoTransactionTypeFinder%3BBusinessUnitName%3D{BusinessUnitName}

The following properties are defined on the LOV link relation:

• Source Attribute: TransactionTypeName; Target Attribute: TransactionTypeName
• Display Attribute: TransactionTypeName

Back to Top