ResidentialPark
A residential park is an administrative unit of a care facility.
type ResidentialPark {
absenceReasonTemplates(
showInactive: Boolean
): [AbsenceReasonTemplate!]
activityPlan: ActivityPlan!
activityTemplates(
showInactive: Boolean
): [ActivityTemplate!]
additionalBenefitsForMonth(
month: Date!
): BenefitDashboardDetails!
additionalInvoiceMessage: String
address: Address
ambulantCareInstitutionCode: InstitutionCode!
ambulantInvoiceAddress: MailingAddress
apartmentGroupJointCareSettings: [ApartmentGroupJointCareSettings!]
apartmentGroups(
notInSettings: Boolean
): [ApartmentGroup!]!
appointments(
filter: AppointmentFilterInput!
): AppointmentPeriod!
asBremenMandant: String
clients: [Client!]!
clientsPendingCareDegreeApplications: [ClientPendingDegree!]!
clientsUnderBudgetThreshold(
month: Date
): [ClientsCostsBudgetRatio!]
costCentreCode: String
daycareInstitutionCode: InstitutionCode!
daycareInvoiceAddress: MailingAddress
email: String!
employees: [Employee!]!
fleet: [Vehicle!]!
fleetManagementUri: Url!
id: ResidentialParkID!
incompleteClients: [IncompleteClientEntry!]!
invoiceCollection(
month: Date!
): [InvoiceCollection!]!
invoices(
month: Date!
): [Invoice!]
isAsBremenConfigured: Boolean!
journalPrefix: String
location: Geolocation
logo: Document
logoSmall: Document
name: String!
phoneNumber: String!
plannedMonthlyRevenue(
month: Date
): PlannedMonthlyRevenue!
pointValueFactors: PointValueFactorTimeLine!
prescriptionsExpiringWithinTimeSpan(
filter: PrescriptionExpirationFilter!
): [PrescriptionClientDetails!]!
rejectedBenefitsForMonth(
month: Date!
): BenefitDashboardDetails!
routingSettings: RoutingSettings!
securityGroups: SecurityGroup!
shiftPlanDraft(
month: Date
): ShiftPlanDraft
shiftPlanHistory(
month: Date
): [SavedShiftPlan!]
slug: String!
trainingLevyDaycare: TrainingLevyDaycareTimeLine!
trainingLevyNursing: TrainingLevyNursingTimeLine!
}
Fields
ResidentialPark.absenceReasonTemplates ● [AbsenceReasonTemplate!] list object
Templates for creating absence reasons
ResidentialPark.absenceReasonTemplates.showInactive ● Boolean scalar
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 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 Optional parameter filters all groups that are not added to the park settings Defaults to 'FALSE', an in this case fetches all groups of park
ResidentialPark.apartmentGroups.notInSettings ● Boolean scalar
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.asBremenMandant ● String scalar
The name of the configured AS Bremen Mandant
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.costCentreCode ● String scalar
The cost centre associated for this residential park. Especially required for the DATEV export.
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
employees belonging to this residential park
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.isAsBremenConfigured ● Boolean! non-null scalar
Returns true, if AS Bremen API is enabled for this client.
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.name ● String! non-null scalar
Human-readable name
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.pointValueFactors ● PointValueFactorTimeLine! non-null object
Collection of current and future point value factors, as well as it's history. A point value factor can be used to convert a point value of a benefit into a Euro price.
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.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.trainingLevyDaycare ● TrainingLevyDaycareTimeLine! non-null object
Collection of current and future training levy for daycare benefits, as well as it's history. A training levy for daycare is a Euro price which is added on a daily basis.
ResidentialPark.trainingLevyNursing ● TrainingLevyNursingTimeLine! non-null object
Collection of current and future training levy for §36 benefits, as well as it's history. A training levy is a float factor which is added for each §36 benefit.
Returned By
createResidentialPark mutation ● residentialPark query ● residentialParks query
Member Of
ActiveTour object ● Apartment object ● ApartmentGroup object ● Client object ● Employee object ● TargetTour object ● Tour interface ● User object