Jump to

• Request
• Response

Get a case fee record

get

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

Request

Path Parameters

• FeeRecordKey(required): integer(int64)
  The unique identifier of the case fee record.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : publicSectorCaseFeeRecords-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 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.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "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
        },
        "FeeMemo":{
            "title":"Comments",
            "maxLength":500,
            "type":"string",
            "description":"The fee comments for the case fee record.",
            "nullable":true,
            "x-queryable":true
        },
        "Invoice":{
            "title":"Invoice",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the invoice of the case fee record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "ParentFeeRecordKey":{
            "type":"integer",
            "description":"The unique identifier of the parent row for the case fee record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CitationKey":{
            "type":"integer",
            "description":"The unique identifier of the associated citation record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SourceTransactionPuid":{
            "type":"string",
            "description":"The public unique identifier of the fee source transaction key.",
            "nullable":true,
            "x-queryable":true
        },
        "CasePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case record.",
            "nullable":false,
            "x-queryable":true
        },
        "ParentFeeRecordPuid":{
            "type":"string",
            "description":"The public unique identifier of the migrated parent case fee record.",
            "nullable":true,
            "x-queryable":true
        },
        "FeeScheduleLine":{
            "type":"integer",
            "description":"The fee schedule line of the case fee record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":20
            },
            "x-queryable":true
        },
        "PaymentReferenceId":{
            "title":"Payment Reference ID",
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of the payment history of the case fee record.",
            "nullable":true,
            "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
        },
        "FeeItemId":{
            "title":"Fee Item",
            "maxLength":30,
            "type":"string",
            "description":"The fee item identifier of the case fee record.",
            "nullable":false,
            "x-queryable":true
        },
        "AssessedDate":{
            "title":"Assessed Date",
            "type":"string",
            "description":"The assessed date for the case fee record.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "FeeQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The fee quantity for the case fee record.",
            "nullable":false,
            "default":1,
            "x-queryable":true
        },
        "FeeRecordPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case fee record.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FeeItemDescription":{
            "title":"Fee Item",
            "maxLength":255,
            "type":"string",
            "description":"The description of the fee item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeScheduleId":{
            "maxLength":20,
            "type":"string",
            "description":"The fee schedule identifier of the case fee record.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceTransactionKey":{
            "type":"integer",
            "description":"The unique identifier for the fee source transaction key.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "FeeReferenceId":{
            "title":"Source Transaction ID",
            "maxLength":255,
            "type":"string",
            "description":"The unique reference identifier of the case fee record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The fee amount for the case fee record.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceTransactionStatus":{
            "maxLength":255,
            "type":"string",
            "description":"The status of the fee source transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseKey":{
            "type":"integer",
            "description":"The unique identifier for the case.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InvoiceLine":{
            "type":"integer",
            "description":"The unique identifier of the invoice line of the case fee record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PaymentDate":{
            "title":"Payment Date",
            "type":"string",
            "description":"The payment date for the case fee record.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "FeeRecordId":{
            "title":"Fee Record ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the case fee record.",
            "nullable":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
        },
        "PaymentHistoryKey":{
            "title":"Payment Receipt",
            "type":"integer",
            "description":"The unique identifier of the payment history of the case fee record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FeeSource":{
            "title":"Fee Source",
            "maxLength":15,
            "type":"string",
            "description":"The fee source for the case fee record.",
            "nullable":false,
            "default":"ORA_MAN",
            "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
        },
        "AutoAssessedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The indicator for the fee assessment method for the case fee record.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "MappingSource":{
            "maxLength":10,
            "type":"string",
            "description":"The mapping source type for the case fee record.",
            "nullable":true,
            "x-queryable":true
        },
        "DepartmentId":{
            "maxLength":30,
            "type":"string",
            "description":"The department identifier of the case fee record.",
            "nullable":true,
            "x-queryable":true
        },
        "CitationId":{
            "title":"Citation ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the associated citation record.",
            "nullable":false,
            "readOnly":true,
            "default":"NEXT",
            "x-queryable":true
        },
        "ItemRecKey":{
            "type":"integer",
            "description":"The unique identifier of the payment history item of the case fee record.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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."
        }
    }
}

Back to Top