Skip to main content

GET /HCP

Retrieves Home Care Package statements. Parameters: Response fields: 150+ fields covering:
  • Identifiers: HCPId, ClientId, PeriodStart, PeriodEnd, PackageLevel, SplitCheck, SplitLevel, SplitDate, Ended
  • Opening balances: OpeningBalance, OpeningCommonwealth, OpeningCareRecipient, OpeningContingency, OpeningUnspentAmount, UnspentAmountBalance
  • Home care account: OptIn, OptInAmount, OpeningHomeCareAccount, HomeCareAccountBalance
  • Subsidy: Subsidy, GovOver, GovOverCheck
  • Basic daily fee: BasicDailyFee, BasicOverCheck, BasicOver, BasicOption, BasicPaidCheck, BasicInclCheck
  • Income tested fee: IncomeTestedFee, ITFPaidCheck, ITFWaivedCheck, ITFInclCheck, ITFNote, ITFAdjust, ITFChangeCheck, ITFChangeDate, ITFChangeAmount, ITFProviderCheck, ITFProviderPerc, ITFProvider
  • Other subsidies: OtherSubsidies, OtherSubsidiesLabel, SupplmentsTotal, AdvancePayment
  • Unspent funds: UnspentFund, UnspentFundCW, UnspentFundCWAccount
  • Government adjustments: GovAdjustment, GovAdjustmentAccount, GovAdjustment2, GovAdjustmentAccount2
  • Management fees: PackageMgnt, PackageMgntOverCheck, PackageMgntOver, PackageMgntOption, PackageMgntOverOption, CaseMgntOverCheck, CaseMgnt, CaseMgntOver, CaseMgntOption, CaseMgntOverOption
  • Contingency: ContingencyFund
  • Services: Services, ServicesExternal, ServicesLocation
  • Expenses: Expenses, ExpensesCosts, ExpensesMarkUp, ExpensesClient, Purchases, DumpingFees, NonPackageItems
  • Client top-ups: ClientTop, ClientTopPaid, ClientTopInclCheck, ClientTopNote
  • Custom expense lines: ExpS4 through ExpS16 (13 fields), ExpNotePurchase, ExpNoteS4 through ExpNoteS16 (14 fields)
  • Supplements: ExitFee, Dementia, Veterans, Oxygen, Bolus, NonBolus, Viability, ViabilityOption
  • Leave: LeaveHospital, LeaveTransition, LeaveResidential, LeaveSocial
  • Totals: TotalGov, TotalGovMonth, IncomeTestedFeeMonth, TotalBasicMonth, TotalIncome, TotalIncomeMonth, PackageMgntMonth, CaseMgntMonth, ContingencyMonth, TotalCharge, TotalService, TotalFundsOut, TotalOthers
  • Balance: ClientPayable, PackageBalance, CommonwealthPortion, CareRecipientPortion, InvoiceAmount, BalanceTransfer, BalanceTransferFrom, BalanceTransferTo, ContingencyBalance, ContingencyToBalanceCheck
  • Rostered: InclKM, HandlingPerc, HandlingCap, RosteredServices, RosteredServicesExt, RosteredServicesLoc, RosteredTotal
  • Estimates: EstBalance, EstBalanceNextMonth
  • Metadata: Note, Final, Calculated, Version, Status, _CreateTime, _CreateUser