Update a fee record

patch

/fscmRestApi/resources/11.13.18.05/publicSectorFeeRecords/{FeeRecordKey}

Request

Path Parameters
Header Parameters
  • 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".
  • 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
Request Body - application/json ()
The following table describes the body parameters in the request for this task.
Root Schema : schema
Type: object
Show Source
  • The accounting date for the fee record.
  • 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.
  • Title: Agency ID
    Default Value: 1
    The identifier for the public sector agency to which this fee record belongs.
  • Title: Assessed Date
    The date when the set value of the fee is calculated.
  • Title: Bill Type
    Maximum Length: 15
    The bill type associated with the fee record.
  • Title: Currency
    Maximum Length: 3
    The currency code.
  • Title: Department
    Maximum Length: 30
    The department ID specified at the fee item level. If not specified at the fee item level, the department specified on the record type is used.
  • Title: Due Date
    The date by which the fee should be paid.
  • The accounting event identifier for the fee record.
  • Title: Amount
    The fee amount.
  • 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.
  • Title: Memo
    Maximum Length: 200
    The text field where the agency staff can enter a comment or memo regarding the fee.
  • Title: Fee Quantity
    The number of fees. This value is always 1, but may be used in the future for multiple fees of the same type.
  • Title: Status
    Maximum Length: 6
    The status of the fee record.
  • Title: Invoice
    Maximum Length: 50
    The invoice number that comes from the billing service.
  • Title: Invoice Line
    The invoice line that comes from the billing service.
  • Maximum Length: 100
    The period that applies to the transaction.
  • Title: Mapping Source
    Maximum Length: 10
    Indicates the feature that requires fee attribute mapping.
  • Title: Payment Date
    The date when the fee was paid. The timestamp comes from the payment service.
  • Title: Payment Method
    Maximum Length: 30
    The payment method used. This information comes from the payment service.
  • 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.
  • Title: Receipt
    Maximum Length: 50
    The receipt number that comes from the billing service.
  • Maximum Length: 64
    The parent record number for the data migration transaction.
  • The total amount refunded for the fee item.
  • Maximum Length: 3
    The currency code for the refund.
  • Title: Revenue Recognition Date
    Maximum Length: 30
    The revenue recognition accounting date option from the common fee item table for the selected fee item.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : publicSectorFeeRecords-item-response
Type: object
Show Source
Back to Top