Skip to main content

AddReserve

Creates a new reserve on a claim, or updates an existing reserve of the same type.

Purpose

Creates a new reserve on a claim, or updates an existing reserve of the same type. Returns the reserve ID and a response message. Updates to an existing reserve are tracked in the Changes sublist on the reserve, with the ReserveChangeReason you supply.

Endpoint

  • Method: AddReserve

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

  • Parameter wrapper: <oReserve>

Authentication

Standard credentials apply, supplied inside the <oReserve> 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.

ReserveTypeID

int

conditional

System ID of the reserve type. Either ReserveTypeID or ReserveType is required.

ReserveType

string

conditional

Reserve type name (e.g., Indemnity, Legal Expenses). Must match an existing reserve type in the adjustment company's settings. The Freshdesk narrative names this ReserveTypeName; the WSDL envelope names it ReserveType. Use the WSDL form.

ContactID

int

no

System ID of the contact on the claim to attach the reserve to. When omitted, the reserve is created as claim-level.

ContactFirstName

string

no

Contact first name — used to look up an existing claim contact when ContactID is not supplied.

ContactLastName

string

no

Contact last name — used to look up an existing claim contact when ContactID is not supplied.

ReserveDate

dateTime

no

Reserve date. Server default applies if omitted.

ReserveAmount

decimal

yes

Reserve amount. Cents optional.

ReserveChangeReason

string

conditional

Reason for the change. Not required when inserting a new reserve; strongly recommended when updating an existing reserve — it appears in the reserve's Changes sublist.

Response

Returns a complex AddReserveResult:

Field

Datatype

Description

ReserveID

int

The reserve ID on success — new on insert, the existing ID on update. 0 on failure.

ResponseMessage

string

Success or a failure-identifying string.

Errors

Error Message

Cause

Remediation

ERROR inserting/updating Reserve

Generic failure during the insert or update path.

Retry; if persistent, validate the payload against the schema.

(1) Claim not found - invalid claimID and/or File#

FileTracClaimID does not identify a claim accessible to this login.

Confirm via GetClaimSummaries.

(2) Reserve Type not found - invalid reserveID and/or reserveName

ReserveTypeID or ReserveType is invalid for this adjustment company.

Confirm the reserve type exists in FileTrac Settings → Reserve Types.

(3) Invalid contactID or contactName supplied: xxxxxx

The contact does not exist within the claim.

Omit the contact fields (creates a claim-level reserve), or confirm the contact via GetClaimDetail. A contact cannot be added to the claim through this method.

(4) Cannot change reserve to amount lower than payments already against the reserve.

The new reserve amount would be less than the sum of payments already booked against the reserve.

Increase the proposed reserve amount, or void payments first via AddReservePayment with a negative amount.

Remarks

  • Insert versus update is implicit. Calling AddReserve for a reserve type that already exists on the claim updates that reserve rather than creating a duplicate. The change is logged in the Changes sublist with the supplied ReserveChangeReason.

  • Claim-level versus contact-level reserves. Omit ContactID, ContactFirstName, and ContactLastName to create a claim-level reserve. Supply a contact to attach the reserve to that contact.

  • Contacts cannot be added through this method. If the supplied ContactID / name combination doesn't match an existing claim contact, the call fails with error (3). Use AddClaimContact first to create the contact.

  • Reserves cannot be deleted. Zero them out by submitting a ReserveAmount of 0.00 (with a ReserveChangeReason); they remain on record with all change history preserved.

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/AddReserve"<?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>
    <AddReserve xmlns="https://ftservices.onlinereportinginc.com/v2/">
      <oReserve>
        <Login>integration.svc</Login>
        <Password>•••••••••</Password>
        <CompanyKey>ACME-AC-001</CompanyKey>
        <FileTracClaimID>881204</FileTracClaimID>
        <ReserveType>Indemnity</ReserveType>
        <ReserveDate>2026-05-22T00:00:00</ReserveDate>
        <ReserveAmount>45000.00</ReserveAmount>
        <ReserveChangeReason>Additional damage discovered during inspection</ReserveChangeReason>
      </oReserve>
    </AddReserve>
  </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>
    <AddReserveResponse xmlns="https://ftservices.onlinereportinginc.com/v2/">
      <AddReserveResult>
        <ReserveID>20431</ReserveID>
        <ResponseMessage>Success</ResponseMessage>
      </AddReserveResult>
    </AddReserveResponse>
  </soap:Body>
</soap:Envelope>

Related Methods

Did this answer your question?