ResidentialPark

A residential park is an administrative unit of a care facility.

type ResidentialPark {
  absenceReasonTemplates(
    showInactive: Boolean
  ): [ClientAbsenceReasonTemplate!]
  activeCatalogues(
    refDate: Date
  ): [BenefitCatalogueWithOptions!]!
  activityPlan: ActivityPlan!
  activityTemplates(
    showInactive: Boolean
  ): [ActivityTemplate!]
  additionalBenefitsForMonth(
    month: Date!
  ): BenefitDashboardDetails!
  additionalInvoiceMessage: String
  address: Address
  ambulantCareInstitutionCode: InstitutionCode!
  ambulantInvoiceAddress: MailingAddress
  apartmentGroupJointCareSettings: [ApartmentGroupJointCareSettings!]
  apartmentGroups: [ApartmentGroup!]!
  appointments(
    filter: AppointmentFilterInput!
  ): AppointmentPeriod!
  asBremenAmbulant: AsBremenConnection
  asBremenDaycare: AsBremenConnection
  assignmentNoticeCareAndDischarge: Boolean!
  assignmentNoticePreventiveCare: Boolean!
  benefits(
    filter: BenefitsFilterInput
  ): [Benefit!]!
  careTeams: [CareTeam!]
  clientItemTemplates(
    type: ClientItemTemplateType!
  ): [ClientItemTemplate!]
  clients: [Client!]!
  clientsPendingCareDegreeApplications: [ClientPendingDegree!]!
  clientsUnderBudgetThreshold(
    month: Date
  ): [ClientsCostsBudgetRatio!]
  contractSignatureMode: SignatureType!
  costCentreCode: String
  costEstimationFreeText: String
  currentShiftPlan(
    month: Date
  ): SavedShiftPlan
  dashboardSettings: DashboardSettings!
  daycareInstitutionCode: InstitutionCode!
  daycareInvoiceAddress: MailingAddress
  email: String!
  employees(
    isArchived: Boolean
  ): [Employee!]!
  favicon: Document
  fleet: [Vehicle!]!
  fleetManagementUri: Url!
  id: ResidentialParkID!
  incompleteClients: [IncompleteClientEntry!]!
  invoiceCollection(
    month: Date!
  ): [InvoiceCollection!]!
  invoices(
    month: Date!
  ): [Invoice!]
  isArchived: Boolean!
  journalPrefix: String
  location: Geolocation
  logo: Document
  logoSmall: Document
  manager: Employee
  name: String!
  openSignatures: OpenSignatures!
  performanceReportSignatureMode: SignatureType!
  performanceReportSignatureSettings: PerformanceReportSignatureSettings!
  phoneNumber: String!
  plannedMonthlyRevenue(
    month: Date
  ): PlannedMonthlyRevenue!
  prescriptionsExpiringWithinTimeSpan(
    filter: PrescriptionExpirationFilter!
  ): [PrescriptionClientDetails!]!
  rejectedBenefitsForMonth(
    month: Date!
  ): BenefitDashboardDetails!
  rentConfiguration: RentBillingConfiguration!
  routingSettings: RoutingSettings!
  securityGroups: SecurityGroup!
  shiftPlanDraft(
    month: Date
  ): ShiftPlanDraft
  shiftPlanHistory(
    month: Date
  ): [SavedShiftPlan!]
  slug: String!
  timeTrackingMode: TimeTrackingMode!
}

Fields

ResidentialPark.absenceReasonTemplates ● [ClientAbsenceReasonTemplate!] list object

Templates for creating absence reasons

ResidentialPark.absenceReasonTemplates.showInactive ● Boolean scalar

ResidentialPark.activeCatalogues ● [BenefitCatalogueWithOptions!]! non-null object

Returns a list of active benefit catalogues for this residential park

ResidentialPark.activeCatalogues.refDate ● Date scalar

(Optional) The date to check the validity of the benefit catalogues. If not provided, the current date is used.

ResidentialPark.activityPlan ● ActivityPlan! non-null object

The activity plan of the residential park

ResidentialPark.activityTemplates ● [ActivityTemplate!] list object

Templates for creating activities

ResidentialPark.activityTemplates.showInactive ● Boolean scalar

ResidentialPark.additionalBenefitsForMonth ● BenefitDashboardDetails! non-null object

A List of extra added benefits for clients in a specific residential park

ResidentialPark.additionalBenefitsForMonth.month ● Date! non-null scalar

ResidentialPark.additionalInvoiceMessage ● String scalar

An additional message printed on each invoice of this residential park.

ResidentialPark.address ● Address scalar

Location of the park.

ResidentialPark.ambulantCareInstitutionCode ● InstitutionCode! non-null scalar

Identifier for the ambulant nursing care, unique 9-digit number

ResidentialPark.ambulantInvoiceAddress ● MailingAddress scalar

The invoice address used for ambulant services.

ResidentialPark.apartmentGroupJointCareSettings ● [ApartmentGroupJointCareSettings!] list object

Settings of a given type connected to the residential park

ResidentialPark.apartmentGroups ● [ApartmentGroup!]! non-null object

All apartment groups within this park

ResidentialPark.appointments ● AppointmentPeriod! non-null object

Fetches all appointments for a residential park for a given period. Can be filtered to fetch birthdays, consultations or absences. If no filter provided, all appointments are fetched by default.

ResidentialPark.appointments.filter ● AppointmentFilterInput! non-null input

ResidentialPark.asBremenAmbulant ● AsBremenConnection object

Fetches status information for the ambulant mandant from AS Bremen. Returns null if the mandant is not yet configured.

Use Mutation.enableAsBremenAmbulant to enable the ambulant mandant.

ResidentialPark.asBremenDaycare ● AsBremenConnection object

Fetches status information for the daycare mandant from AS Bremen. Returns null if the mandant is not yet configured.

Use Mutation.enableAsBremenDaycare to enable the daycare mandant.

ResidentialPark.assignmentNoticeCareAndDischarge ● Boolean! non-null scalar

Shows if the assignment notice is displayed in the performance report for benefits of service area $45b - Care and discharge

ResidentialPark.assignmentNoticePreventiveCare ● Boolean! non-null scalar

Shows if the assignment notice is displayed in the performance report for benefits of service area $39 - Preventive care

ResidentialPark.benefits ● [Benefit!]! non-null interface

Fetches all benefits available for this residential park. Does not return hidden benefits. To get also hidden benefits, use BenefitCatalogue.benefits instead.

ResidentialPark.benefits.filter ● BenefitsFilterInput input

ResidentialPark.careTeams ● [CareTeam!] list object

(Empty) if the residential park does not have any care teams.

ResidentialPark.clientItemTemplates ● [ClientItemTemplate!] list object

Fetch client item templates by residential park and type

ResidentialPark.clientItemTemplates.type ● ClientItemTemplateType! non-null enum

ResidentialPark.clients ● [Client!]! non-null object

clients belonging to this residential park

ResidentialPark.clientsPendingCareDegreeApplications ● [ClientPendingDegree!]! non-null object

Clients with pending care degree applications

ResidentialPark.clientsUnderBudgetThreshold ● [ClientsCostsBudgetRatio!] list object

Fetches the clients, whose costs for the month is below a given threshold (defined in the residential park) regarding the budget (e.g. under 97% of the budget)

ResidentialPark.clientsUnderBudgetThreshold.month ● Date scalar

ResidentialPark.contractSignatureMode ● SignatureType! non-null enum

The mode how a contract is signed by a client.

ResidentialPark.costCentreCode ● String scalar

The cost centre associated for this residential park. Especially required for the DATEV export.

ResidentialPark.costEstimationFreeText ● String scalar

The free text for the cost estimation of this residential park.

ResidentialPark.currentShiftPlan ● SavedShiftPlan object

Returns the current shift plan for a residential park based on the provided month. If month not provided, the current month is used.

ResidentialPark.currentShiftPlan.month ● Date scalar

ResidentialPark.dashboardSettings ● DashboardSettings! non-null object

The budget threshold under which clients are listed in Budget utilization

ResidentialPark.daycareInstitutionCode ● InstitutionCode! non-null scalar

Identifier for the daycare, unique 9-digit number

ResidentialPark.daycareInvoiceAddress ● MailingAddress scalar

The invoice address used for ambulant services.

ResidentialPark.email ● String! non-null scalar

The contact email address of the residential park

ResidentialPark.employees ● [Employee!]! non-null object

Fetch all employees belonging to this residential park By default, all employees are fetched If isArchived == True, only archived employees are fetched If isArchived == False, only active employees are fetched

ResidentialPark.employees.isArchived ● Boolean scalar

ResidentialPark.favicon ● Document object

The favicon of the residential park (optional).

ResidentialPark.fleet ● [Vehicle!]! non-null object

List of the registered Vehicle of this park.

ResidentialPark.fleetManagementUri ● Url! non-null scalar

URL to the fleet management.

ResidentialPark.id ● ResidentialParkID! non-null scalar

Unique identifier of the park.

ResidentialPark.incompleteClients ● [IncompleteClientEntry!]! non-null object

Fetches the open entries of a residential park with the corresponding client and reason

ResidentialPark.invoiceCollection ● [InvoiceCollection!]! non-null object

Fetches the invoices for a single calendar month merged by recipient and service area.

Private invoices are excluded.

ResidentialPark.invoiceCollection.month ● Date! non-null scalar

ResidentialPark.invoices ● [Invoice!] list object

Fetches the invoices of a residential park for a single calendar month

ResidentialPark.invoices.month ● Date! non-null scalar

ResidentialPark.isArchived ● Boolean! non-null scalar

Shows if the given park has been archived

ResidentialPark.journalPrefix ● String scalar

The prefix used for creating invoice numbers.

ResidentialPark.location ● Geolocation object

The location of the residential park.

ResidentialPark.logo ● Document object

The logo of the residential park (optional).

ResidentialPark.logoSmall ● Document object

The small logo of the residential park (optional).

ResidentialPark.manager ● Employee object

The manager of the residential park

ResidentialPark.name ● String! non-null scalar

Human-readable name

ResidentialPark.openSignatures ● OpenSignatures! non-null object

Information about the open signatures for performance reports nad contracts in a specific residential park

ResidentialPark.performanceReportSignatureMode ● SignatureType! non-null enum

The mode a performance report is signed by a client.

ResidentialPark.performanceReportSignatureSettings ● PerformanceReportSignatureSettings! non-null object

ResidentialPark.phoneNumber ● String! non-null scalar

The contact phone number address of the residential park

ResidentialPark.plannedMonthlyRevenue ● PlannedMonthlyRevenue! non-null object

Fetches the planned monthly revenue for a residential park for a given month. If no month is provided, it is fetched for the current month by default.

ResidentialPark.plannedMonthlyRevenue.month ● Date scalar

ResidentialPark.prescriptionsExpiringWithinTimeSpan ● [PrescriptionClientDetails!]! non-null object

Get prescriptions expiring before the end of the current year for a residential park

ResidentialPark.prescriptionsExpiringWithinTimeSpan.filter ● PrescriptionExpirationFilter! non-null input

ResidentialPark.rejectedBenefitsForMonth ● BenefitDashboardDetails! non-null object

A List of rejected benefits for clients in a specific residential park

ResidentialPark.rejectedBenefitsForMonth.month ● Date! non-null scalar

ResidentialPark.rentConfiguration ● RentBillingConfiguration! non-null object

Any configuration which is related to rent.

ResidentialPark.routingSettings ● RoutingSettings! non-null object

All settings related to the route planning

ResidentialPark.securityGroups ● SecurityGroup! non-null object

All users with access to this park.

ResidentialPark.shiftPlanDraft ● ShiftPlanDraft object

Fetches the shift plan draft for a residential park based on the provided month. If month not provided, the current month is used.

ResidentialPark.shiftPlanDraft.month ● Date scalar

ResidentialPark.shiftPlanHistory ● [SavedShiftPlan!] list object

Fetches the shift plan history for a residential park based on the provided month. If month not provided, the current month is used.

ResidentialPark.shiftPlanHistory.month ● Date scalar

ResidentialPark.slug ● String! non-null scalar

Short unique identifier of this park. This is especially used as abbreviation inside the URLs.

ResidentialPark.timeTrackingMode ● TimeTrackingMode! non-null enum

Shows the type of benefit time tracking setting for this park

Returned By

createResidentialPark mutation ● residentialPark query ● residentialParks query ● setContractSignatureMode mutation ● setPerformanceReportSignatureMode mutation ● updateTimeTrackingMode mutation

Member Of

ActiveTour object ● Apartment object ● ApartmentGroup object ● AssignBenefitCatalogueToParkPayload object ● BenefitCatalogue object ● Client object ● Employee object ● SetCostCentrePayload object ● SetJournalPayload object ● TargetTour object ● Tour interface ● UnassignBenefitCatalogueFromParkPayload object ● User object