Jump to

• Request
• Response

Get all fee refund records

get

/fscmRestApi/resources/11.13.18.05/publicSectorFeeRefunds

Request

Query Parameters

• 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
• 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.
• 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
  
• 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 fields. 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
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AccountingDate; string; The accounting date of the fee record.
  • AcctEventStatus; string; The accounting event status. The status indicates whether this fee has been sent to the accounting event transaction table or not.
  • AgencyId; integer; The identifier of the public sector agency to which this fee record belongs.
  • AssessedDate; string; The date when the set value of the fee is calculated.
  • BillType; string; The bill type associated with the fee record.
  • CurrencyCode; string; The currency code.
  • DepartmentId; string; 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; integer; The accounting event identifier for the fee record.
  • FeeAmount; number; The fee amount.
  • FeeItemId; string; 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; string; The text field where the agency staff can enter a comment or memo regarding the fee.
  • FeeQuantity; number; 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; integer; The unique identifier of the fee record.
  • FeeReferenceKey; integer; The parent fee transaction record.
  • FeeScheduleId; string; The unique identifier of the fee schedule.
  • FeeScheduleLine; integer; The line number of the current fee schedule.
  • FeeSource; string; The source of the fee. The source indicates that the fee was created either by the system or by a user.
  • FeeStatus; string; The status of the fee record.
  • Invoice; string; The invoice number that comes from the billing service.
  • InvoiceLine; integer; The invoice line that comes from the billing service.
  • LnpRecordId; string; The logical record identifier of the parent.
  • LnpRecordKey; integer; The unique identifier of the record with the parent ID of the fee record.
  • PaymentDate; string; The date when the fee was paid.
  • PaymentMethodCode; string; The payment method used. This information comes from the payment service.
  • PaymentReferenceId; string; The identifier generated by the payment service once the payment has been confirmed. The reference ID helps to identify groupings for invoice purposes.
  • ReceiptNumber; string; The receipt number that comes from the billing service.
  • RefundReason; string; The reason for the refund.
  • RefundedAmount; number; The total amount refunded for the fee item.
  • RefundedCurrencyCode; string; The currency code for the refund.
  • ReversalReason; string; The reason for the reversal.
  • RevrecDateOption; string; The revenue recognition accounting date option from the common fee item table for the selected fee item.
• 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".

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:
  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 : publicSectorFeeRefunds

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  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: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorFeeRefunds-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"CommonSetup",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorFeeRefunds-item-response

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

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 : publicSectorFeeRefunds-item-response

Type: object

Show Source

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

  Maximum Length: 3

  Default Value: I

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

  Default Value: 1

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

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

  Maximum Length: 15

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

  Maximum Length: 3

  The currency code.
• DepartmentId: 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: integer (int64)
  The accounting event identifier for the fee record.
• FeeAmount: number
  Title: Amount

  The fee amount.
• FeeItemId: 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: string
  Title: Memo

  Maximum Length: 200

  The text field where the agency staff can enter a comment or memo regarding the fee.
• FeeQuantity: 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: integer (int64)
  Title: Fee Record

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

  Maximum Length: 20

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

  The line number of the current fee schedule.
• FeeSource: 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: string
  Title: Status

  Maximum Length: 6

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

  Maximum Length: 50

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

  The invoice line that comes from the billing service.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordId: string
  Title: Record ID

  Maximum Length: 50

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

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

  Maximum Length: 30

  The payment method used. This information comes from the payment service.
• PaymentReferenceId: 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: string
  Title: Receipt

  Maximum Length: 50

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

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

  The reason for the refund.
• ReversalReason: string
  Maximum Length: 30

  The reason for the reversal.
• RevrecDateOption: 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.

{
    "type":"object",
    "properties":{
        "FeeMemo":{
            "title":"Memo",
            "maxLength":"200",
            "type":"string",
            "description":"The text field where the agency staff can enter a comment or memo regarding the fee.",
            "nullable":true,
            "x-queryable":true
        },
        "Invoice":{
            "title":"Invoice",
            "maxLength":"50",
            "type":"string",
            "description":"The invoice number that comes from the billing service.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier of the public sector agency to which this fee record belongs.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "AccountingDate":{
            "type":"string",
            "description":"The accounting date of the fee record.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "FeeScheduleLine":{
            "title":"Fee Items",
            "type":"integer",
            "description":"The line number of the current fee schedule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"20"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"3",
            "type":"string",
            "description":"The currency code.",
            "nullable":false,
            "x-queryable":true
        },
        "PaymentReferenceId":{
            "title":"Payment Reference",
            "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.",
            "nullable":true,
            "x-queryable":true
        },
        "AssessedDate":{
            "title":"Assessed Date",
            "type":"string",
            "description":"The date when the set value of the fee is calculated.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "FeeItemId":{
            "title":"Fee Item",
            "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.",
            "nullable":false,
            "x-queryable":true
        },
        "FeeReferenceKey":{
            "type":"integer",
            "description":"The parent fee transaction record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AcctEventStatus":{
            "title":"Accounting Event Status",
            "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.",
            "nullable":true,
            "default":"I",
            "x-queryable":true
        },
        "FeeQuantity":{
            "title":"Fee Quantity",
            "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.",
            "nullable":true,
            "x-queryable":true
        },
        "RefundedAmount":{
            "type":"number",
            "description":"The total amount refunded for the fee item.",
            "nullable":true,
            "x-queryable":true
        },
        "EventId":{
            "type":"integer",
            "description":"The accounting event identifier for the fee record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FeeScheduleId":{
            "title":"Fee Schedule",
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier of the fee schedule.",
            "nullable":true,
            "x-queryable":true
        },
        "FeeAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The fee amount.",
            "nullable":false,
            "x-queryable":true
        },
        "ReceiptNumber":{
            "title":"Receipt",
            "maxLength":"50",
            "type":"string",
            "description":"The receipt number that comes from the billing service.",
            "nullable":true,
            "x-queryable":true
        },
        "BillType":{
            "title":"Bill Type",
            "maxLength":"15",
            "type":"string",
            "description":"The bill type associated with the fee record.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Record ID",
            "maxLength":"50",
            "type":"string",
            "description":"The logical record identifier of the parent.",
            "nullable":false,
            "x-queryable":true
        },
        "InvoiceLine":{
            "title":"Invoice Line",
            "type":"integer",
            "description":"The invoice line that comes from the billing service.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PaymentDate":{
            "title":"Payment Date",
            "type":"string",
            "description":"The date when the fee was paid.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RefundedCurrencyCode":{
            "maxLength":"3",
            "type":"string",
            "description":"The currency code for the refund.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentMethodCode":{
            "title":"Payment Method",
            "maxLength":"30",
            "type":"string",
            "description":"The payment method used. This information comes from the payment service.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier of the record with the parent ID of the fee record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FeeStatus":{
            "title":"Status",
            "maxLength":"6",
            "type":"string",
            "description":"The status of the fee record.",
            "nullable":false,
            "x-queryable":true
        },
        "RevrecDateOption":{
            "title":"Revenue Recognition Date",
            "maxLength":"30",
            "type":"string",
            "description":"The revenue recognition accounting date option from the common fee item table for the selected fee item.",
            "nullable":true,
            "x-queryable":true
        },
        "FeeSource":{
            "title":"Source",
            "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.",
            "nullable":true,
            "x-queryable":true
        },
        "FeeRecordKey":{
            "title":"Fee Record",
            "type":"integer",
            "description":"The unique identifier of the fee record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RefundReason":{
            "maxLength":"30",
            "type":"string",
            "description":"The reason for the refund.",
            "nullable":true,
            "x-queryable":true
        },
        "ReversalReason":{
            "maxLength":"30",
            "type":"string",
            "description":"The reason for the reversal.",
            "nullable":true,
            "x-queryable":true
        },
        "DepartmentId":{
            "title":"Department",
            "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.",
            "nullable":false,
            "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."
        }
    }
}

Links

confirmRefund

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorFeeRefunds/action/confirmRefund

Used to initiate refund confirmation for fee items.

refundPayment

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorFeeRefunds/action/refundPayment

Used to initiate refund processing for fee items.

voidRefund

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorFeeRefunds/action/voidRefund

This marks the pending refund fee records as void and update refund amounts, when the refund request is marked as void.

Back to Top