Available Variable Names

Explanation

All of the fields below are available inside a Docassemble interview when launched from Legal Server. To reference them inside a Microsoft Word template, use {{ }} to surround the variable's name.

Variables that are always available

• today() (prints today's date)

Variable names imported and cleaned up from Legal Server

• ls_fields['case_email'] (email address for the case)
• client (prints full name of the client)
  • client.name.first
  • client.name.middle
  • client.name.last
  • client.name.suffix
  • client.birthdate
  • client.age_in_years()
  • client.email
  • client.mobile_number
  • client.phone_number
  • client.ssn
  • client.ssn_last_4
• client.address (will print full address in block format)
• client.address.on_one_line() (will print full address on one line)
  • client.address.address (Street address)
  • client.address.unit
  • client.address.city
  • client.address.state
  • client.address.zip
• advocate
• advocate.email
• adverse_parties (list, separated by a comma and with the word and before the last entry if multiple entries)
• adverse_parties[0] (first adverse party: keep adding to get the rest)
• income (list of incomes)
• income.total() provides total annual income. income.total(period_to_use=n) provides annual income / n. (e.g., n=12 is monthly income)
• household (list of household members) Each member has gender/birthdate attributes. E.g., household[0].birthdate
• household.spouse is the first person listed as spouse/wife/husband/partner (no support for polygamists)
• household.children is a list of any family members of kind child/son/daughter/step child/foster child
• household.guardians is a list of any family members of kind guardian/legal guardian/parent/mother/father/step parent/step mother/step father

Listviews

Listviews in Legal Server will be imported into Docassemble, but will only have a logical name if you choose the option to display a label.

Three special listviews:

• Adverse Parties becomes adverse_parties, with names and addresses parsed.
• Family Information becomes household, with names, gender, relationship, date of birth, etc. parsed
• Financial Information becomes income, with data transformed into an IncomeList object. E.g., you can use income.total(), currency(income[0].amount(period_to_use=12)) to get the first income as a monthly value, etc. See https://github.com/GBLS/docassemble-income

Variables from Legal Server that aren't cleaned up

All of the variables below are available, just not put into as nice a variable name. You can refer to them in a template like {{ ls_fields['id'] }}.

• ls_fields['additional_language_information']
• ls_fields['adverse_parties']
• ls_fields['all_phone_numbers']
• ls_fields['case_email']
• ls_fields['date_of_birth']
• ls_fields['full_address']
• ls_fields['id']
• ls_fields['initiating_user']
• ls_fields['initiating_user_email_address']
• ls_fields['intake_date']
• ls_fields['interpreter_needed']
• ls_fields['name']
• ls_fields['problem_statement']
• ls_fields['referred_by']
• ls_fields['sidebar_address']
• ls_fields['sidebar_advocate']
• ls_fields['sidebar_assignment_office']
• ls_fields['sidebar_assignment_program']
• ls_fields['sidebar_disposition_current_level_of_service_case_status_date_open']
• ls_fields['sidebar_domestic_violence']
• ls_fields['sidebar_email']
• ls_fields['sidebar_funding_code']
• ls_fields['sidebar_home_phone']
• ls_fields['sidebar_lpc']
• ls_fields['sidebar_mobile_phone']
• ls_fields['sidebar_primary_assignment']
• ls_fields['sidebar_slpc']
• ls_fields['sidebar_unsafe_address']
• ls_fields['social_security']
• ls_fields['state_representative']
• ls_fields['state_senator']