Create a set of case fee records
post
/fscmRestApi/resources/11.13.18.05/publicSectorCaseFeeRecords
Request
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.
-
Upsert-Mode:
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
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The agency identifier of the case fee record. -
AssessedDate(required): string
(date-time)
Title:
Assessed Date
The assessed date for the case fee record. -
AutoAssessedFlag: boolean
Maximum Length:
1
Default Value:false
The indicator for the fee assessment method for the case fee record. -
CaseFeeSearchRequests: array
Case Fee Search Requests
Title:
Case Fee Search Requests
The case fee search request resource is used to search Code Enforcement case fees that are in due status. -
CaseKey(required): integer
(int64)
The unique identifier for the case.
-
CasePuid(required): string
Maximum Length:
480
The public unique identifier of the migrated case record. -
CurrencyCode: string
Title:
Currency
Maximum Length:3
Default Value:USD
The currency code for the case fee record. -
DepartmentId: string
Maximum Length:
30
The department identifier of the case fee record. -
DueDate: string
(date)
Title:
Due Date
The due date to pay the case fee. -
FeeAmount(required): number
Title:
Amount
The fee amount for the case fee record. -
FeeItemId(required): string
Title:
Fee Item
Maximum Length:30
The fee item identifier of the case fee record. -
FeeMemo: string
Title:
Comments
Maximum Length:500
The fee comments for the case fee record. -
FeeQuantity: number
Title:
Quantity
Default Value:1
The fee quantity for the case fee record. -
FeeRecordId: string
Title:
Fee Record ID
Maximum Length:50
The unique identifier of the case fee record. -
FeeRecordPuid(required): string
Maximum Length:
480
The public unique identifier of the migrated case fee record. -
FeeScheduleId: string
Maximum Length:
20
The fee schedule identifier of the case fee record. -
FeeScheduleLine: integer
(int64)
The fee schedule line of the case fee record.
-
FeeSource: string
Title:
Fee Source
Maximum Length:15
Default Value:ORA_MAN
The fee source for the case fee record. -
FeeStatus: string
Title:
Status
Maximum Length:15
Default Value:ORA_DUE
The fee status for the case fee record. -
ItemRecKey: integer
(int32)
The unique identifier of the payment history item of the case fee record.
-
MappingSource: string
Maximum Length:
10
The 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 Date
The payment date for the case fee record. -
PaymentHistoryKey: integer
(int64)
Title:
Payment Receipt
The unique identifier of the payment history of the case fee record. -
SourceTransactionKey: integer
(int64)
The unique identifier for the fee source transaction key.
-
SourceTransactionPuid: string
The public unique identifier of the fee source transaction key.
Nested Schema : Case Fee Search Requests
Type:
array
Title:
Case Fee Search Requests
The 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-post-request
Type:
Show Source
object
-
AdditionalAttributes: string
The additional attributes for the case fee search request.
-
FeeRecordKey: integer
(int64)
The unique identifier of the case fee record.
-
SearchId: string
Maximum Length:
50
The search identifier for the case fee search request. -
SearchRequestKey: integer
(int64)
The unique identifier of the case fee search request.
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.
Root Schema : publicSectorCaseFeeRecords-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The agency identifier of the case fee record. -
AssessedDate: string
(date-time)
Title:
Assessed Date
The assessed date for the case fee record. -
AutoAssessedFlag: boolean
Maximum Length:
1
Default Value:false
The indicator for the fee assessment method for the case fee record. -
CaseFeeSearchRequests: array
Case Fee Search Requests
Title:
Case Fee Search Requests
The 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:
480
The public unique identifier of the migrated case record. -
CitationId: string
Title:
Citation ID
Read Only:true
Maximum Length:50
Default Value:NEXT
The unique identifier of the associated citation record. -
CitationKey: integer
(int64)
Read Only:
true
The unique identifier of the associated citation record. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:3
Default Value:USD
The currency code for the case fee record. -
DepartmentId: string
Maximum Length:
30
The department identifier of the case fee record. -
DueDate: string
(date)
Title:
Due Date
The due date to pay the case fee. -
FeeAmount: number
Title:
Amount
The fee amount for the case fee record. -
FeeItemDescription: string
Title:
Fee Item
Read Only:true
Maximum Length:255
The description of the fee item. -
FeeItemId: string
Title:
Fee Item
Maximum Length:30
The fee item identifier of the case fee record. -
FeeMemo: string
Title:
Comments
Maximum Length:500
The fee comments for the case fee record. -
FeeQuantity: number
Title:
Quantity
Default Value:1
The fee quantity for the case fee record. -
FeeRecordId: string
Title:
Fee Record ID
Maximum Length:50
The unique identifier of the case fee record. -
FeeRecordKey: integer
(int64)
Read Only:
true
The unique identifier of the case fee record. -
FeeRecordPuid: string
Maximum Length:
480
The public unique identifier of the migrated case fee record. -
FeeReferenceId: string
Title:
Source Transaction ID
Read Only:true
Maximum Length:255
The unique reference identifier of the case fee record. -
FeeScheduleId: string
Maximum Length:
20
The fee schedule identifier of the case fee record. -
FeeScheduleLine: integer
(int64)
The fee schedule line of the case fee record.
-
FeeSource: string
Title:
Fee Source
Maximum Length:15
Default Value:ORA_MAN
The fee source for the case fee record. -
FeeStatus: string
Title:
Status
Maximum Length:15
Default Value:ORA_DUE
The fee status for the case fee record. -
Invoice: string
Title:
Invoice
Read Only:true
Maximum Length:50
The unique identifier of the invoice of the case fee record. -
InvoiceLine: integer
(int64)
Read Only:
true
The 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 Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The name of the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MappingSource: string
Maximum Length:
10
The 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 Date
The payment date for the case fee record. -
PaymentHistoryKey: integer
(int64)
Title:
Payment Receipt
The unique identifier of the payment history of the case fee record. -
PaymentReferenceId: string
Title:
Payment Reference ID
Read Only:true
Maximum Length:255
The unique identifier of the payment history of the case fee record. -
SearchId: string
Read Only:
true
Maximum Length:50
The 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:
true
Maximum Length:255
The status of the fee source transaction.
Nested Schema : Case Fee Search Requests
Type:
array
Title:
Case Fee Search Requests
The case fee search request resource is used to search Code Enforcement case fees that are in due status.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The 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:
true
The 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:
true
The date and time when the row was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ResponseText: string
Read Only:
true
Maximum Length:80
The response text provided by the case fee search request. -
SearchId: string
Maximum Length:
50
The search identifier for the case fee search request. -
SearchRequestKey: integer
(int64)
The unique identifier of the case fee search request.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.
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: