Jump to

• Request
• Response

Create an on-account credit memo on a student account.

post

/fscmRestApi/resources/11.13.18.05/studentCreditPostings

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

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

  Unique identifier of the reporting academic period associated with the transaction.
• AcademicPeriodName: string
  Title: Academic Period Name

  Maximum Length: 50

  Name of the reporting academic period associated with the credit transaction.
• Amount: number
  Title: Amount

  Amount associated with the transaction.
• CreditCode: string
  Title: Credit Code

  Maximum Length: 30

  Unique user-defined credit code.
• CreditId: integer (int64)
  Title: Credit ID

  Unique identifier of the credit.
• ExternalReferenceCode: string
  Title: External Reference Code

  Maximum Length: 100

  The external reference code of the credit transaction. This can be used to sync credit transactions to Student Financial Planning.
• StatusCode: string
  Title: Status Code

  Maximum Length: 30

  Status code of the posted transaction.
• StudentPartyId: integer (int64)
  Title: Student ID

  Unique identifier of the student.
• StudentPartyName: string
  Title: Student Party Name

  Maximum Length: 360

  Name of the student.

{
    "type":"object",
    "properties":{
        "CreditCode":{
            "title":"Credit Code",
            "maxLength":30,
            "type":"string",
            "description":"Unique user-defined credit code.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "CreditId":{
            "title":"Credit ID",
            "type":"integer",
            "description":"Unique identifier of the credit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "StudentPartyName":{
            "title":"Student Party Name",
            "maxLength":360,
            "type":"string",
            "description":"Name of the student.",
            "nullable":false
        },
        "AcademicPeriodName":{
            "title":"Academic Period Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the reporting academic period associated with the credit transaction.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount associated with the transaction.",
            "nullable":true
        },
        "StudentPartyId":{
            "title":"Student ID",
            "type":"integer",
            "description":"Unique identifier of the student.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AcademicPeriodId":{
            "title":"Academic Period ID",
            "type":"integer",
            "description":"Unique identifier of the reporting academic period associated with the transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":30
            }
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Status code of the posted transaction.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "ExternalReferenceCode":{
            "title":"External Reference Code",
            "maxLength":100,
            "type":"string",
            "description":"The external reference code of the credit transaction. This can be used to sync credit transactions to Student Financial Planning.",
            "nullable":true
        }
    }
}

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

Type: object

Show Source

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

  Unique identifier of the reporting academic period associated with the transaction.
• AcademicPeriodName: string
  Title: Academic Period Name

  Maximum Length: 50

  Name of the reporting academic period associated with the credit transaction.
• Amount: number
  Title: Amount

  Amount associated with the transaction.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the transaction was created.
• CreditCode: string
  Title: Credit Code

  Maximum Length: 30

  Unique user-defined credit code.
• CreditId: integer (int64)
  Title: Credit ID

  Unique identifier of the credit.
• CreditName: string
  Title: Credit Name

  Read Only: true

  Maximum Length: 50

  Name of the credit.
• CreditPostingId: integer (int64)
  Title: Credit Posting ID

  Read Only: true

  Unique identifier of the posted transaction.
• CreditTypeCode: string
  Title: Credit Type Code

  Read Only: true

  Maximum Length: 30

  Code of the credit type.
• CreditTypeId: integer (int64)
  Title: Credit Type

  Read Only: true

  Unique identifier of the credit type.
• CreditTypeName: string
  Title: Credit Type Name

  Read Only: true

  Maximum Length: 50

  Name of the credit type. It can be external funds, waivers, and so on.
• CurrencyCode: string
  Title: Currency Code

  Read Only: true

  Maximum Length: 15

  The currency code of the posted transaction.
• CurrencySymbol: string
  Title: Currency Symbol

  Read Only: true

  Maximum Length: 12

  The symbol associated with the currency of the transaction.
• CustomerAccountNumber: string
  Title: Customer Account Number

  Read Only: true

  Maximum Length: 30

  Unique identifier of the student's customer account.
• ExternalReferenceCode: string
  Title: External Reference Code

  Maximum Length: 100

  The external reference code of the credit transaction. This can be used to sync credit transactions to Student Financial Planning.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date when the transaction was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostedDate: string (date)
  Title: Posted Date

  Read Only: true

  Date when the transaction was posted.
• StatusCode: string
  Title: Status Code

  Maximum Length: 30

  Status code of the posted transaction.
• StatusMeaning: string
  Title: Status Name

  Read Only: true

  Maximum Length: 80

  Status of the posted transaction. Valid values are posted, reversed, or error.
• StudentPartyId: integer (int64)
  Title: Student ID

  Unique identifier of the student.
• StudentPartyName: string
  Title: Student Party Name

  Maximum Length: 360

  Name of the student.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the transaction was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditCode":{
            "title":"Credit Code",
            "maxLength":30,
            "type":"string",
            "description":"Unique user-defined credit code.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreditTypeId":{
            "title":"Credit Type",
            "type":"integer",
            "description":"Unique identifier of the credit type.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreditTypeName":{
            "title":"Credit Type Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the credit type. It can be external funds, waivers, and so on.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount associated with the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditName":{
            "title":"Credit Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the credit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StudentPartyId":{
            "title":"Student ID",
            "type":"integer",
            "description":"Unique identifier of the student.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerAccountNumber":{
            "title":"Customer Account Number",
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier of the student's customer account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Status code of the posted transaction.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CurrencySymbol":{
            "title":"Currency Symbol",
            "maxLength":12,
            "type":"string",
            "description":"The symbol associated with the currency of the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalReferenceCode":{
            "title":"External Reference Code",
            "maxLength":100,
            "type":"string",
            "description":"The external reference code of the credit transaction. This can be used to sync credit transactions to Student Financial Planning.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code of the posted transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Status Name",
            "maxLength":80,
            "type":"string",
            "description":"Status of the posted transaction. Valid values are posted, reversed, or error.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditTypeCode":{
            "title":"Credit Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the credit type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditId":{
            "title":"Credit ID",
            "type":"integer",
            "description":"Unique identifier of the credit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StudentPartyName":{
            "title":"Student Party Name",
            "maxLength":360,
            "type":"string",
            "description":"Name of the student.",
            "nullable":false,
            "x-queryable":true
        },
        "AcademicPeriodName":{
            "title":"Academic Period Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the reporting academic period associated with the credit transaction.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PostedDate":{
            "title":"Posted Date",
            "type":"string",
            "description":"Date when the transaction was posted.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AcademicPeriodId":{
            "title":"Academic Period ID",
            "type":"integer",
            "description":"Unique identifier of the reporting academic period associated with the transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":30
            },
            "x-queryable":true
        },
        "CreditPostingId":{
            "title":"Credit Posting ID",
            "type":"integer",
            "description":"Unique identifier of the posted transaction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date when the transaction was last updated.",
            "format":"date-time",
            "nullable":true,
            "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."
        }
    }
}

Links

creditsLOV

Operation: /fscmRestApi/resources/11.13.18.05/studentCredits

Parameters:

• finder: CreditPostingFinder

The following properties are defined on the LOV link relation:

• Source Attribute: CreditCode; Target Attribute: CreditCode
• Display Attribute: CreditName

periodsLOV

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

statusesLOV

Operation: /fscmRestApi/resources/11.13.18.05/genericLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HES_TRANSACTION_POSTING%2CApplicationCode%3DHES

The following properties are defined on the LOV link relation:

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

Back to Top