Jump to

• Request
• Response

Update a case fee record

patch

/fscmRestApi/resources/11.13.18.05/publicSectorCaseCodeReferences/{CodeReferenceKey}/child/FeeRecords/{FeeRecordsUniqID}

Request

Path Parameters

• CodeReferenceKey(required): integer(int64)
  The unique identifier of the case code reference.
• FeeRecordsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Case Fee Records resource and used to uniquely identify an instance of Case Fee Records. The client should not generate the hash key value. Instead, the client should query on the Case Fee Records collection resource in order to navigate to a specific instance of Case Fee Records to get the hash key.

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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 : publicSectorCaseCodeReferences-FeeRecords-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

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

  The date on which the fee was assessed for the case fee record.
• 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.
• 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

  Read Only: true

  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.
• FeeStatus: string
  Title: Status

  Maximum Length: 15

  Default Value: ORA_DUE

  The fee status for the case fee record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MappingSource: string
  Read Only: true

  Maximum Length: 10

  The mapping source type for the case fee record.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"The agency identifier of the case fee record.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "AssessedDate":{
            "title":"Assessed Date",
            "type":"string",
            "description":"The date on which the fee was assessed for the case fee record.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":3,
            "type":"string",
            "description":"The currency code for the case fee record.",
            "nullable":false,
            "default":"USD",
            "x-queryable":true
        },
        "DepartmentId":{
            "maxLength":30,
            "type":"string",
            "description":"The department identifier of the case fee record.",
            "nullable":true,
            "x-queryable":true
        },
        "DueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The due date to pay the case fee.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "FeeAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The fee amount for the case fee record.",
            "nullable":false,
            "x-queryable":true
        },
        "FeeItemId":{
            "title":"Fee Item",
            "maxLength":30,
            "type":"string",
            "description":"The fee item identifier of the case fee record.",
            "nullable":false,
            "x-queryable":true
        },
        "FeeMemo":{
            "title":"Comments",
            "maxLength":500,
            "type":"string",
            "description":"The fee comments for the case fee record.",
            "nullable":true,
            "x-queryable":true
        },
        "FeeQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The fee quantity for the case fee record.",
            "nullable":false,
            "default":1,
            "x-queryable":true
        },
        "FeeRecordId":{
            "title":"Fee Record ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the case fee record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeRecordKey":{
            "type":"integer",
            "description":"The unique identifier of the case fee record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FeeStatus":{
            "title":"Status",
            "maxLength":15,
            "type":"string",
            "description":"The fee status for the case fee record.",
            "nullable":false,
            "default":"ORA_DUE",
            "x-queryable":true
        },
        "MappingSource":{
            "maxLength":10,
            "type":"string",
            "description":"The mapping source type for the case fee record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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."
        }
    }
}

Back to Top