Jump to

• Request
• Response

Create an external fund credit

post

/fscmRestApi/resources/11.13.18.05/studentCreditExternalFunds

Request

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

• BusinessUnitId: integer (int64)
  Title: Business Unit ID

  The unique identifier of the academic business unit.
• BusinessUnitName: string
  Title: Business Unit

  Maximum Length: 240

  The name of the academic business unit.
• ChargePriorityCode: string
  Title: Priority Mapping Code

  Maximum Length: 30

  The unique code of the charge priority mapping rule.
• ChargePriorityId: integer (int64)
  Title: Charge Priority Mapping

  The unique identifier of the charge priority mapping rule.
• CreditCode(required): string
  Title: Credit Code

  Maximum Length: 30

  The unique code to identify the student credit.
• CreditDescription: string
  Title: Description

  Maximum Length: 240

  The description of the student credit.
• CreditName(required): string
  Title: Credit Name

  Maximum Length: 50

  The name of the student credit.
• CreditReferenceCode(required): string
  Title: Credit Reference Code

  Maximum Length: 100

  The credit reference code of the student credit.
• CreditSourceCode: string
  Title: Credit Source Code

  Maximum Length: 30

  The unique code of the source of credit.
• MaximumAmount: number
  Title: Maximum Amount

  Maximum amount of the credit.
• MemoLineId: integer (int64)
  Title: Memo Line

  The identifier of the memo line assigned to a transaction. The memo line designates a revenue account.
• MemoLineName: string
  Title: Memo Line Name

  Maximum Length: 50

  The name of the memo line assigned to a transaction.
• periodOverrides: array Period Overrides
  Title: Period Overrides

  The period overrides resource lists all the academic periods that are excluded from the external fund credits.
• Priority: integer (int32)
  Title: Credit Priority

  Default Value: 9999

  The priority in which a credit is processed.
• ReceivableActivityId(required): integer (int64)
  Title: Receivables Activity

  The identifier of the receivables activity assigned to a transaction.
• ReceivableActivityName: string
  Title: Receivables Activity Name

  Maximum Length: 50

  The name of the receivables activity assigned to a transaction.
• RefundableFlag(required): boolean
  Title: Refundable Credit

  Maximum Length: 1

  Indicates whether an excess student credit amount can be refunded. If the value is true, the credit is refundable.
• StatusCode(required): string
  Title: Status Code

  Maximum Length: 30

  The activation status of the student credit.
• TransactionTypeId(required): integer (int64)
  Title: Transaction Type

  The transaction type of the student credit setup.
• TransactionTypeName: string
  Title: Transaction Type Name

  Maximum Length: 20

  The name of the transaction type of the student credit setup.

{
    "required":[
        "CreditCode",
        "CreditName",
        "CreditReferenceCode",
        "ReceivableActivityId",
        "RefundableFlag",
        "StatusCode",
        "TransactionTypeId"
    ],
    "type":"object",
    "properties":{
        "BusinessUnitId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The unique identifier of the academic business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "BusinessUnitName"
                ]
            }
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"The name of the academic business unit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChargePriorityCode":{
            "title":"Priority Mapping Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code of the charge priority mapping rule.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChargePriorityId":{
            "title":"Charge Priority Mapping",
            "type":"integer",
            "description":"The unique identifier of the charge priority mapping rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ChargePriorityCode"
                ]
            }
        },
        "CreditCode":{
            "title":"Credit Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code to identify the student credit.",
            "nullable":false
        },
        "CreditDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the student credit.",
            "nullable":true
        },
        "CreditName":{
            "title":"Credit Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the student credit.",
            "nullable":false
        },
        "CreditReferenceCode":{
            "title":"Credit Reference Code",
            "maxLength":100,
            "type":"string",
            "description":"The credit reference code of the student credit.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CreditSourceCode":{
            "title":"Credit Source Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code of the source of credit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MaximumAmount":{
            "title":"Maximum Amount",
            "type":"number",
            "description":"Maximum amount of the credit.",
            "nullable":true
        },
        "MemoLineId":{
            "title":"Memo Line",
            "type":"integer",
            "description":"The identifier of the memo line assigned to a transaction. The memo line designates a revenue account.",
            "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 assigned to a transaction.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Priority":{
            "title":"Credit Priority",
            "type":"integer",
            "description":"The priority in which a credit is processed.",
            "format":"int32",
            "nullable":false,
            "default":9999,
            "x-hints":{
                "precision":6
            }
        },
        "ReceivableActivityId":{
            "title":"Receivables Activity",
            "type":"integer",
            "description":"The identifier of the receivables activity assigned to a transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ReceivableActivityName"
                ]
            }
        },
        "ReceivableActivityName":{
            "title":"Receivables Activity Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the receivables activity assigned to a transaction.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RefundableFlag":{
            "title":"Refundable Credit",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether an excess student credit amount can be refunded. If the value is true, the credit is refundable.",
            "nullable":false
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The activation status of the student credit.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TransactionTypeId":{
            "title":"Transaction Type",
            "type":"integer",
            "description":"The transaction type of the student credit setup.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "TransactionTypeName"
                ]
            }
        },
        "TransactionTypeName":{
            "title":"Transaction Type Name",
            "maxLength":20,
            "type":"string",
            "description":"The name of the transaction type of the student credit setup.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "periodOverrides":{
            "title":"Period Overrides",
            "type":"array",
            "description":"The period overrides resource lists all the academic periods that are excluded from the external fund credits.",
            "items":{
                "$ref":"#/components/schemas/studentCreditExternalFunds-periodOverrides-item-post-request"
            }
        }
    }
}

Nested Schema : Period Overrides

Type: array

Title: Period Overrides

The period overrides resource lists all the academic periods that are excluded from the external fund credits.

Show Source

• Array of: object studentCreditExternalFunds-periodOverrides-item-post-request

{
    "title":"Period Overrides",
    "type":"array",
    "description":"The period overrides resource lists all the academic periods that are excluded from the external fund credits.",
    "items":{
        "$ref":"#/components/schemas/studentCreditExternalFunds-periodOverrides-item-post-request"
    }
}

Nested Schema : studentCreditExternalFunds-periodOverrides-item-post-request

Type: object

Show Source

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

  Unique identifier of the academic period.
• AcademicPeriodName: string
  Title: Period Name

  Maximum Length: 50

  Name of the academic period.
• EndDate: string (date)
  Title: Credit Period End Date

  Date when the credit period is archived.
• MemoLineId: integer (int64)
  Title: Memo Line

  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.
• ReceivableActivityId: integer (int64)
  Title: Receivables Activity

  Unique identifier of the receivables activity when the credit is posted for the academic period.
• ReceivableActivityName: string
  Title: Receivables Activity Name

  Maximum Length: 255

  The name of the receivables activity assigned to a transaction.
• TransactionTypeId: integer (int64)
  Title: Transaction Type

  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":{
            "title":"Academic Period ID",
            "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"
            }
        },
        "EndDate":{
            "title":"Credit Period End Date",
            "type":"string",
            "description":"Date when the credit period is archived.",
            "format":"date",
            "nullable":true
        },
        "MemoLineId":{
            "title":"Memo Line",
            "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"
            }
        },
        "ReceivableActivityId":{
            "title":"Receivables Activity",
            "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":{
            "title":"Receivables Activity Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the receivables activity assigned to a transaction.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TransactionTypeId":{
            "title":"Transaction Type",
            "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 : studentCreditExternalFunds-item-response

Type: object

Show Source

• BusinessUnitId: integer (int64)
  Title: Business Unit ID

  The unique identifier of the academic business unit.
• BusinessUnitName: string
  Title: Business Unit

  Maximum Length: 240

  The name of the academic business unit.
• ChargePriorityCode: string
  Title: Priority Mapping Code

  Maximum Length: 30

  The unique code of the charge priority mapping rule.
• ChargePriorityId: integer (int64)
  Title: Charge Priority Mapping

  The unique identifier of the charge priority mapping rule.
• ChargePriorityName: string
  Title: Priority Mapping Name

  Read Only: true

  Maximum Length: 50

  The name of the charge priority mapping rule.
• CreditCode: string
  Title: Credit Code

  Maximum Length: 30

  The unique code to identify the student credit.
• CreditDescription: string
  Title: Description

  Maximum Length: 240

  The description of the student credit.
• CreditId: integer (int64)
  Title: Credit ID

  Read Only: true

  The unique identifier of the student credit.
• CreditName: string
  Title: Credit Name

  Maximum Length: 50

  The name of the student credit.
• CreditReferenceCode: string
  Title: Credit Reference Code

  Maximum Length: 100

  The credit reference code of the student credit.
• CreditReferenceMeaning: string
  Title: Credit Reference Name

  Read Only: true

  Maximum Length: 80

  The name of the credit reference code.
• CreditSourceCode: string
  Title: Credit Source Code

  Maximum Length: 30

  The unique code of the source of credit.
• CreditSourceMeaning: string
  Title: Credit Source Meaning

  Read Only: true

  Maximum Length: 80

  The name of the source of the credit.
• CurrencyCode: string
  Title: Currency Code

  Read Only: true

  Maximum Length: 15

  The currency code associated with the student credit.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumAmount: number
  Title: Maximum Amount

  Maximum amount of the credit.
• MemoLineId: integer (int64)
  Title: Memo Line

  The identifier of the memo line assigned to a transaction. The memo line designates a revenue account.
• MemoLineName: string
  Title: Memo Line Name

  Maximum Length: 50

  The name of the memo line assigned to a transaction.
• periodOverrides: array Period Overrides
  Title: Period Overrides

  The period overrides resource lists all the academic periods that are excluded from the external fund credits.
• Priority: integer (int32)
  Title: Credit Priority

  Default Value: 9999

  The priority in which a credit is processed.
• ReceivableActivityId: integer (int64)
  Title: Receivables Activity

  The identifier of the receivables activity assigned to a transaction.
• ReceivableActivityName: string
  Title: Receivables Activity Name

  Maximum Length: 50

  The name of the receivables activity assigned to a transaction.
• RefundableFlag: boolean
  Title: Refundable Credit

  Maximum Length: 1

  Indicates whether an excess student credit amount can be refunded. If the value is true, the credit is refundable.
• StatusCode: string
  Title: Status Code

  Maximum Length: 30

  The activation status of the student credit.
• StatusMeaning: string
  Title: Status Name

  Read Only: true

  Maximum Length: 80

  The activation status name of the student credit.
• TransactionTypeId: integer (int64)
  Title: Transaction Type

  The transaction type of the student credit setup.
• TransactionTypeName: string
  Title: Transaction Type Name

  Maximum Length: 20

  The name of the transaction type of the student credit setup.

{
    "type":"object",
    "properties":{
        "BusinessUnitId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The unique identifier of the academic business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "BusinessUnitName"
                ]
            },
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"The name of the academic business unit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChargePriorityCode":{
            "title":"Priority Mapping Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code of the charge priority mapping rule.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChargePriorityId":{
            "title":"Charge Priority Mapping",
            "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":{
            "title":"Priority Mapping Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the charge priority mapping rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditCode":{
            "title":"Credit Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code to identify the student credit.",
            "nullable":false,
            "x-queryable":true
        },
        "CreditDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the student credit.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditId":{
            "title":"Credit ID",
            "type":"integer",
            "description":"The unique identifier of the student credit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CreditName":{
            "title":"Credit Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the student credit.",
            "nullable":false,
            "x-queryable":true
        },
        "CreditReferenceCode":{
            "title":"Credit Reference Code",
            "maxLength":100,
            "type":"string",
            "description":"The credit reference code of the student credit.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreditReferenceMeaning":{
            "title":"Credit Reference Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the credit reference code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditSourceCode":{
            "title":"Credit Source Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code of the source of credit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreditSourceMeaning":{
            "title":"Credit Source Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The name of the source of the credit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the student credit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumAmount":{
            "title":"Maximum Amount",
            "type":"number",
            "description":"Maximum amount of the credit.",
            "nullable":true,
            "x-queryable":true
        },
        "MemoLineId":{
            "title":"Memo Line",
            "type":"integer",
            "description":"The identifier of the memo line assigned to a transaction. The memo line designates a revenue account.",
            "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 assigned to a transaction.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Priority":{
            "title":"Credit Priority",
            "type":"integer",
            "description":"The priority in which a credit is processed.",
            "format":"int32",
            "nullable":false,
            "default":9999,
            "x-hints":{
                "precision":6
            },
            "x-queryable":true
        },
        "ReceivableActivityId":{
            "title":"Receivables Activity",
            "type":"integer",
            "description":"The identifier of the receivables activity assigned to a transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ReceivableActivityName"
                ]
            },
            "x-queryable":true
        },
        "ReceivableActivityName":{
            "title":"Receivables Activity Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the receivables activity assigned to a transaction.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RefundableFlag":{
            "title":"Refundable Credit",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether an excess student credit amount can be refunded. If the value is true, the credit is refundable.",
            "nullable":false,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The activation status of the student credit.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Status Name",
            "maxLength":80,
            "type":"string",
            "description":"The activation status name of the student credit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionTypeId":{
            "title":"Transaction Type",
            "type":"integer",
            "description":"The transaction type of the student credit setup.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "TransactionTypeName"
                ]
            },
            "x-queryable":true
        },
        "TransactionTypeName":{
            "title":"Transaction Type Name",
            "maxLength":20,
            "type":"string",
            "description":"The name of the transaction type of the student credit setup.",
            "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"
            }
        },
        "periodOverrides":{
            "title":"Period Overrides",
            "type":"array",
            "description":"The period overrides resource lists all the academic periods that are excluded from the external fund credits.",
            "items":{
                "$ref":"#/components/schemas/studentCreditExternalFunds-periodOverrides-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 : Period Overrides

Type: array

Title: Period Overrides

The period overrides resource lists all the academic periods that are excluded from the external fund credits.

Show Source

• Array of: object studentCreditExternalFunds-periodOverrides-item-response

{
    "title":"Period Overrides",
    "type":"array",
    "description":"The period overrides resource lists all the academic periods that are excluded from the external fund credits.",
    "items":{
        "$ref":"#/components/schemas/studentCreditExternalFunds-periodOverrides-item-response"
    }
}

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 : studentCreditExternalFunds-periodOverrides-item-response

Type: object

Show Source

• AcademicPeriodEndDate: string (date)
  Title: End Date

  Read Only: true

  The end date of the academic period.
• AcademicPeriodId: integer (int64)
  Title: Academic Period ID

  Unique identifier of the academic period.
• AcademicPeriodName: string
  Title: Period Name

  Maximum Length: 50

  Name of the academic period.
• AcademicPeriodStartDate: string (date)
  Title: Start Date

  Read Only: true

  The start date of the academic period.
• CreditPeriodId: integer (int64)
  Title: Credit Period ID

  Read Only: true

  Unique identifier of the credit period.
• EndDate: string (date)
  Title: Credit Period End Date

  Date when the credit period is archived.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MemoLineId: integer (int64)
  Title: Memo Line

  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.
• ReceivableActivityId: integer (int64)
  Title: Receivables Activity

  Unique identifier of the receivables activity when the credit is posted for the academic period.
• ReceivableActivityName: string
  Title: Receivables Activity Name

  Maximum Length: 255

  The name of the receivables activity assigned to a transaction.
• TransactionTypeId: integer (int64)
  Title: Transaction Type

  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":{
        "AcademicPeriodEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the academic period.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicPeriodId":{
            "title":"Academic Period ID",
            "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
        },
        "AcademicPeriodStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the academic period.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditPeriodId":{
            "title":"Credit Period ID",
            "type":"integer",
            "description":"Unique identifier of the credit period.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"Credit Period End Date",
            "type":"string",
            "description":"Date when the credit period is archived.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "MemoLineId":{
            "title":"Memo Line",
            "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
        },
        "ReceivableActivityId":{
            "title":"Receivables Activity",
            "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":{
            "title":"Receivables Activity Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the receivables activity assigned to a transaction.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TransactionTypeId":{
            "title":"Transaction Type",
            "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"
    }
}

Links

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

creditReferencesLOV

Operation: /fscmRestApi/resources/11.13.18.05/genericLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BApplicationCode%3DHES%2CLookupType%3DORA_CREDIT_REFERENCE%2CLookupCode%3D{CreditReferenceCode}

The following properties are defined on the LOV link relation:

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

creditSourcesLOV

Operation: /fscmRestApi/resources/11.13.18.05/genericLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BApplicationCode%3DHES%2CLookupType%3DORA_CREDIT_SOURCE_CODE%2CLookupCode%3D{CreditSourceCode}

The following properties are defined on the LOV link relation:

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

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

periodOverrides

Operation: /fscmRestApi/resources/11.13.18.05/studentCreditExternalFunds/{studentCreditExternalFundsUniqID}/child/periodOverrides

Parameters:

• studentCreditExternalFundsUniqID: $request.path.studentCreditExternalFundsUniqID

The period overrides resource lists all the academic periods that are excluded from the external fund credits.

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

statusesLOV

Operation: /fscmRestApi/resources/11.13.18.05/genericLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BApplicationCode%3DHES%2CLookupType%3DORA_HES_CREDIT_STATUS_CODE%2CLookupCode%3D{StatusCode}

The following properties are defined on the LOV link relation:

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

studentFinancialSystemConfigurationsLOV

Operation: /fscmRestApi/resources/11.13.18.05/studentFinancialSystemConfigurationsLOV

The following properties are defined on the LOV link relation:

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

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