Skip to content

Payment

Payment represents a single claim payment transaction, including the payee, category, amounts, and dates, and is the element type of PaymentsData.Payments (see ../SAIF.Data.Guidewire.Models.ClaimDataApi/PaymentsData.md), nested under ClaimFinancialData returned by ClaimDataApiClient.GetGWClaimFinancials (see ../SAIF.Data.Guidewire.Clients/ClaimDataApiClient.md). It defines constants for known payment Category, TransactionType, and CheckStatus values, and can itemize its amount into a list of LineItem entries.

Purpose

  • Carries the full detail of one payment transaction: amount, payee, category, check/transaction metadata, and optional itemized line items.
  • Exposes named constants for well-known payment categories, the single known transaction type, and check statuses so calling code can compare values without hardcoding strings.

Context

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

Public members

Member Signature Purpose
CategoryVocTD public const string CategoryVocTD = "voc td" Well-known Category value for vocational temporary disability payments.
CategoryTemporaryDisability public const string CategoryTemporaryDisability = "temporary disability" Well-known Category value for temporary disability payments.
CategorySupTD public const string CategorySupTD = "supplemental td" Well-known Category value for supplemental temporary disability payments.
CategoryBurial public const string CategoryBurial = "burial" Well-known Category value for burial payments.
CategoryPermanentPartialDisability public const string CategoryPermanentPartialDisability = "permanent partial disability" Well-known Category value for permanent partial disability payments.
CategoryPermanentTotalDisability public const string CategoryPermanentTotalDisability = "permanent total disability" Well-known Category value for permanent total disability payments.
CategoryDeath public const string CategoryDeath = "death benefits" Well-known Category value for death benefit payments.
CategoryMedical public const string CategoryMedical = "medical" Well-known Category value for medical payments.
CategoryVocSvcs public const string CategoryVocSvcs = "voc services" Well-known Category value for vocational services payments.
CategoryLegal public const string CategoryLegal = "legal" Well-known Category value for legal payments.
TransactionTypePayment public const string TransactionTypePayment = "payment" Well-known TransactionType value identifying a standard payment transaction.
checkStatusCleared public const string checkStatusCleared = "cleared" Well-known CheckStatus value indicating the check has cleared.
checkStatusIssued public const string checkStatusIssued = "issued" Well-known CheckStatus value indicating the check has been issued.
AmountPaid public decimal AmountPaid { get; set; } Total monetary amount paid in this transaction.
Category public string Category { get; set; } Coded category of the payment; compare against the Category* constants for known values.
CheckNumber public string CheckNumber { get; set; } Number of the check issued for this payment.
CheckStatus public string CheckStatus { get; set; } Status of the check; compare against checkStatusCleared/checkStatusIssued for known values.
CheckType public string CheckType { get; set; } Type of check issued for this payment.
CostType public string CostType { get; set; } Coded cost type associated with the payment.
FromDate public DateTime FromDate { get; set; } Start date of the period covered by the payment.
InvoiceNumber public string InvoiceNumber { get; set; } Invoice number associated with the payment, when applicable.
OffsetWage public decimal OffsetWage { get; set; } Wage amount offset against this payment.
PayeeName public string PayeeName { get; set; } Name of the payment recipient.
PayeeRole public string PayeeRole { get; set; } Role of the payment recipient (e.g. worker, provider).
PublicId public string PublicId { get; set; } Guidewire public identifier for the payment transaction.
ThroughDate public DateTime ThroughDate { get; set; } End date of the period covered by the payment.
TotalLossDays public int TotalLossDays { get; set; } Total loss days covered by this payment.
TransactionDate public DateTime TransactionDate { get; set; } Date the payment transaction occurred.
TransactionType public string TransactionType { get; set; } Type of transaction; compare against TransactionTypePayment for the known value.
LineItems public List<LineItem> LineItems { get; set; } Itemized breakdown of the payment amount by category (see ../SAIF.Data.Guidewire.Models.ClaimDataApi/LineItem.md).

Behavioral notes

  • A source code comment notes that handling for CDA Settlement (A), DCS Settlement (B), Fed Settlement (C), and EAIP (E) payment categories from GWCC is still to be determined, so Category may contain values not covered by the defined constants.**
  • The checkStatusCleared/checkStatusIssued constants use camelCase, unlike the Category* and TransactionTypePayment constants, which use PascalCase.

Note: Statements marked with * were inferred from code structure, naming conventions, or contextual evidence where direct confirmation was not available in source artifacts. Statements marked with ** could not be confirmed; treat as unknown until verified.

Sources

  • Data/SAIF.Data.Guidewire/Models/ClaimDataApi/Payment.cs