Update a case fee record
patch
/fscmRestApi/resources/11.13.18.05/publicSectorCaseFeeRecords/{FeeRecordKey}
Request
Path Parameters
-
FeeRecordKey(required): integer(int64)
The unique identifier of the case fee record.
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
Root Schema : schema
Type:
Show Source
object-
AssessedDate: string
(date-time)
Title:
Assessed DateThe assessed date for the case fee record. -
CaseFeeSearchRequests: array
Case Fee Search Requests
Title:
Case Fee Search RequestsThe case fee search request resource is used to search Code Enforcement case fees that are in due status. -
CurrencyCode: string
Title:
CurrencyMaximum Length:3Default Value:USDThe currency code for the case fee record. -
DepartmentId: string
Maximum Length:
30The department identifier of the case fee record. -
DueDate: string
(date)
Title:
Due DateThe due date to pay the case fee. -
FeeAmount: number
Title:
AmountThe fee amount for the case fee record. -
FeeItemId: string
Title:
Fee ItemMaximum Length:30The fee item identifier of the case fee record. -
FeeMemo: string
Title:
CommentsMaximum Length:500The fee comments for the case fee record. -
FeeQuantity: number
Title:
QuantityDefault Value:1The fee quantity for the case fee record. -
FeeStatus: string
Title:
StatusMaximum Length:15Default Value:ORA_DUEThe fee status for the case fee record. -
ItemRecKey: integer
(int32)
The unique identifier of the payment history item of the case fee record.
-
PaymentDate: string
(date-time)
Title:
Payment DateThe payment date for the case fee record. -
PaymentHistoryKey: integer
(int64)
Title:
Payment ReceiptThe unique identifier of the payment history of the case fee record.
Nested Schema : Case Fee Search Requests
Type:
arrayTitle:
Case Fee Search RequestsThe case fee search request resource is used to search Code Enforcement case fees that are in due status.
Show Source
Nested Schema : publicSectorCaseFeeRecords-CaseFeeSearchRequests-item-patch-request
Type:
Show Source
objectResponse
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.
Root Schema : publicSectorCaseFeeRecords-item-response
Type:
Show Source
object-
AgencyId: integer
(int32)
Default Value:
1The agency identifier of the case fee record. -
AssessedDate: string
(date-time)
Title:
Assessed DateThe assessed date for the case fee record. -
AutoAssessedFlag: boolean
Maximum Length:
1Default Value:falseThe indicator for the fee assessment method for the case fee record. -
CaseFeeSearchRequests: array
Case Fee Search Requests
Title:
Case Fee Search RequestsThe case fee search request resource is used to search Code Enforcement case fees that are in due status. -
CaseKey: integer
(int64)
The unique identifier for the case.
-
CasePuid: string
Maximum Length:
480The public unique identifier of the migrated case record. -
CitationId: string
Title:
Citation IDRead Only:trueMaximum Length:50Default Value:NEXTThe unique identifier of the associated citation record. -
CitationKey: integer
(int64)
Read Only:
trueThe unique identifier of the associated citation record. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The name of the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the row was created. -
CurrencyCode: string
Title:
CurrencyMaximum Length:3Default Value:USDThe currency code for the case fee record. -
DepartmentId: string
Maximum Length:
30The department identifier of the case fee record. -
DueDate: string
(date)
Title:
Due DateThe due date to pay the case fee. -
FeeAmount: number
Title:
AmountThe fee amount for the case fee record. -
FeeItemDescription: string
Title:
Fee ItemRead Only:trueMaximum Length:255The description of the fee item. -
FeeItemId: string
Title:
Fee ItemMaximum Length:30The fee item identifier of the case fee record. -
FeeMemo: string
Title:
CommentsMaximum Length:500The fee comments for the case fee record. -
FeeQuantity: number
Title:
QuantityDefault Value:1The fee quantity for the case fee record. -
FeeRecordId: string
Title:
Fee Record IDMaximum Length:50The unique identifier of the case fee record. -
FeeRecordKey: integer
(int64)
Read Only:
trueThe unique identifier of the case fee record. -
FeeRecordPuid: string
Maximum Length:
480The public unique identifier of the migrated case fee record. -
FeeReferenceId: string
Title:
Source Transaction IDRead Only:trueMaximum Length:255The unique reference identifier of the case fee record. -
FeeScheduleId: string
Maximum Length:
20The fee schedule identifier of the case fee record. -
FeeScheduleLine: integer
(int64)
The fee schedule line of the case fee record.
-
FeeSource: string
Title:
Fee SourceMaximum Length:15Default Value:ORA_MANThe fee source for the case fee record. -
FeeStatus: string
Title:
StatusMaximum Length:15Default Value:ORA_DUEThe fee status for the case fee record. -
Invoice: string
Title:
InvoiceRead Only:trueMaximum Length:50The unique identifier of the invoice of the case fee record. -
InvoiceLine: integer
(int64)
Read Only:
trueThe unique identifier of the invoice line of the case fee record. -
ItemRecKey: integer
(int32)
The unique identifier of the payment history item of the case fee record.
-
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The name of the user who last updated the row. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MappingSource: string
Maximum Length:
10The mapping source type for the case fee record. -
ParentFeeRecordKey: integer
(int64)
The unique identifier of the parent row for the case fee record.
-
ParentFeeRecordPuid: string
The public unique identifier of the migrated parent case fee record.
-
PaymentDate: string
(date-time)
Title:
Payment DateThe payment date for the case fee record. -
PaymentHistoryKey: integer
(int64)
Title:
Payment ReceiptThe unique identifier of the payment history of the case fee record. -
PaymentReferenceId: string
Title:
Payment Reference IDRead Only:trueMaximum Length:255The unique identifier of the payment history of the case fee record. -
SearchId: string
Read Only:
trueMaximum Length:50The search identifier for the case fee search request. -
SourceTransactionKey: integer
(int64)
The unique identifier for the fee source transaction key.
-
SourceTransactionPuid: string
The public unique identifier of the fee source transaction key.
-
SourceTransactionStatus: string
Read Only:
trueMaximum Length:255The status of the fee source transaction.
Nested Schema : Case Fee Search Requests
Type:
arrayTitle:
Case Fee Search RequestsThe case fee search request resource is used to search Code Enforcement case fees that are in due status.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorCaseFeeRecords-CaseFeeSearchRequests-item-response
Type:
Show Source
object-
AdditionalAttributes: string
The additional attributes for the case fee search request.
-
CreationDate: string
(date-time)
Read Only:
trueThe date and time when the row was created. -
FeeRecordKey: integer
(int64)
The unique identifier of the case fee record.
-
LastUpdateDate: string
(date-time)
Read Only:
trueThe date and time when the row was last updated. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ResponseText: string
Read Only:
trueMaximum Length:80The response text provided by the case fee search request. -
SearchId: string
Maximum Length:
50The search identifier for the case fee search request. -
SearchRequestKey: integer
(int64)
The unique identifier of the case fee search request.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Links
- CaseFeeSearchRequests
-
Parameters:
- FeeRecordKey:
$request.path.FeeRecordKey
The case fee search request resource is used to search Code Enforcement case fees that are in due status. - FeeRecordKey: