Skip to content

Ledger

This section introduces the structure of the ‘ledger’ table and its relationships within the database. It specifically focuses on the connections between family members, such as the relationship between parents and children. This documentation aims to provide an overview of how family entities are interconnected.

FieldTypeIndexDescription
Idint identityPKPrimary key, unique identifier
PayDatedatetimePayment date
UserIdintUser ID
LedgerCountintLedger count
ProviderCountintProvider count
ClaimCountintClaim count
TotalAmountdecimal(18, 4)Total amount
CareAmountdecimal(18, 4)Care amount
GarnishmentAmountdecimal(18, 4)Garnishment amount
AdjustmentAmountdecimal(18, 4)Adjustment amount
Memonvarchar(max)Memo
ProgrameintProgram (0: CDE, 1: Stage 1)
StatusintStatus
DisablebitDisabled status (0 No, 1 Yes)
CreateUserIdintID of the user who created
UpateUserIdintID of the user who updated
VersionintVersion
FundingSourcenvarchar(1024)Funding source
CreateTimedatetimeoffsetRecord creation time
UpdateTimedatetimeoffsetRecord update time
ExportDatedatetimeoffsetExport date
ExportParamnvarchar(max)Export parameters
Entitiesnvarchar(max)Entities
FamilyFeeAmountdecimal(38, 6)Family fee amount
RegisterFeeAmountdecimal(38, 6)Register fee amount
ProviderAmountZeroCountintProvider amount zero count
Metanvarchar(max)Metadata
Stepsnvarchar(max)Steps
SummaryAmountnvarchar(max)Summary amount
ExportVersionnvarchar(2048)Export version
FieldTypeIndexDescription
LegerIdint identityPKPrimary key, unique identifier
ProviderIDintIXForeign key to provider
LedgerCodenvarchar(100)IXLedger code
CustomerNamenvarchar(200)Customer name
CustomerCodenvarchar(100)Customer code
CreateDatedatetimeCreate date
PayMethodnvarchar(32)Payment method
Amountdecimal(18, 2)Amount
Memonvarchar(max)Memo
PayDatedatetimeIXPayment date
StatusintStatus
DisablebitDisabled status (0 No, 1 Yes)
CreateUserIdintID of the user who created
UpateUserIdintID of the user who updated
VersionintVersion
CustomerTypeintCustomer type
ContractIDintContract ID
ExportIdintIXExport ID
EdocIdintEdoc ID
CreateTimedatetimeoffsetRecord creation time
UpdateTimedatetimeoffsetRecord update time
FamilyFeeAmountdecimal(38, 6)Family fee amount
RegisterFeeAmountdecimal(38, 6)Register fee amount
AdjustmentAmountdecimal(38, 6)Adjustment amount
ClaimZeroCountintClaim zero count
Metanvarchar(max)Metadata
PaymentAmountdecimal(38, 6)Payment amount
ExportDatedatetimeoffsetIXExport date
SummaryAmountnvarchar(max)Summary amount
ProviderNamenvarchar(2048)Provider name
ContractCodenvarchar(2048)Contract code
FieldTypeIndexDescription
SubLedgerIdint identityPKPrimary key, unique identifier
LegerIDintIXForeign key to ledger
ExportIdintIXForeign key to export
TypeintIXType (0: Claim, 1: Adjustment, 2: Garnishment)
ClaimIdintIXForeign key to claim
ChildIDintForeign key to child
ProviderIDintForeign key to provider
CaseIDintIXForeign key to case
ClaimCodenvarchar(100)Claim code
ClaimStartDatedatetimeClaim start date
ClaimEndDatedatetimeClaim end date
Titlenvarchar(200)Title
Pricedecimal(18, 4)Price
Quantitydecimal(18, 4)Quantity
Amountdecimal(18, 4)Amount
Memonvarchar(200)Memo
StatusintStatus
DisablebitDisabled status (0 No, 1 Yes)
CreateUserIdintID of the user who created
UpateUserIdintID of the user who updated
VersionintVersion
ContractIDintContract ID
IsPay2ParentbitIs pay to parent (Y/N)
FamilyFeedecimal(18, 4)Family fee
PVTotalAmountdecimal(18, 4)IXPV total amount
FamilyidintForeign key to family
CreateTimedatetimeoffsetRecord creation time
UpdateTimedatetimeoffsetRecord update time
ContractCodenvarchar(100)Contract code
FamilyNamenvarchar(2048)Family name
ChildNamenvarchar(2048)Child name
ContractNamenvarchar(2048)Contract name
ProviderNamenvarchar(2048)Provider name
TypeNamenvarchar(2048)Type name
Metanvarchar(max)Metadata
Sourcenvarchar(2048)Source
ExportDatedatetimeoffsetIXExport date
ItemCodenvarchar(2048)Item code
RegistrationFeedecimal(38, 6)Registration fee
ClaimExternalIdnvarchar(2048)Claim external ID
FamilyExternalIdnvarchar(2048)Family external ID
ChildExternalIdnvarchar(2048)Child external ID
ProviderExternalIdnvarchar(2048)Provider external ID
ExportExternalIdnvarchar(2048)Export external ID
ClaimContractIDintClaim contract ID
ClaimContractCodenvarchar(100)Claim contract code
ClaimContractNamenvarchar(2048)Claim contract name
OtherAmountdecimal(38, 6)Other amount
PayDatedatetimeIXPayment date
FieldTypeIndexDescription
Idint identityPKPrimary key, unique identifier
ExportIdintForeign key to export
Sourcenvarchar(2048)Source
ClaimIdnvarchar(2048)Claim ID
StartDatedatetimeStart date
EndDatedatetimeEnd date
ActualAgeGroupintActual age group
ActualRateTypenvarchar(2048)Actual rate type
ActualRatedecimal(38, 6)Actual rate
ActualQtydecimal(38, 6)Actual quantity
ActualAmountdecimal(38, 6)Actual amount
EwFactordecimal(38, 6)EW factor
Discountdecimal(38, 6)Discount
AgeGroupDisplaynvarchar(2048)Age group display
DisablebitDisabled status (0 No, 1 Yes)
CreateUserIdbigintID of the user who created
CreateTimedatetimeoffsetRecord creation time
UpdateUserIdbigintID of the user who updated
UpdateTimedatetimeoffsetRecord update time
VersionbigintVersion
FieldTypeIndexDescription
ProviderIDintPKPrimary key, unique identifier
LastExportDatedatetimeoffsetLast export date
EffectiveDatedatetimeoffsetEffective date
ProviderNOnvarchar(30)Provider number
VenderNOnvarchar(500)Vendor number
ProviderNamenvarchar(1000)Provider name
ProviderCategorynvarchar(32)Provider category (DICT PC Individual;Corporation)
ProviderTypeintProvider type
FirstNamenvarchar(500)First name
LastNamenvarchar(500)Last name
MiddleInitialnvarchar(10)Middle initial
MailZipnvarchar(10)Mailing zip code
MailAddressnvarchar(300)Mailing address
MailUnitnvarchar(300)Mailing unit
MailCitynvarchar(30)Mailing city
MailCountynvarchar(30)Mailing county
MailStatenvarchar(30)Mailing state
MailCityIDintMailing city ID
MailCountyIDintMailing county ID
MailStateIDintMailing state ID
EMailAddressnvarchar(80)Email address
Phone1nvarchar(35)Primary phone
Phone2nvarchar(35)Secondary phone
Cellnvarchar(35)Cell phone
Faxnvarchar(20)Fax
SSNnvarchar(32)Social Security Number
TaxIDnvarchar(20)Tax ID
OtherIDTypenvarchar(32)Other ID type (DICT PE :0:Driver Lic)
OtherIDnvarchar(100)Other ID
TaxLegalFirstNamenvarchar(50)Tax legal first name
TaxLegalMInvarchar(50)Tax legal middle initial
TaxLegalNamenvarchar(300)Tax legal name
TrustLineStatusnvarchar(32)Trust line status
PaymentMethodnvarchar(32)Payment method (DICT PL: 0: Check, 1: Debit Card, 2: Direct Deposit)
ProviderManagerintProvider manager
HistoryintHistory (version)
DisablebitDisabled status (0 No, 1 Yes)
CreateUserIDintID of the user who created
UpateUserIDintID of the user who updated
VersionintVersion
IRSExportDatedatetimeIRS export date
LastProviderCategorynvarchar(32)Last provider category
AddressChangeDatedatetimeoffsetAddress change date
CreateTimedatetimeoffsetRecord creation time
UpdateTimedatetimeoffsetRecord update time
FieldTypeIndexDescription
ExternalInvoiceIdchar(36)PKPrimary key, unique identifier
TransIdchar(36)IXTransaction ID
SequenceNobigintSequence number
PaymentEntityIdintIXPayment entity ID
CollectionAccountIdchar(36)Collection account ID
PostDatevarchar(8)IXPost date
DueDatevarchar(8)Due date
PeriodStartvarchar(8)Period start
PeriodEndvarchar(8)Period end
ParentIdintParent ID
InvoiceCommentvarchar(1024)Invoice comment
Statusint default ‘0’Status
BatchNointIXBatch number
PaidOutOfBandbitPaid out of band
Amountdecimal(18, 2)Amount
OnlinePaybitOnline payment
ToEmailvarchar(300)To email
CollectionAccountCodevarchar(300)Collection account code
DisablebitDisabled status (0 No, 1 Yes)
CreateUserIdintID of the user who created
UpdateUserIdintID of the user who updated
CreateTimedatetimeoffsetIXRecord creation time
UpdateTimedatetimeoffsetIXRecord update time
Versionint default ‘1’Version
PortalInvoiceIdentityIdvarchar(500)IXPortal invoice identity ID
PaymentReceiptNovarchar(500)IXPayment receipt number
LastPullFromPortalTimedatetimeoffsetLast pull from portal time
LastSyncToPortalTimedatetimeoffsetLast sync to portal time
FieldTypeIndexDescription
Idint identityPKPrimary key, unique identifier
ProviderIdintForeign key to provider
ChildIdintIXForeign key to child
FamilyIdintForeign key to family
Amountdecimal(18, 4)Registration fee amount
Balancedecimal(18, 4)Balance amount
StartDatedatetimeStart date
EndDatedatetimeEnd date
DisablebitDisabled status (0 No, 1 Yes)
CreateUserIDintID of the user who created
UpateUserIDintID of the user who updated
VersionintVersion
RegistrationFeeTypenvarchar(2048)Registration fee type
CreateTimedatetimeoffsetRecord creation time
UpdateTimedatetimeoffsetRecord update time
FieldTypeIndexDescription
Idint identityPKPrimary key, unique identifier
RegistrationFeeIdintIXForeign key to registration fee
ClaimIdintForeign key to claim
ClaimCodeintClaim code
ClaimDatedatetimeClaim date
Amountdecimal(18, 4)Payment amount
Balancedecimal(18, 4)Balance amount
DisablebitDisabled status (0 No, 1 Yes)
CreateUserIDintID of the user who created
UpateUserIDintID of the user who updated
VersionintVersion
Commentnvarchar(2048)Comment
CreateTimedatetimeoffsetRecord creation time
UpdateTimedatetimeoffsetRecord update time
ExportIdintExport ID
ProviderIdintForeign key to provider
ChildIdintForeign key to child
FamilyIdintForeign key to family
FieldTypeIndexDescription
Idint identityPKPrimary key, unique identifier
ProviderIdintIXForeign key to provider
GarnishmentIdintIXForeign key to garnishment
ExportDatedatetimeExport date
ProcessingFeedecimal(18, 4)Processing fee
Amountdecimal(18, 4)Amount
Paymentdecimal(18, 4)Payment
Balancedecimal(18, 4)Balance
CreateUserIdintID of the user who created
UpateUserIdintID of the user who updated
VersionintVersion
CreateTimedatetimeoffsetRecord creation time
UpdateTimedatetimeoffsetRecord update time
ExportIdintExport ID
DisablebitDisabled status (0 No, 1 Yes)
LedgerIdintForeign key to ledger