Jump to

• Request
• Response

Get all fee refund records

get

/fscmRestApi/resources/11.13.18.05/publicSectorFeeRefunds

Request

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds the fee refund record that matches the specified primary key. Finder Variables:
    • FeeRecordKey; integer; The unique identifier of the fee record.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorFeeRefunds

Type: object

Show Source

• count(optional): integer
  Title: Count

  The number of resource instances returned in the current range.
• hasMore(optional): boolean
  Title: HasMore

  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items(optional): array Items
  Title: Items

  The items in the collection.
• limit(optional): integer
  Title: Limit

  The actual paging size used by the server.
• links(optional): array Items
  Title: Items

  The link relations associated with the resource instance.
• offset(optional): integer
  Title: Offset

  The offset value used in the current page.

{
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.",
            "title":"HasMore"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/publicSectorFeeRefunds-item"
            },
            "type":"array",
            "description":"The items in the collection.",
            "title":"Items"
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server.",
            "title":"Limit"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "title":"Items"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page.",
            "title":"Offset"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorFeeRefunds-item

{
    "items":{
        "$ref":"#/definitions/publicSectorFeeRefunds-item"
    },
    "type":"array",
    "description":"The items in the collection.",
    "title":"Items"
}

Nested Schema : Items

Type: array

Title: Items

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "title":"Items"
}

Nested Schema : publicSectorFeeRefunds-item

Type: object

Show Source

• AccountingDate(optional): string(date)
  The accounting date of the fee record.
• AcctEventStatus(optional): string
  Title: Accounting Event Status

  Maximum Length: 3

  The accounting event status. The status indicates whether this fee has been sent to the accounting event transaction table or not.
• AgencyId(optional): integer(int64)
  Title: Agency ID

  The identifier of the public sector agency to which this fee record belongs.
• AssessedDate(optional): string(date)
  Title: Assessed Date

  The date when the set value of the fee is calculated.
• BillType(optional): string
  Title: Bill Type

  Maximum Length: 15

  The bill type associated with the fee record.
• CurrencyCode(optional): string
  Title: Currency

  Maximum Length: 3

  The currency code.
• DepartmentId(optional): string
  Title: Department

  Maximum Length: 30

  The department identifier specified at the fee item level. If not specified at the fee item level, the department that is specified on the record type is used.
• EventId(optional): integer(int64)
  The accounting event identifier for the fee record.
• FeeAmount(optional): number
  Title: Amount

  The fee amount.
• FeeItemId(optional): string
  Title: Fee Item

  Maximum Length: 30

  The fee Item from the common fee item table. If the fee item exists in the table, then the value from the decision model is used. If the fee item does not exist in the table, then the default fee item specified on the fee schedule is used.
• FeeMemo(optional): string
  Title: Memo

  Maximum Length: 200

  The text field where the agency staff can enter a comment or memo regarding the fee.
• FeeQuantity(optional): number
  Title: Fee Quantity

  The number of fee items. This value is presently 1, but may be used in the future for multiple fees of the same type.
• FeeRecordKey(optional): integer(int64)
  Title: Fee Record

  The unique identifier of the fee record.
• FeeReferenceKey(optional): integer(int64)
  The parent fee transaction record.
• FeeScheduleId(optional): string
  Title: Fee Schedule

  Maximum Length: 20

  The unique identifier of the fee schedule.
• FeeScheduleLine(optional): integer(int64)
  Title: Fee Items

  The line number of the current fee schedule.
• FeeSource(optional): string
  Title: Source

  Maximum Length: 3

  The source of the fee. The source indicates that the fee was created either by the system or by a user.
• FeeStatus(optional): string
  Title: Status

  Maximum Length: 6

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

  Maximum Length: 50

  The invoice number that comes from the billing service.
• InvoiceLine(optional): integer(int32)
  Title: Invoice Line

  The invoice line that comes from the billing service.
• links(optional): array Items
  Title: Items

  Link Relations
• LnpRecordId(optional): string
  Title: Record ID

  Maximum Length: 50

  The logical record identifier of the parent.
• LnpRecordKey(optional): integer(int64)
  The unique identifier of the record with the parent ID of the fee record.
• PaymentDate(optional): string(date-time)
  Title: Payment Date

  The date when the fee was paid.
• PaymentMethodCode(optional): string
  Title: Payment Method

  Maximum Length: 30

  The payment method used. This information comes from the payment service.
• PaymentReferenceId(optional): string
  Title: Payment Reference

  Maximum Length: 50

  The identifier generated by the payment service once the payment has been confirmed. The reference ID helps to identify groupings for invoice purposes.
• ReceiptNumber(optional): string
  Title: Receipt

  Maximum Length: 50

  The receipt number that comes from the billing service.
• RefundedAmount(optional): number
  The total amount refunded for the fee item.
• RefundedCurrencyCode(optional): string
  Maximum Length: 3

  The currency code for the refund.
• RefundReason(optional): string
  Maximum Length: 30

  The reason for the refund.
• RevrecDateOption(optional): string
  Title: Revenue Recognition Date

  Maximum Length: 30

  The revenue recognition accounting date option from the common fee item table for the selected fee item.

{
    "properties":{
        "AccountingDate":{
            "format":"date",
            "type":"string",
            "description":"The accounting date of the fee record."
        },
        "AcctEventStatus":{
            "maxLength":3,
            "type":"string",
            "description":"The accounting event status. The status indicates whether this fee has been sent to the accounting event transaction table or not.",
            "title":"Accounting Event Status"
        },
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier of the public sector agency to which this fee record belongs.",
            "title":"Agency ID"
        },
        "AssessedDate":{
            "format":"date",
            "type":"string",
            "description":"The date when the set value of the fee is calculated.",
            "title":"Assessed Date"
        },
        "BillType":{
            "maxLength":15,
            "type":"string",
            "description":"The bill type associated with the fee record.",
            "title":"Bill Type"
        },
        "CurrencyCode":{
            "maxLength":3,
            "type":"string",
            "description":"The currency code.",
            "title":"Currency"
        },
        "DepartmentId":{
            "maxLength":30,
            "type":"string",
            "description":"The department identifier specified at the fee item level. If not specified at the fee item level, the department that is specified on the record type is used.",
            "title":"Department"
        },
        "EventId":{
            "format":"int64",
            "type":"integer",
            "description":"The accounting event identifier for the fee record."
        },
        "FeeAmount":{
            "type":"number",
            "description":"The fee amount.",
            "title":"Amount"
        },
        "FeeItemId":{
            "maxLength":30,
            "type":"string",
            "description":"The fee Item from the common fee item table. If the fee item exists in the table, then the value from the decision model is used. If the fee item does not exist in the table, then the default fee item specified on the fee schedule is used.",
            "title":"Fee Item"
        },
        "FeeMemo":{
            "maxLength":200,
            "type":"string",
            "description":"The text field where the agency staff can enter a comment or memo regarding the fee.",
            "title":"Memo"
        },
        "FeeQuantity":{
            "type":"number",
            "description":"The number of fee items. This value is presently 1, but may be used in the future for multiple fees of the same type.",
            "title":"Fee Quantity"
        },
        "FeeRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the fee record.",
            "title":"Fee Record"
        },
        "FeeReferenceKey":{
            "format":"int64",
            "type":"integer",
            "description":"The parent fee transaction record."
        },
        "FeeScheduleId":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of the fee schedule.",
            "title":"Fee Schedule"
        },
        "FeeScheduleLine":{
            "format":"int64",
            "type":"integer",
            "description":"The line number of the current fee schedule.",
            "title":"Fee Items"
        },
        "FeeSource":{
            "maxLength":3,
            "type":"string",
            "description":"The source of the fee. The source indicates that the fee was created either by the system or by a user.",
            "title":"Source"
        },
        "FeeStatus":{
            "maxLength":6,
            "type":"string",
            "description":"The status of the fee record.",
            "title":"Status"
        },
        "Invoice":{
            "maxLength":50,
            "type":"string",
            "description":"The invoice number that comes from the billing service.",
            "title":"Invoice"
        },
        "InvoiceLine":{
            "format":"int32",
            "type":"integer",
            "description":"The invoice line that comes from the billing service.",
            "title":"Invoice Line"
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The logical record identifier of the parent.",
            "title":"Record ID"
        },
        "LnpRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the record with the parent ID of the fee record."
        },
        "PaymentDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the fee was paid.",
            "title":"Payment Date"
        },
        "PaymentMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"The payment method used. This information comes from the payment service.",
            "title":"Payment Method"
        },
        "PaymentReferenceId":{
            "maxLength":50,
            "type":"string",
            "description":"The identifier generated by the payment service once the payment has been confirmed. The reference ID helps to identify groupings for invoice purposes.",
            "title":"Payment Reference"
        },
        "ReceiptNumber":{
            "maxLength":50,
            "type":"string",
            "description":"The receipt number that comes from the billing service.",
            "title":"Receipt"
        },
        "RefundReason":{
            "maxLength":30,
            "type":"string",
            "description":"The reason for the refund."
        },
        "RefundedAmount":{
            "type":"number",
            "description":"The total amount refunded for the fee item."
        },
        "RefundedCurrencyCode":{
            "maxLength":3,
            "type":"string",
            "description":"The currency code for the refund."
        },
        "RevrecDateOption":{
            "maxLength":30,
            "type":"string",
            "description":"The revenue recognition accounting date option from the common fee item table for the selected fee item.",
            "title":"Revenue Recognition Date"
        },
        "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