Jump to

• Request
• Response

Update a case fee record

patch

/fscmRestApi/resources/11.13.18.05/publicSectorCaseFeeRecords/{FeeRecordKey}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• FeeRecordKey: integer
  The unique identifier of the case fee record.

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorCaseFeeRecords-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The agency identifier of the case fee record.
• AssessedDate(optional): string(date-time)
  Title: Assessed Date

  The assessed date for the case fee record.
• CaseKey(optional): integer(int64)
  The unique identifier for the case.
• CasePuid(optional): string
  Maximum Length: 480

  The public unique identifier of the migrated case record.
• CitationId(optional): string
  Title: Citation ID

  Maximum Length: 50

  The unique identifier of the associated citation record.
• CitationKey(optional): integer(int64)
  The unique identifier of the associated citation record.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• CurrencyCode(optional): string
  Title: Currency

  Maximum Length: 3

  The currency code for the case fee record.
• DepartmentId(optional): string
  Maximum Length: 30

  The department identifier of the case fee record.
• DueDate(optional): string(date)
  Title: Due Date

  The due date to pay the case fee.
• FeeAmount(optional): number
  Title: Amount

  The fee amount for the case fee record.
• FeeItemDescription(optional): string
  Title: Fee Item

  Maximum Length: 255

  The description of the fee item.
• FeeItemId(optional): string
  Title: Fee Item

  Maximum Length: 30

  The fee item identifier of the case fee record.
• FeeMemo(optional): string
  Title: Comments

  Maximum Length: 500

  The fee comments for the case fee record.
• FeeQuantity(optional): number
  Title: Quantity

  The fee quantity for the case fee record.
• FeeRecordId(optional): string
  Title: Fee Record ID

  Maximum Length: 50

  The unique identifier of the case fee record.
• FeeRecordKey(optional): integer(int64)
  The unique identifier of the case fee record.
• FeeRecordPuid(optional): string
  Maximum Length: 480

  The public unique identifier of the migrated case fee record.
• FeeReferenceId(optional): string
  Title: Fee Reference ID

  The unique reference identifier of the case fee record.
• FeeScheduleId(optional): string
  Maximum Length: 20

  The fee schedule identifier of the case fee record.
• FeeScheduleLine(optional): number
  The fee schedule line of the case fee record.
• FeeSource(optional): string
  Maximum Length: 15

  The fee source for the case fee record.
• FeeStatus(optional): string
  Title: Status

  Maximum Length: 15

  The fee status for the case fee record.
• Invoice(optional): string
  Title: Invoice

  Maximum Length: 50

  The unique identifier of the invoice of the case fee record.
• InvoiceLine(optional): integer(int64)
  The unique identifier of the invoice line of the case fee record.
• ItemRecKey(optional): integer(int32)
  The unique identifier of the payment history item of the case fee record.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• ParentFeeRecordKey(optional): integer(int64)
  The unique identifier of the parent row for the case fee record.
• PaymentDate(optional): string(date-time)
  Title: Payment Date

  The payment date for the case fee record.
• PaymentHistoryKey(optional): integer(int64)
  Title: Payment Receipt

  The unique identifier of the payment history of the case fee record.
• PaymentReferenceId(optional): string
  Title: Payment Reference ID

  Maximum Length: 255

  The unique identifier of the payment history of the case fee record.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the case fee record."
        },
        "AssessedDate":{
            "format":"date-time",
            "type":"string",
            "description":"The assessed date for the case fee record.",
            "title":"Assessed Date"
        },
        "CaseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the case."
        },
        "CasePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case record."
        },
        "CitationId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the associated citation record.",
            "title":"Citation ID"
        },
        "CitationKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the associated citation record."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "CurrencyCode":{
            "maxLength":3,
            "type":"string",
            "description":"The currency code for the case fee record.",
            "title":"Currency"
        },
        "DepartmentId":{
            "maxLength":30,
            "type":"string",
            "description":"The department identifier of the case fee record."
        },
        "DueDate":{
            "format":"date",
            "type":"string",
            "description":"The due date to pay the case fee.",
            "title":"Due Date"
        },
        "FeeAmount":{
            "type":"number",
            "description":"The fee amount for the case fee record.",
            "title":"Amount"
        },
        "FeeItemDescription":{
            "maxLength":255,
            "type":"string",
            "description":"The description of the fee item.",
            "title":"Fee Item"
        },
        "FeeItemId":{
            "maxLength":30,
            "type":"string",
            "description":"The fee item identifier of the case fee record.",
            "title":"Fee Item"
        },
        "FeeMemo":{
            "maxLength":500,
            "type":"string",
            "description":"The fee comments for the case fee record.",
            "title":"Comments"
        },
        "FeeQuantity":{
            "type":"number",
            "description":"The fee quantity for the case fee record.",
            "title":"Quantity"
        },
        "FeeRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the case fee record.",
            "title":"Fee Record ID"
        },
        "FeeRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case fee record."
        },
        "FeeRecordPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case fee record."
        },
        "FeeReferenceId":{
            "type":"string",
            "description":"The unique reference identifier of the case fee record.",
            "title":"Fee Reference ID"
        },
        "FeeScheduleId":{
            "maxLength":20,
            "type":"string",
            "description":"The fee schedule identifier of the case fee record."
        },
        "FeeScheduleLine":{
            "type":"number",
            "description":"The fee schedule line of the case fee record."
        },
        "FeeSource":{
            "maxLength":15,
            "type":"string",
            "description":"The fee source for the case fee record."
        },
        "FeeStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The fee status for the case fee record.",
            "title":"Status"
        },
        "Invoice":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the invoice of the case fee record.",
            "title":"Invoice"
        },
        "InvoiceLine":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the invoice line of the case fee record."
        },
        "ItemRecKey":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the payment history item of the case fee record."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "ParentFeeRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the parent row for the case fee record."
        },
        "PaymentDate":{
            "format":"date-time",
            "type":"string",
            "description":"The payment date for the case fee record.",
            "title":"Payment Date"
        },
        "PaymentHistoryKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the payment history of the case fee record.",
            "title":"Payment Receipt"
        },
        "PaymentReferenceId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of the payment history of the case fee record.",
            "title":"Payment Reference ID"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorCaseFeeRecords-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The agency identifier of the case fee record.
• AssessedDate(optional): string(date-time)
  Title: Assessed Date

  The assessed date for the case fee record.
• CaseKey(optional): integer(int64)
  The unique identifier for the case.
• CasePuid(optional): string
  Maximum Length: 480

  The public unique identifier of the migrated case record.
• CitationId(optional): string
  Title: Citation ID

  Maximum Length: 50

  The unique identifier of the associated citation record.
• CitationKey(optional): integer(int64)
  The unique identifier of the associated citation record.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• CurrencyCode(optional): string
  Title: Currency

  Maximum Length: 3

  The currency code for the case fee record.
• DepartmentId(optional): string
  Maximum Length: 30

  The department identifier of the case fee record.
• DueDate(optional): string(date)
  Title: Due Date

  The due date to pay the case fee.
• FeeAmount(optional): number
  Title: Amount

  The fee amount for the case fee record.
• FeeItemDescription(optional): string
  Title: Fee Item

  Maximum Length: 255

  The description of the fee item.
• FeeItemId(optional): string
  Title: Fee Item

  Maximum Length: 30

  The fee item identifier of the case fee record.
• FeeMemo(optional): string
  Title: Comments

  Maximum Length: 500

  The fee comments for the case fee record.
• FeeQuantity(optional): number
  Title: Quantity

  The fee quantity for the case fee record.
• FeeRecordId(optional): string
  Title: Fee Record ID

  Maximum Length: 50

  The unique identifier of the case fee record.
• FeeRecordKey(optional): integer(int64)
  The unique identifier of the case fee record.
• FeeRecordPuid(optional): string
  Maximum Length: 480

  The public unique identifier of the migrated case fee record.
• FeeReferenceId(optional): string
  Title: Fee Reference ID

  The unique reference identifier of the case fee record.
• FeeScheduleId(optional): string
  Maximum Length: 20

  The fee schedule identifier of the case fee record.
• FeeScheduleLine(optional): number
  The fee schedule line of the case fee record.
• FeeSource(optional): string
  Maximum Length: 15

  The fee source for the case fee record.
• FeeStatus(optional): string
  Title: Status

  Maximum Length: 15

  The fee status for the case fee record.
• Invoice(optional): string
  Title: Invoice

  Maximum Length: 50

  The unique identifier of the invoice of the case fee record.
• InvoiceLine(optional): integer(int64)
  The unique identifier of the invoice line of the case fee record.
• ItemRecKey(optional): integer(int32)
  The unique identifier of the payment history item of the case fee record.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• ParentFeeRecordKey(optional): integer(int64)
  The unique identifier of the parent row for the case fee record.
• PaymentDate(optional): string(date-time)
  Title: Payment Date

  The payment date for the case fee record.
• PaymentHistoryKey(optional): integer(int64)
  Title: Payment Receipt

  The unique identifier of the payment history of the case fee record.
• PaymentReferenceId(optional): string
  Title: Payment Reference ID

  Maximum Length: 255

  The unique identifier of the payment history of the case fee record.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the case fee record."
        },
        "AssessedDate":{
            "format":"date-time",
            "type":"string",
            "description":"The assessed date for the case fee record.",
            "title":"Assessed Date"
        },
        "CaseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the case."
        },
        "CasePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case record."
        },
        "CitationId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the associated citation record.",
            "title":"Citation ID"
        },
        "CitationKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the associated citation record."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "CurrencyCode":{
            "maxLength":3,
            "type":"string",
            "description":"The currency code for the case fee record.",
            "title":"Currency"
        },
        "DepartmentId":{
            "maxLength":30,
            "type":"string",
            "description":"The department identifier of the case fee record."
        },
        "DueDate":{
            "format":"date",
            "type":"string",
            "description":"The due date to pay the case fee.",
            "title":"Due Date"
        },
        "FeeAmount":{
            "type":"number",
            "description":"The fee amount for the case fee record.",
            "title":"Amount"
        },
        "FeeItemDescription":{
            "maxLength":255,
            "type":"string",
            "description":"The description of the fee item.",
            "title":"Fee Item"
        },
        "FeeItemId":{
            "maxLength":30,
            "type":"string",
            "description":"The fee item identifier of the case fee record.",
            "title":"Fee Item"
        },
        "FeeMemo":{
            "maxLength":500,
            "type":"string",
            "description":"The fee comments for the case fee record.",
            "title":"Comments"
        },
        "FeeQuantity":{
            "type":"number",
            "description":"The fee quantity for the case fee record.",
            "title":"Quantity"
        },
        "FeeRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the case fee record.",
            "title":"Fee Record ID"
        },
        "FeeRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case fee record."
        },
        "FeeRecordPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case fee record."
        },
        "FeeReferenceId":{
            "type":"string",
            "description":"The unique reference identifier of the case fee record.",
            "title":"Fee Reference ID"
        },
        "FeeScheduleId":{
            "maxLength":20,
            "type":"string",
            "description":"The fee schedule identifier of the case fee record."
        },
        "FeeScheduleLine":{
            "type":"number",
            "description":"The fee schedule line of the case fee record."
        },
        "FeeSource":{
            "maxLength":15,
            "type":"string",
            "description":"The fee source for the case fee record."
        },
        "FeeStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The fee status for the case fee record.",
            "title":"Status"
        },
        "Invoice":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the invoice of the case fee record.",
            "title":"Invoice"
        },
        "InvoiceLine":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the invoice line of the case fee record."
        },
        "ItemRecKey":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the payment history item of the case fee record."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "ParentFeeRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the parent row for the case fee record."
        },
        "PaymentDate":{
            "format":"date-time",
            "type":"string",
            "description":"The payment date for the case fee record.",
            "title":"Payment Date"
        },
        "PaymentHistoryKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the payment history of the case fee record.",
            "title":"Payment Receipt"
        },
        "PaymentReferenceId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of the payment history of the case fee record.",
            "title":"Payment Reference ID"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top