---
title: IFinancialDataApiClient
summary: API reference for IFinancialDataApiClient.
status: draft
owner: SAIF.Core documentation team
last_reviewed: 2026-09-24
library: SAIF.Data.Guidewire
reference_type: package
---

# IFinancialDataApiClient

Contract implemented by `FinancialDataApiClient` for creating checks and recoveries and for querying payment and check-bill data from Guidewire ClaimCenter. Consumers depend on this interface so they can be constructed via dependency injection and unit-tested without a real `HttpClient`.

## Purpose
- Declares operations to create check and recovery financial transactions on a claim, and to query payments (by invoice number or issue date) and check-bill details.

## Context
- Namespace: `SAIF.Data.Guidewire.Interfaces`
- Assembly/package: `SAIF.Data.Guidewire` (packaged in `SAIF.SAIFCode.Core`)

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| CreateCheckAsync(long, CheckFinancialData) | `Task<string> CreateCheckAsync(long claimId, CheckFinancialData data)` | Creates a check financial transaction on the claim; the implementation throws on failure per [SDG-BR-011](../../business-rules.md#sdg-br-011-non-success-responses-throw-with-status-and-content) and otherwise returns the raw response body |
| CreateRecoveryAsync(long, RecoveryFinancialData) | `Task<string> CreateRecoveryAsync(long claimId, RecoveryFinancialData data)` | Creates a recovery financial transaction on the claim; the implementation throws on failure per [SDG-BR-011](../../business-rules.md#sdg-br-011-non-success-responses-throw-with-status-and-content) and otherwise returns the raw response body |
| GetPaymentsByInvoiceNumber(string, bool) | `Task<PaymentsResponse> GetPaymentsByInvoiceNumber(string invoiceNumber, bool includeZeroPays = false)` | Gets payments by invoice number, also known as bill ID; zero-pay payments are included only when `includeZeroPays` is true |
| GetPaymentsByIssueDate(DateTime, bool) | `Task<PaymentsResponse> GetPaymentsByIssueDate(DateTime issueDate, bool includeZeroPays = false)` | Gets payments by issue date, also known as transaction date, per [SDG-BR-013](../../business-rules.md#sdg-br-013-zero-pay-payments-included-only-when-requested); zero-pay payments are included only when `includeZeroPays` is true |
| GetBillDetailsForCheckNumber(long) | `Task<CheckBillData> GetBillDetailsForCheckNumber(long checkNumber)` | Retrieves bill-related information for a check number, such as claim numbers and invoice numbers |

## Behavioral notes
- This interface carries no behavior of its own; all behavior described above belongs to the implementing class, `FinancialDataApiClient`.

## Constraints and usage notes
- The two create methods (`CreateCheckAsync`, `CreateRecoveryAsync`) are implemented differently with respect to synchronous/asynchronous execution in `FinancialDataApiClient`*; callers relying on async-all-the-way behavior should verify against the concrete implementation.

> **Note:** Statements marked with * were inferred from code structure, naming conventions, or
> contextual evidence where direct confirmation was not available in source artifacts.

## Sources
- `Data/SAIF.Data.Guidewire/Interfaces/IFinancialDataApiClient.cs`
- `Data/SAIF.Data.Guidewire/Clients/FinancialDataApiClient.cs`