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 |
| int | — | System-generated ID unique to this payment. |
| dateTime | Reserve Payment → Payment Date | Payment date. |
| decimal | Reserve Payment → Amount | Payment amount. Negative values indicate a void. |
| string | — | Transaction code for import only. |
| string | Reserve Payment → Payable to | Display name of the payee. |
| int | — | System ID of the user/contact being paid. |
| string | Reserve Payment → Invoice # | Invoice number associated with this payment. |
| string | Reserve Payment → Tax ID | Tax ID of the payee. |
| 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 |
| int | System-generated ID unique to the check. |
| dateTime | Date the check was issued. |
| int | System ID of the check account. Note the spelling — the source documents this field as |
| string | Check number printed on the check. |
| decimal | Check amount. |
| string | Memo printed on the check. |
| dateTime | Date of the most recent modification to the check record. |
| string | Addressee printed on the check. |
| string | Address line 1. |
| string | Address line 2. |
| string | City. |
| string | State. |
| 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 |
| int | System ID of the payee contact within the claim. |
| string | Contact type of the payee. |
| string | First name. |
| string | Last name. |
| string | Email. |
| 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 →
AddDeductiblePaymentwith negativePaymentAmount.Reserve payment →
AddReservePaymentwith negativePaymentAmount.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:
FileTrac searches for an existing contact on the claim matching the name and type.
If no match is found, FileTrac creates a new contact on the claim and uses it as the payee.
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
AddInvoicePaymentwhose 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.Memoand check memo are different fields.PaymentMemoon the Add methods is the internal memo, not the memo printed on the check.
Related Methods
