Skip to main content

AccountPayerSchema

_accountnullable
account_dependentsundefined[]
account_membersundefined[]
account_renewal_group_idintegernullable
auto_add_new_membersboolean

If True, when new members are added to the employer they will be automatically added to this account.

categorystringnullable

Real world classification. DCA, FSA, HRA, TRN, PKG, and HSA.

claims_filternullable
claims_filter_idintegernullable
createdbynullable
createdby_idintegernullable
createddatedate-timenullable
custom_descriptionstringnullable
dependentsundefined[]
employer_idintegerrequired
grace_periodstringnullable
group_numberstringnullable
idinteger
modifiedbynullable
modifiedby_idintegernullable
modifieddatedate-timenullable
namestringnullable
name_with_drstring
name_with_plan_id_and_drstring
payer_idintegerrequired
runout_periodstringnullable
statestring
status
tenantnullable
term_runout_periodstringnullable
term_runout_uses_plan_datesboolean

If True, term runout calculations should use only the account's effective daterange, ignoring account_member and member date ranges

type
uuiduuid
AccountPayerSchema
{
"account_dependents": [
null
],
"account_members": [
null
],
"account_renewal_group_id": 0,
"auto_add_new_members": true,
"category": "string",
"claims_filter_id": 0,
"createdby_id": 0,
"createddate": "2024-07-29T15:51:28.071Z",
"custom_description": "string",
"dependents": [
null
],
"employer_id": 0,
"grace_period": "string",
"group_number": "string",
"id": 0,
"modifiedby_id": 0,
"modifieddate": "2024-07-29T15:51:28.071Z",
"name": "string",
"name_with_dr": "string",
"name_with_plan_id_and_dr": "string",
"payer_id": 0,
"runout_period": "string",
"state": "string",
"status": {},
"term_runout_period": "string",
"term_runout_uses_plan_dates": true,
"type": {},
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}