Jump to

• Request
• Response

Update an academic period credit exception

patch

/fscmRestApi/resources/11.13.18.05/studentCreditExternalFunds/{studentCreditExternalFundsUniqID}/child/periodOverrides/{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=
• studentCreditExternalFundsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the External Fund Credits resource and used to uniquely identify an instance of External Fund Credits. The client should not generate the hash key value. Instead, the client should query on the External Fund Credits collection resource in order to navigate to a specific instance of External Fund Credits to get the hash key.

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

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.
• EndDate: string (date)
  Date when the credit period is archived.
• 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.
• ReceivableActivityId: integer (int64)
  Unique identifier of the receivables activity when the credit is posted for the academic period.
• ReceivableActivityName: string
  Maximum Length: 255

  The name of the receivables activity assigned to a transaction.
• 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":{
        "TransactionTypeName":{
            "title":"Transaction Type Name",
            "maxLength":20,
            "type":"string",
            "description":"Name of the transaction type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MemoLineName":{
            "title":"Memo Line Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the memo line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ReceivableActivityName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the receivables activity assigned to a transaction.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AcademicPeriodName":{
            "title":"Period Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the academic period.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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"
                ]
            }
        },
        "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"
                ]
            }
        },
        "AcademicPeriodId":{
            "type":"integer",
            "description":"Unique identifier of the academic period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "AcademicPeriodName"
                ]
            }
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the credit period is archived.",
            "format":"date",
            "nullable":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"
                ]
            }
        }
    }
}

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-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)
  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)
  Unique identifier of the credit period.
• EndDate: string (date)
  Date when the credit period is archived.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• 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.
• ReceivableActivityId: integer (int64)
  Unique identifier of the receivables activity when the credit is posted for the academic period.
• ReceivableActivityName: string
  Maximum Length: 255

  The name of the receivables activity assigned to a transaction.
• 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":{
        "AcademicPeriodEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the academic period.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "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
        },
        "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
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the credit period is archived.",
            "format":"date",
            "nullable":true,
            "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
        },
        "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
        },
        "ReceivableActivityName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the receivables activity assigned to a transaction.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreditPeriodId":{
            "type":"integer",
            "description":"Unique identifier of the credit period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AcademicPeriodId":{
            "type":"integer",
            "description":"Unique identifier of the academic period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "AcademicPeriodName"
                ]
            },
            "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
        }
    }
}

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

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