Skip to main content

Payment

A Payment records an outgoing financial transaction against a claim. FileTrac supports three payment kinds.

A Payment records an outgoing financial transaction against a claim. FileTrac supports three payment kinds, each created by a distinct method:

Payment kind

Created by

Tracked against

Deductible payment

The claim's deductible balance.

Invoice payment

An invoice's unpaid balance.

Reserve payment

A specific reserve on the claim.

All three share the same core payment schema and the same void-by-inverse pattern. Reserve payments additionally carry a nested Check object (which itself nests a Payee object) when the payment has been issued through FileTrac's check-management module.

Core Payment Properties

These properties appear on the Payment element returned within the Reserve object on GetClaimDetail. Deductible and invoice payments are not exposed as separate read-side objects — they're recorded in the financials but are not surfaced via GetClaimDetail as standalone entities.

Property

Datatype

FileTrac UI Location

Description

ID

int

System-generated ID unique to this payment.

Date

dateTime

Reserve Payment → Payment Date

Payment date.

Amount

decimal

Reserve Payment → Amount

Payment amount. Negative values indicate a void.

ReasonCode

string

Transaction code for import only.

PayeeName

string

Reserve Payment → Payable to

Display name of the payee.

PayeeID

int

System ID of the user/contact being paid.

InvoiceNumber

string

Reserve Payment → Invoice #

Invoice number associated with this payment.

TaxID

string

Reserve Payment → Tax ID

Tax ID of the payee.

Memo

string

Reserve Payment → Memo

Memo on the payment record. Not the memo printed on the check.

Check (nested in Payment)

The Check object holds the printed-check details when a payment is dispensed through FileTrac's check-management module. The Freshdesk source documents these fields without UI labels, marking each as "More info coming." The schema below reflects the WSDL envelope.

Property

Datatype

Description

CheckID

int

System-generated ID unique to the check.

CheckDate

dateTime

Date the check was issued.

AccoutID

int

System ID of the check account. Note the spelling — the source documents this field as AccoutID (typo for AccountID).

CheckNumber

string

Check number printed on the check.

Amount

decimal

Check amount.

Memo

string

Memo printed on the check.

ModifiedDate

dateTime

Date of the most recent modification to the check record.

CheckAddressee

string

Addressee printed on the check.

CheckAddr1

string

Address line 1.

CheckAddr2

string

Address line 2.

CheckCity

string

City.

CheckState

string

State.

CheckZip

string

ZIP.

Payee (nested in Check)

The Payee object identifies the person or entity the check was issued to. The Freshdesk source marks these fields as "More info coming"; the schema reflects the WSDL envelope.

Property

Datatype

Description

PayeeContactId

int

System ID of the payee contact within the claim.

PayeeContactType

string

Contact type of the payee.

PayeeFirstName

string

First name.

PayeeLastName

string

Last name.

PayeeEmail

string

Email.

PayeePhone

string

Phone number.

Voiding a Payment

Payments are not updateable. To void any payment, call the original Add method with the same data and a negative amount:

  • Deductible payment → AddDeductiblePayment with negative PaymentAmount.

  • Reserve payment → AddReservePayment with negative PaymentAmount.

  • Invoice payment → there is no documented invoice-payment void pattern; invoice payments are absorbed into the invoice balance and remain on record.

Recoveries follow the same rule: void a recovery by calling AddReserveRecovery with a negative RecoveryAmount.

Payee Resolution When Recording Payments

The Add-payment methods accept the payee either by ID (PayeeID) or by name and contact type (PayeeFirstName, PayeeLastName, plus either PayeeContactTypeID or PayeeContactType). When ID is supplied, name and type fields are ignored. When name and type are supplied without an ID:

  1. FileTrac searches for an existing contact on the claim matching the name and type.

  2. If no match is found, FileTrac creates a new contact on the claim and uses it as the payee.

  3. If the contact type cannot be resolved against GetContactTypes, the call returns error (3) Invalid contact information supplied: ....

Behavior Notes

  • Payments cannot exceed the source balance. Each kind enforces its own ceiling — deductible balance, invoice unpaid balance, or reserve balance. The corresponding (4) error is documented in Error Codes & Response Codes.

  • Invoice payments split on overflow. A single AddInvoicePayment whose amount exceeds the unpaid balance is split into a normal payment (matching the unpaid balance) plus an "excess payment" record. Only one excess payment per invoice is permitted.

  • Memo and check memo are different fields. PaymentMemo on the Add methods is the internal memo, not the memo printed on the check.

Related Methods

Did this answer your question?