Skip to main content

AddReserveRecovery

Records a recovery against a reserve — typically subrogation, salvage, or reinsurance.

Purpose

Records a recovery against a specific reserve on a claim — typically a subrogation, salvage, or reinsurance recovery. Returns the reserve-recovery ID and a response message. Void a previously recorded recovery by sending the same data with a negative RecoveryAmount. Recoveries are not reflected in the reserve's incurred amount or balance.

Endpoint

  • Method: AddReserveRecovery

  • SOAPAction (1.1): "https://ftservices.onlinereportinginc.com/v2/AddReserveRecovery"

  • Parameter wrapper: <oRecovery>

Authentication

Standard credentials apply, supplied inside the <oRecovery> wrapper. See Authentication & Authorization.

Parameters

Name

Type

Required

Description

Login

string

yes

Authorized FileTrac system login.

Password

string

yes

Password for the login.

CompanyKey

string

yes

The unique company code provided by FileTrac.

FileTracClaimID

int

yes

System ID of the claim.

ReserveID

int

conditional

System ID of the reserve. Either ReserveID or ReserveName is required.

ReserveName

string

conditional

Reserve type name — may be used as a substitute for ReserveID when the reserve type is unique on the claim. The WSDL envelope shows ReserveName typed as int — that is a WSDL annotation defect; the parameter is a string.

PayeeID

int

conditional

System ID of the contact within the claim. Required when not creating a new contact inline.

PayeeFirstName

string

conditional

First name — supplied when creating a new payee contact inline.

PayeeLastName

string

conditional

Last name — supplied when creating a new payee contact inline.

PayeeContactTypeID

int

conditional

Contact type ID — supplied when creating a new payee contact inline. From GetContactTypes.

PayeeContactType

string

conditional

Contact type name — alternative to PayeeContactTypeID.

RecoveryTypeID

int

conditional

System ID of the recovery type. Either RecoveryTypeID or RecoveryType is required. Not visible in the WSDL envelope but is required per the Freshdesk narrative and is referenced in error message (4). Obtain via GetRecoveryTypes.

RecoveryType

string

conditional

Recovery type name — alternative to RecoveryTypeID.

RecoveryDate

dateTime

no

Recovery date. Server default applies if omitted.

RecoveryCheckNumber

string

no

Check number.

RecoveryInvoiceNumber

string

no

Invoice number associated with the recovery.

RecoveryTaxID

string

no

Payee tax ID.

RecoveryAmount

decimal

yes

Recovery amount. Cents optional. Negative values void a prior recovery.

RecoveryMemo

string

no

Internal memo.

Response

Returns a complex AddReserveRecoveryResult:

Field

Datatype

Description

ReserveRecoveryID

int

The new recovery's ID on success. 0 on failure.

ResponseMessage

string

Success or a failure-identifying string.

Errors

Error Message

Cause

Remediation

ERROR inserting Reserve Recovery.

Generic insert failure.

Retry; validate payload.

(1) Claim not found - invalid claimID or File Number

The claim cannot be located.

Confirm FileTracClaimID.

(2) Invalid contactID supplied: contactID

The PayeeID does not exist within the claim.

Confirm via GetClaimDetail.

(3) Invalid contact information supplied: 'contactFirstName contactLastName' for Type: contactType

New-contact creation failed.

Confirm contact-type name or ID via GetContactTypes.

(4) Invalid recovery type information supplied. ID: 'recoveryTypeID' or Type: 'recoveryType'

RecoveryTypeID or RecoveryType does not exist.

Call GetRecoveryTypes and use a value from that list.

Remarks

  • Recoveries do not reduce the incurred reserve amount. They are tracked separately in the Recovery sublist on the reserve, for accounting and reinsurance reporting.

  • Recoveries are immutable. Void via inverse amount.

  • A payee is mandatory — either PayeeID or new-contact fields.

  • A recovery type is mandatory. Even though the WSDL envelope does not expose RecoveryTypeID or RecoveryType as named parameters, the documented error (4) confirms one must be supplied and validated.

Example Request (SOAP 1.1)

POST /v2/service.asmx HTTP/1.1
Host: ftservices.onlinereportinginc.com
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://ftservices.onlinereportinginc.com/v2/AddReserveRecovery"<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddReserveRecovery xmlns="https://ftservices.onlinereportinginc.com/v2/">
      <oRecovery>
        <Login>integration.svc</Login>
        <Password>•••••••••</Password>
        <CompanyKey>ACME-AC-001</CompanyKey>
        <FileTracClaimID>881204</FileTracClaimID>
        <ReserveID>20431</ReserveID>
        <PayeeID>442108</PayeeID>
        <RecoveryType>Salvage</RecoveryType>
        <RecoveryDate>2026-05-27T00:00:00</RecoveryDate>
        <RecoveryAmount>3200.00</RecoveryAmount>
        <RecoveryMemo>Roof material salvage proceeds</RecoveryMemo>
      </oRecovery>
    </AddReserveRecovery>
  </soap:Body>
</soap:Envelope>

Example Response (SOAP 1.1)

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddReserveRecoveryResponse xmlns="https://ftservices.onlinereportinginc.com/v2/">
      <AddReserveRecoveryResult>
        <ReserveRecoveryID>61210</ReserveRecoveryID>
        <ResponseMessage>Success</ResponseMessage>
      </AddReserveRecoveryResult>
    </AddReserveRecoveryResponse>
  </soap:Body>
</soap:Envelope>

Related Methods

  • GetRecoveryTypes — call first to confirm valid recovery types.

  • AddReserve — the reserve must already exist; this method does not create reserves.

  • AddReservePayment — sibling method for outgoing payments.

  • Reserve — the parent type carrying the Recovery sublist.

Did this answer your question?