CheckFinancialData¶
CheckFinancialData is the request payload for FinancialDataApiClient.CreateCheckAsync, describing a check financial transaction — claim identification, approver, delivery and issue details, service date range, print/EOB flag, and the list of Payment line items to post. All properties carry explicit JsonProperty attributes mapping to Guidewire's camelCase JSON field names.
Purpose¶
- Carries all fields required to create a check financial transaction against a Guidewire claim, including its constituent payment line items
Context¶
- Namespace:
SAIF.Data.Guidewire.Models.FinancialDataApi - Assembly/package:
SAIF.Data.Guidewire(packaged inSAIF.SAIFCode.Core)
Public members¶
| Member | Signature | Purpose |
|---|---|---|
| ClaimId | public string ClaimId { get; set; } |
Claim id, serialized as claimID |
| ApproverUser | public string ApproverUser { get; set; } |
User who approved the check, serialized as approverUser |
| CheckDelivery | public string CheckDelivery { get; set; } |
Delivery method code for the check, serialized as checkDelivery |
| CheckIssueDate | public string CheckIssueDate { get; set; } |
Date the check is issued, serialized as checkIssueDate |
| DateOfService | public DateTimeOffset DateOfService { get; set; } |
Date of service for the check, serialized as dateOfService |
| Payments | public List<Payment> Payments { get; set; } |
Payment line items on the check, serialized as payments |
| Comments | public string Comments { get; set; } |
Free-text comments, serialized as comments |
| Eroding | public bool Eroding { get; set; } |
Whether the check erodes a coverage limit or reserve*, serialized as eroding |
| ClaimNumber | public string ClaimNumber { get; set; } |
Claim number, serialized as claimNumber |
| InvoiceNumber | public string InvoiceNumber { get; set; } |
Invoice number, serialized as invoiceNumber |
| ProviderLocationSeqNum | public long ProviderLocationSeqNum { get; set; } |
Provider location sequence number, serialized as providerLocationSeqNum |
| InvoiceType | public string InvoiceType { get; set; } |
Type of invoice, serialized as invoiceType |
| PayeeRole | public string PayeeRole { get; set; } |
Role of the payee, serialized as payeeRole |
| PaymentMethod | public string PaymentMethod { get; set; } |
Method used to make the payment, serialized as paymentMethod |
| PrintEOB | public bool PrintEOB { get; set; } = true |
Whether an Explanation of Benefits is printed, serialized as printEOB, defaults to true |
| SendDate | public String SendDate { get; set; } |
Date the check is sent, serialized as sendDate |
| ServiceEndDate | public DateTimeOffset ServiceEndDate { get; set; } |
End of the service period, serialized as serviceEndDate |
| serviceStartDate | public DateTimeOffset serviceStartDate { get; set; } |
Start of the service period, serialized as serviceStartDate; note the property itself is lowercase-cased in source |
| PayeeToAddressOverride | public Address PayeeToAddressOverride { get; set; } |
Optional Address override for the check payee, serialized as payeeToAddressOverride and omitted when null |
Behavioral notes¶
- A non-success HTTP response when posting this payload via
CreateCheckAsyncthrows with the status code and response content*. PayeeToAddressOverrideis only included in the serialized request when set (NullValueHandling.Ignore).
Sources¶
- Data/SAIF.Data.Guidewire/Models/FinancialDataApi/CheckFinancialData.cs