The Reserve object represents a financial reserve set aside against a claim. A claim can carry many reserves, one per reserve type. Reserves are created or updated via AddReserve, listed via GetClaimDetail, and have nested Changes, Payments, and Recovery lists that track every modification, outgoing payment, and incoming recovery against the reserve.

The XML element name is Reserve.

Properties

Property	Datatype	FileTrac UI Location	Description
`ID`	int	—	System-generated ID unique to this reserve. Pass as `ReserveID` on `AddReservePayment` and `AddReserveRecovery`.
`Category`	string	Settings → Reserve Types	Category to which this reserve type belongs.
`Type`	string	Financials → Reserve Type	Reserve type name (e.g., `Indemnity`, `Legal Expenses`).
`Date`	dateTime	Reserve Changes → Date Changed (where reason is `Initial Reserve`)	Date the reserve was initially established.
`Updated`	dateTime	Reserve Changes → Date Changed	Date of the most recent change.
`Code`	string	—	Transaction code for import only.
`Incurred`	decimal	Financials → Incurred	Current incurred amount on this reserve.
`Changes`	List of `Change`	Reserve Changes page (accessed by clicking the incurred amount)	History of changes to the reserve amount.
`Payments`	List of `Payment`	—	Payments booked against this reserve.
`Recovery`	List of `Recovery`	—	Recoveries booked against this reserve.

Change (nested)

A Change records one modification to the reserve amount. Changes are created automatically when AddReserve is called against an existing reserve.

Property	Datatype	FileTrac UI Location	Description
`ID`	int	—	System-generated ID unique to this change.
`Date`	dateTime	Reserve Changes → Date Changed	Date of the change.
`ChangedFrom`	decimal	Reserve Changes → Old Amount	Amount before the change.
`ChangedTo`	decimal	Reserve Changes → New Amount	Amount after the change.
`Reason`	string	Reserve Changes → Reason Changed	Free-text reason. Set via `ReserveChangeReason` on `AddReserve`.
`Code`	string	—	Transaction code for import only.
`UserID`	int	—	System ID of the user who made the change.
`UserName`	string	—	Name of the user who made the change.

Recovery (nested)

A Recovery records an incoming recovery against the reserve. Most fields are documented under Payment — the schema mirrors the payment schema with the same Payee* and check-related fields, except the amount is treated as a recovery rather than an outflow.

Property	Datatype	Note
`ID`	int	System-generated ID.
`Date`	dateTime	Date of the recovery.
`Amount`	decimal	Recovery amount. Not reflected in the Incurred amount or Reserve Balance.
`ReasonCode`	string	Transaction code for import only.
`PayeeName`	string	Name of the recovering party.
`PayeeID`	int	System ID of the user/contact being paid.
`InvoiceNumber`	string	Invoice number associated with the recovery.
`TaxID`	string	Tax ID associated with the recovery.
`Memo`	string	Recovery memo (not the memo on the check).

Business Rules

Reserves are updateable via AddReserve. Calling AddReserve for an existing reserve type on the same claim updates that reserve.
Reserves cannot be decremented below their booked payments. Attempting to set a reserve to a value lower than the sum of payments already made against it returns error (4) Cannot change reserve to amount lower than payments already against the reserve.
Payments cannot exceed the available reserve balance. AddReservePayment returns error (4) Payment amount exceeds balance of reserve. when the payment would push the balance negative.
Recoveries do not reduce the incurred amount. They are tracked separately for accounting and reinsurance purposes.
Reserve types must exist in the adjustment company's settings. AddReserve returns error (2) Reserve Type not found - invalid reserveID and/or reserveName if the supplied type does not exist in FileTrac Settings → Reserve Types.
A claim-level reserve is created when no ContactID is supplied. Otherwise the reserve is attached to the named contact.

Related Methods

AddReserve — create or update a reserve.
AddReservePayment — record a payment against a reserve.
AddReserveRecovery — record a recovery against a reserve.
GetClaimDetail — returns reserves inline on a claim.
GetRecoveryTypes — enumerate recovery types for AddReserveRecovery.
Payment — the type returned in the Payments nested list.