Update a student receipt credit
patch
/fscmRestApi/resources/11.13.18.05/studentCreditReceipts/{CreditId}
Request
Path Parameters
-
CreditId(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:
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ChargePriorityCode: string
Maximum Length:
30
Unique code of the charge priority mapping. -
ChargePriorityId: integer
(int64)
Unique identifier of the charge priority mapping.
-
CreditDescription: string
Maximum Length:
240
Additional information about the credit. -
CreditName: string
Maximum Length:
50
Name of the credit. -
CreditSourceCode: string
Maximum Length:
30
Unique code of the credit source. -
MaximumAmount: number
Maximum amount of this credit.
-
Priority: integer
(int32)
Default Value:
9999
Priority assigned to the credit. -
receiptMethods: array
Receipt Methods
Title:
Receipt Methods
The receipt methods resource is used to associate charge priority mappings with receipt methods. -
StatusCode: string
Maximum Length:
30
Status of the credit. It can be active or inactive.
Nested Schema : Receipt Methods
Type:
array
Title:
Receipt Methods
The receipt methods resource is used to associate charge priority mappings with receipt methods.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
Description: string
Maximum Length:
4000
Custom description that's set up for the receipt method in the context of the credit setup. -
ReceiptMethodId: integer
(int64)
Unique identifier of the receipt method mapped to the credit.
-
ReceiptMethodName: string
Title:
Receipt Method
Maximum Length:30
Name of the receipt method.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : studentCreditReceipts-item-response
Type:
Show Source
object
-
BusinessUnitId: integer
(int64)
Unique identifier of the business unit.
-
BusinessUnitName: string
Title:
Business Unit
Maximum Length:240
Name of the business unit. -
ChargePriorityCode: string
Maximum Length:
30
Unique code of the charge priority mapping. -
ChargePriorityId: integer
(int64)
Unique identifier of the charge priority mapping.
-
ChargePriorityName: string
Read Only:
true
Maximum Length:50
Name of the charge priority mapping. -
CreditCode: string
Maximum Length:
30
Unique user-defined credit code. -
CreditDescription: string
Maximum Length:
240
Additional information about the credit. -
CreditId: integer
(int64)
Read Only:
true
Unique identifier of the credit. -
CreditName: string
Maximum Length:
50
Name of the credit. -
CreditSourceCode: string
Maximum Length:
30
Unique code of the credit source. -
CreditSourceMeaning: string
Read Only:
true
Maximum Length:80
Description of the source of the credit. -
CurrencyCode: string
Title:
Currency Code
Read Only:true
Maximum Length:15
Unique code for the currency used in the primary ledger of the business unit. -
CurrencySymbol: string
Title:
Symbol
Read Only:true
Maximum Length:12
Symbol of the applicable currency. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumAmount: number
Maximum amount of this credit.
-
Priority: integer
(int32)
Default Value:
9999
Priority assigned to the credit. -
receiptMethods: array
Receipt Methods
Title:
Receipt Methods
The receipt methods resource is used to associate charge priority mappings with receipt methods. -
StatusCode: string
Maximum Length:
30
Status of the credit. It can be active or inactive. -
StatusMeaning: string
Read Only:
true
Maximum Length:80
Full description of the status set for the credit.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Receipt Methods
Type:
array
Title:
Receipt Methods
The receipt methods resource is used to associate charge priority mappings with receipt methods.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : studentCreditReceipts-receiptMethods-item-response
Type:
Show Source
object
-
CreditReceiptId: integer
(int64)
Read Only:
true
Unique identifier of the credit of receipt type. -
Description: string
Maximum Length:
4000
Custom description that's set up for the receipt method in the context of the credit setup. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReceiptMethodId: integer
(int64)
Unique identifier of the receipt method mapped to the credit.
-
ReceiptMethodName: string
Title:
Receipt Method
Maximum Length:30
Name of the receipt method.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- chargePrioritiesLOV
-
Parameters:
- finder:
FindByActiveDateAndBusinessUnit
The following properties are defined on the LOV link relation:- Source Attribute: ChargePriorityCode; Target Attribute: ChargePriorityCode
- Display Attribute: ChargePriorityName
- finder:
- creditSourcesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_CREDIT_SOURCE_CODE
The following properties are defined on the LOV link relation:- Source Attribute: CreditSourceCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- receiptMethods
-
Parameters:
- CreditId:
$request.path.CreditId
The receipt methods resource is used to associate charge priority mappings with receipt methods. - CreditId:
- statusesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HES_CREDIT_STATUS_CODE
The following properties are defined on the LOV link relation:- Source Attribute: StatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- studentFinancialSystemConfigurationsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: BusinessUnitName; Target Attribute: Name
- Display Attribute: Name