Skip to content

PaymentsResponsePayment

PaymentsResponsePayment is a single payment record returned within PaymentsResponse's Payments list from FinancialDataApiClient's payments-by-invoice-number and payments-by-issue-date lookups, carrying check/payment identifiers, amounts, dates, payee and claim details, and its constituent PaymentsResponseLineItem entries.

Purpose

  • Represents one payment record — check and payment identifiers, amounts, dates, payee/claim details, and line items — returned by a payments lookup

Context

  • Namespace: SAIF.Data.Guidewire.Models.FinancialDataApi
  • Assembly/package: SAIF.Data.Guidewire (packaged in SAIF.SAIFCode.Core)

Public members

Member Signature Purpose
AmountPaid public decimal AmountPaid { get; set; } Amount paid on the payment
Category public string Category { get; set; } Guidewire payment category code
CheckCreatedDate public DateTime CheckCreatedDate { get; set; } Date the associated check was created
CheckNumber public string CheckNumber { get; set; } Guidewire check number
CheckStatus public string CheckStatus { get; set; } Status of the associated check
CheckType public string CheckType { get; set; } Type of the associated check
ClaimNumber public string ClaimNumber { get; set; } Claim number the payment belongs to
CostType public string CostType { get; set; } Guidewire cost type code
ExposureType public string ExposureType { get; set; } Type of exposure the payment applies to
InvoiceNumber public string InvoiceNumber { get; set; } Invoice number associated with the payment
OffsetWage public decimal OffsetWage { get; set; } Wage offset amount applied to the payment*
PayeeName public string PayeeName { get; set; } Name of the payee
PayeeRole public string PayeeRole { get; set; } Role of the payee
PaymentCreatedDate public DateTime PaymentCreatedDate { get; set; } Date the payment was created
PaymentType public string PaymentType { get; set; } Payment type code
PrintEOB public string PrintEOB { get; set; } Whether an Explanation of Benefits was printed for the payment*
ProviderLocationSeqNum public long ProviderLocationSeqNum { get; set; } Provider location sequence number
PublicID public string PublicID { get; set; } Guidewire public identifier for the payment
TotalLossDays public int TotalLossDays { get; set; } Total loss days associated with the payment*
TransactionType public string TransactionType { get; set; } Guidewire transaction type code
FromDate public DateTime FromDate { get; set; } Start of the period the payment covers
ThroughDate public DateTime ThroughDate { get; set; } End of the period the payment covers
TransactionDate public DateTime TransactionDate { get; set; } Date of the underlying transaction
LineItems public List<PaymentsResponseLineItem> LineItems { get; set; } The PaymentsResponseLineItem entries that make up this payment

Behavioral notes

  • Zero-pay payments (AmountPaid of zero) are included in payments-by-issue-date responses only when the caller explicitly requests them (SDG-BR-013).

Sources

  • Data/SAIF.Data.Guidewire/Models/FinancialDataApi/PaymentsResponse.cs