API reference

Client

class aiorentman.client.RentmanClient(session: ClientSession | None = None, *, token: str | None = None, request_timeout: float = 30.0, requests_per_second: float | None = 10.0, max_concurrent: int = 20)

Asynchronous client for the Rentman API.

The client covers every read and write path of the pinned document. Collections get a list method for one page and an iter method that follows the cursor. Every request holds one of max_concurrent slots and waits for its send turn at the documented rate, unless requests_per_second=None disables the send rate.

async async_close() → None

Close the session when this library created it.

async async_create_accessory_of_equipment(equipment_id: int, payload: AccessoryPayload) → Accessory | None

Create one accessory on one material.

async async_create_alternative_of_equipment(equipment_id: int, payload: AlternativePayload) → Alternative | None

Create one alternative on one material.

async async_create_appointment(payload: AppointmentPayload) → Appointment | None

Create one appointment.

async async_create_appointment_crew_of_appointment(appointment_id: int, payload: AppointmentCrewPayload) → AppointmentCrew | None

Create one appointment crew on one appointment.

async async_create_contact(payload: ContactPayload) → Contact | None

Create one contact.

async async_create_contact_person_of_contact(contact_id: int, payload: ContactPersonPayload) → ContactPerson | None

Create one contact person on one contact.

async async_create_crew_availability_of_crew(crew_id: int, payload: CrewAvailabilityPayload) → CrewAvailability | None

Create one crew availability on one crew member.

async async_create_equipment(payload: EquipmentPayload) → Equipment | None

Create one material.

async async_create_equipment_set_content_of_equipment(equipment_id: int, payload: EquipmentSetContentPayload) → EquipmentSetContent | None

Create one equipment set content on one material.

async async_create_folder(payload: FolderPayload) → Folder | None

Create one folder.

async async_create_leave_mutation(payload: LeaveMutationPayload) → LeaveMutation | None

Create one leave mutation.

async async_create_leave_request(payload: LeaveRequestPayload) → LeaveRequest | None

Create one leave request.

async async_create_payment_of_invoice(invoice_id: int, payload: PaymentPayload) → Payment | None

Create one payment on one invoice.

async async_create_project(payload: ProjectPayload) → Project | None

Create one project.

async async_create_project_cost_of_project(project_id: int, payload: ProjectCostPayload) → ProjectCost | None

Create one project cost on one project.

async async_create_project_function_group_of_project(project_id: int, payload: ProjectFunctionGroupPayload) → ProjectFunctionGroup | None

Create one project function group on one project.

async async_create_project_function_of_project(project_id: int, payload: ProjectFunctionPayload) → ProjectFunction | None

Create one project function on one project.

async async_create_project_request(payload: ProjectRequestPayload) → ProjectRequest | None

Create one project request.

async async_create_project_request_equipment_of_project_request(project_request_id: int, payload: ProjectRequestEquipmentPayload) → ProjectRequestEquipment | None

Create one project request equipment on one project request.

async async_create_serial_number_of_equipment(equipment_id: int, payload: SerialNumberPayload) → SerialNumber | None

Create one serial number on one material.

async async_create_stock_movement_of_equipment(equipment_id: int, payload: StockMovementPayload) → StockMovement | None

Create one stock movement on one material.

async async_create_subproject_of_project(project_id: int, payload: SubprojectPayload) → Subproject | None

Create one subproject on one project.

async async_create_subtask_of_task(task_id: int, payload: SubtaskPayload) → Subtask | None

Create one subtask on one task.

async async_create_supplier_of_equipment(equipment_id: int, payload: SupplierPayload) → Supplier | None

Create one supplier on one material.

async async_create_task(payload: TaskPayload) → Task | None

Create one task.

async async_create_task_assignment_of_task(task_id: int, payload: TaskAssignmentPayload) → TaskAssignment | None

Create one task assignment on one task.

async async_create_task_of_contact(contact_id: int, payload: TaskPayload) → Task | None

Create one task on one contact.

async async_create_task_of_contact_person(contact_person_id: int, payload: TaskPayload) → Task | None

Create one task on one contact person.

async async_create_task_of_contract(contract_id: int, payload: TaskPayload) → Task | None

Create one task on one contract.

async async_create_task_of_crew(crew_id: int, payload: TaskPayload) → Task | None

Create one task on one crew member.

async async_create_task_of_equipment(equipment_id: int, payload: TaskPayload) → Task | None

Create one task on one material.

async async_create_task_of_invoice(invoice_id: int, payload: TaskPayload) → Task | None

Create one task on one invoice.

async async_create_task_of_project(project_id: int, payload: TaskPayload) → Task | None

Create one task on one project.

async async_create_task_of_purchase_order(purchase_order_id: int, payload: TaskPayload) → Task | None

Create one task on one purchase order.

async async_create_task_of_quote(quote_id: int, payload: TaskPayload) → Task | None

Create one task on one quote.

async async_create_task_of_repair(repair_id: int, payload: TaskPayload) → Task | None

Create one task on one repair.

async async_create_task_of_serial_number(serial_number_id: int, payload: TaskPayload) → Task | None

Create one task on one serial number.

async async_create_task_of_subrental(subrental_id: int, payload: TaskPayload) → Task | None

Create one task on one subrental.

async async_create_task_of_supplier(supplier_id: int, payload: TaskPayload) → Task | None

Create one task on one supplier.

async async_create_task_of_vehicle(vehicle_id: int, payload: TaskPayload) → Task | None

Create one task on one vehicle.

async async_create_task_status(payload: TaskStatusPayload) → TaskStatus | None

Create one task status.

async async_create_time_registration(payload: TimeRegistrationPayload) → TimeRegistration | None

Create one time registration.

async async_create_time_registration_of_leave_request(leave_request_id: int, payload: TimeRegistrationPayload) → TimeRegistration | None

Create one time registration on one leave request.

async async_create_vehicle(payload: VehiclePayload) → Vehicle | None

Create one vehicle.

async async_create_vehicle_of_stock_location(stock_location_id: int, payload: VehiclePayload) → Vehicle | None

Create one vehicle on one stock location.

async async_delete_accessory(accessory_id: int) → None

Delete one accessory by its id.

async async_delete_alternative(alternative_id: int) → None

Delete one alternative by its id.

async async_delete_appointment(appointment_id: int) → None

Delete one appointment by its id.

async async_delete_appointment_crew(appointment_crew_id: int) → None

Delete one appointment crew by its id.

async async_delete_contact(contact_id: int) → None

Delete one contact by its id.

async async_delete_contact_person(contact_person_id: int) → None

Delete one contact person by its id.

async async_delete_crew_availability(crew_availability_id: int) → None

Delete one crew availability by its id.

async async_delete_equipment_set_content(equipment_set_content_id: int) → None

Delete one equipment set content by its id.

async async_delete_project_cost(project_cost_id: int) → None

Delete one project cost by its id.

async async_delete_project_request(project_request_id: int) → None

Delete one project request by its id.

async async_delete_project_request_equipment(project_request_equipment_id: int) → None

Delete one project request equipment by its id.

async async_delete_serial_number(serial_number_id: int) → None

Delete one serial number by its id.

async async_delete_stock_movement(stock_movement_id: int) → None

Delete one stock movement by its id.

async async_delete_subtask(subtask_id: int) → None

Delete one subtask by its id.

async async_delete_supplier(supplier_id: int) → None

Delete one supplier by its id.

async async_delete_task(task_id: int) → None

Delete one task by its id.

async async_delete_task_assignment(task_assignment_id: int) → None

Delete one task assignment by its id.

async async_delete_task_status(task_status_id: int) → None

Delete one task status by its id.

async async_delete_time_registration(time_registration_id: int) → None

Delete one time registration by its id.

async async_delete_vehicle(vehicle_id: int) → None

Delete one vehicle by its id.

async async_get_accessory(accessory_id: int) → Accessory | None

Fetch one accessory by its id.

async async_get_actual_content(actual_content_id: int) → ActualContent | None

Fetch one recorded combination content by its id.

async async_get_alternative(alternative_id: int) → Alternative | None

Fetch one alternative by its id.

async async_get_appointment(appointment_id: int) → Appointment | None

Fetch one appointment by its id.

async async_get_appointment_crew(appointment_crew_id: int) → AppointmentCrew | None

Fetch one appointment crew attachment by its id.

async async_get_contact(contact_id: int) → Contact | None

Fetch one contact by its id.

async async_get_contact_person(contact_person_id: int) → ContactPerson | None

Fetch one contact person by their id.

async async_get_contract(contract_id: int) → Contract | None

Fetch one contract by its id.

async async_get_crew(crew_id: int) → Crew | None

Fetch one crew member by their id.

async async_get_crew_availability(availability_id: int) → CrewAvailability | None

Fetch one availability window by its id.

async async_get_crew_rate(crew_rate_id: int) → CrewRate | None

Fetch one crew rate by its id.

async async_get_equipment(equipment_id: int) → Equipment | None

Fetch one material by its id.

async async_get_equipment_assigned_serial(assigned_serial_id: int) → EquipmentAssignedSerial | None

Fetch one combination assignment by its id.

async async_get_equipment_set_content(equipment_set_content_id: int) → EquipmentSetContent | None

Fetch one equipment set content by its id.

async async_get_extra_input_field(extra_input_field_id: int) → ExtraInputField | None

Fetch one custom field definition by its id.

async async_get_factor(factor_id: int) → Factor | None

Fetch one factor by its id.

async async_get_factor_group(factor_group_id: int) → FactorGroup | None

Fetch one factor group by its id.

async async_get_file(file_id: int) → File | None

Fetch one file by its id.

async async_get_file_folder(file_folder_id: int) → FileFolder | None

Fetch one file folder by its id.

async async_get_folder(folder_id: int) → Folder | None

Fetch one folder by its id.

async async_get_invitation(invitation_id: int) → Invitation | None

Fetch one planning invitation by its id.

async async_get_invoice(invoice_id: int) → Invoice | None

Fetch one invoice by its id.

async async_get_invoice_line(invoice_line_id: int) → InvoiceLine | None

Fetch one invoice line by its id.

async async_get_leave_mutation(leave_mutation_id: int) → LeaveMutation | None

Fetch one leave balance mutation by its id.

async async_get_leave_request(leave_request_id: int) → LeaveRequest | None

Fetch one leave request by its id.

async async_get_leave_type(leave_type_id: int) → LeaveType | None

Fetch one leave type by its id.

async async_get_ledger_code(ledger_code_id: int) → LedgerCode | None

Fetch one ledger code by its id.

async async_get_payment(payment_id: int) → Payment | None

Fetch one payment by its id.

async async_get_project(project_id: int) → Project | None

Fetch one project by its id.

async async_get_project_cost(project_cost_id: int) → ProjectCost | None

Fetch one project cost line by its id.

async async_get_project_crew(project_crew_id: int) → ProjectCrew | None

Fetch one planned crew member by its id.

async async_get_project_equipment(project_equipment_id: int) → ProjectEquipment | None

Fetch one planned equipment line by its id.

async async_get_project_equipment_group(group_id: int) → ProjectEquipmentGroup | None

Fetch one project equipment group by its id.

async async_get_project_function(function_id: int) → ProjectFunction | None

Fetch one project function by its id.

async async_get_project_function_group(group_id: int) → ProjectFunctionGroup | None

Fetch one project function group by its id.

async async_get_project_request(project_request_id: int) → ProjectRequest | None

Fetch one project request by its id.

async async_get_project_request_equipment(project_request_equipment_id: int) → ProjectRequestEquipment | None

Fetch one requested equipment line by its id.

async async_get_project_status(project_status_id: int) → ProjectStatus | None

Fetch one project status by its id.

async async_get_project_type(project_type_id: int) → ProjectType | None

Fetch one project type by its id.

async async_get_project_vehicle(project_vehicle_id: int) → ProjectVehicle | None

Fetch one planned vehicle by its id.

async async_get_purchase_order(purchase_order_id: int) → PurchaseOrder | None

Fetch one purchase order by its id.

async async_get_purchase_order_cost(purchase_order_cost_id: int) → PurchaseOrderCost | None

Fetch one purchase order cost line by its id.

async async_get_purchase_order_global_cost(purchase_order_global_cost_id: int) → PurchaseOrderGlobalCost | None

Fetch one purchase order global cost line by its id.

async async_get_quote(quote_id: int) → Quote | None

Fetch one quote by its id.

async async_get_rate(rate_id: int) → Rate | None

Fetch one rate by its id.

async async_get_rate_factor(rate_factor_id: int) → RateFactor | None

Fetch one rate factor by its id.

async async_get_repair(repair_id: int) → Repair | None

Fetch one repair by its id.

async async_get_serial_number(serial_number_id: int) → SerialNumber | None

Fetch one serial number by its id.

async async_get_status(status_id: int) → Status | None

Fetch one planning status by its id.

async async_get_stock_location(stock_location_id: int) → StockLocation | None

Fetch one stock location by its id.

async async_get_stock_movement(stock_movement_id: int) → StockMovement | None

Fetch one stock movement by its id.

async async_get_subproject(subproject_id: int) → Subproject | None

Fetch one subproject by its id.

async async_get_subrental(subrental_id: int) → Subrental | None

Fetch one subrental by its id.

async async_get_subrental_equipment(subrental_equipment_id: int) → SubrentalEquipment | None

Fetch one subrental equipment line by its id.

async async_get_subrental_equipment_group(group_id: int) → SubrentalEquipmentGroup | None

Fetch one subrental equipment group by its id.

async async_get_subtask(subtask_id: int) → Subtask | None

Fetch one subtask by its id.

async async_get_supplier(supplier_id: int) → Supplier | None

Fetch one supplier by its id.

async async_get_task(task_id: int) → Task | None

Fetch one task by its id.

async async_get_task_assignment(task_assignment_id: int) → TaskAssignment | None

Fetch one task assignment by its id.

async async_get_task_status(task_status_id: int) → TaskStatus | None

Fetch one task status by its id.

async async_get_tax_class(tax_class_id: int) → TaxClass | None

Fetch one tax class by its id.

async async_get_time_registration(time_registration_id: int) → TimeRegistration | None

Fetch one time registration by its id.

async async_get_time_registration_activity(activity_id: int) → TimeRegistrationActivity | None

Fetch one time registration activity by its id.

async async_get_vehicle(vehicle_id: int) → Vehicle | None

Fetch one vehicle by its id.

async async_get_warehouse_status(warehouse_status_id: int) → WarehouseStatus | None

Fetch one warehouse status by its id.

async_iter_accessories(query: Query | None = None) → AsyncIterator[Accessory]

Yield every accessory, following the cursor across pages.

async_iter_accessories_of_equipment(equipment_id: int, query: Query | None = None) → AsyncIterator[Accessory]

Yield every accessory of one material, following the cursor.

async_iter_actual_content(query: Query | None = None) → AsyncIterator[ActualContent]

Yield every recorded combination content, following the cursor.

async_iter_actual_content_of_serial_number(serial_number_id: int, query: Query | None = None) → AsyncIterator[ActualContent]

Yield every content of one combination serial, following the cursor.

async_iter_alternatives(query: Query | None = None) → AsyncIterator[Alternative]

Yield every alternative, following the cursor across pages.

async_iter_alternatives_of_equipment(equipment_id: int, query: Query | None = None) → AsyncIterator[Alternative]

Yield every alternative of one material, following the cursor.

async_iter_appointment_crew(query: Query | None = None) → AsyncIterator[AppointmentCrew]

Yield every appointment crew attachment, following the cursor across pages.

async_iter_appointment_crew_of_appointment(appointment_id: int, query: Query | None = None) → AsyncIterator[AppointmentCrew]

Yield every crew member attached to one appointment, following the cursor.

async_iter_appointments(query: Query | None = None) → AsyncIterator[Appointment]

Yield every appointment, following the cursor across pages.

async_iter_appointments_of_crew(crew_id: int, query: Query | None = None) → AsyncIterator[Appointment]

Yield every appointment of one crew member, following the cursor.

async_iter_contact_persons(query: Query | None = None) → AsyncIterator[ContactPerson]

Yield every contact person, following the cursor across pages.

async_iter_contact_persons_of_contact(contact_id: int, query: Query | None = None) → AsyncIterator[ContactPerson]

Yield every contact person of one contact, following the cursor.

async_iter_contacts(query: Query | None = None) → AsyncIterator[Contact]

Yield every contact, following the cursor across pages.

async_iter_contracts(query: Query | None = None) → AsyncIterator[Contract]

Yield every contract, following the cursor across pages.

async_iter_contracts_of_project(project_id: int, query: Query | None = None) → AsyncIterator[Contract]

Yield every contract of one project, following the cursor.

async_iter_crew(query: Query | None = None) → AsyncIterator[Crew]

Yield every crew member, following the cursor across pages.

async_iter_crew_availability(query: Query | None = None) → AsyncIterator[CrewAvailability]

Yield every availability window, following the cursor across pages.

async_iter_crew_availability_of_crew(crew_id: int, query: Query | None = None) → AsyncIterator[CrewAvailability]

Yield every availability window of one crew member, following the cursor.

async_iter_crew_rates(query: Query | None = None) → AsyncIterator[CrewRate]

Yield every crew rate, following the cursor across pages.

async_iter_crew_rates_of_crew(crew_id: int, query: Query | None = None) → AsyncIterator[CrewRate]

Yield every rate of one crew member, following the cursor.

async_iter_equipment(query: Query | None = None) → AsyncIterator[Equipment]

Yield every material, following the cursor across pages.

async_iter_equipment_assigned_serials(query: Query | None = None) → AsyncIterator[EquipmentAssignedSerial]

Yield every combination assignment, following the cursor.

async_iter_equipment_assigned_serials_of_serial_number(serial_number_id: int, query: Query | None = None) → AsyncIterator[EquipmentAssignedSerial]

Yield every assignment of one combination serial, following the cursor.

async_iter_equipment_set_content(query: Query | None = None) → AsyncIterator[EquipmentSetContent]

Yield every equipment set content, following the cursor.

async_iter_equipment_set_content_of_equipment(equipment_id: int, query: Query | None = None) → AsyncIterator[EquipmentSetContent]

Yield every set content of one combination material, following the cursor.

async_iter_extra_input_fields(query: Query | None = None) → AsyncIterator[ExtraInputField]

Yield every custom field definition, following the cursor across pages.

async_iter_factor_groups(query: Query | None = None) → AsyncIterator[FactorGroup]

Yield every factor group, following the cursor across pages.

async_iter_factors(query: Query | None = None) → AsyncIterator[Factor]

Yield every factor, following the cursor across pages.

async_iter_factors_of_factor_group(factor_group_id: int, query: Query | None = None) → AsyncIterator[Factor]

Yield every factor of one factor group, following the cursor.

async_iter_file_folders(query: Query | None = None) → AsyncIterator[FileFolder]

Yield every file_folder, following the cursor across pages.

async_iter_file_folders_of_contact(contact_id: int, query: Query | None = None) → AsyncIterator[FileFolder]

Yield every file folder of one contact, following the cursor.

async_iter_file_folders_of_contact_person(contact_person_id: int, query: Query | None = None) → AsyncIterator[FileFolder]

Yield every file folder of one contact person, following the cursor.

async_iter_file_folders_of_crew(crew_id: int, query: Query | None = None) → AsyncIterator[FileFolder]

Yield every file folder of one crew member, following the cursor.

async_iter_file_folders_of_equipment(equipment_id: int, query: Query | None = None) → AsyncIterator[FileFolder]

Yield every file folder of one material, following the cursor.

async_iter_file_folders_of_project(project_id: int, query: Query | None = None) → AsyncIterator[FileFolder]

Yield every file folder of one project, following the cursor.

async_iter_file_folders_of_purchase_order(purchase_order_id: int, query: Query | None = None) → AsyncIterator[FileFolder]

Yield every file folder of one purchase order, following the cursor.

async_iter_file_folders_of_repair(repair_id: int, query: Query | None = None) → AsyncIterator[FileFolder]

Yield every file folder of one repair, following the cursor.

async_iter_file_folders_of_serial_number(serial_number_id: int, query: Query | None = None) → AsyncIterator[FileFolder]

Yield every file folder of one serial number, following the cursor.

async_iter_file_folders_of_subproject(subproject_id: int, query: Query | None = None) → AsyncIterator[FileFolder]

Yield every file folder of one subproject, following the cursor.

async_iter_file_folders_of_subrental(subrental_id: int, query: Query | None = None) → AsyncIterator[FileFolder]

Yield every file folder of one subrental, following the cursor.

async_iter_file_folders_of_supplier(supplier_id: int, query: Query | None = None) → AsyncIterator[FileFolder]

Yield every file folder of one supplier, following the cursor.

async_iter_file_folders_of_task(task_id: int, query: Query | None = None) → AsyncIterator[FileFolder]

Yield every file folder of one task, following the cursor.

async_iter_file_folders_of_vehicle(vehicle_id: int, query: Query | None = None) → AsyncIterator[FileFolder]

Yield every file folder of one vehicle, following the cursor.

async_iter_files(query: Query | None = None) → AsyncIterator[File]

Yield every file, following the cursor across pages.

async_iter_files_of_contact(contact_id: int, query: Query | None = None) → AsyncIterator[File]

Yield every file of one contact, following the cursor.

async_iter_files_of_contact_person(contact_person_id: int, query: Query | None = None) → AsyncIterator[File]

Yield every file of one contact person, following the cursor.

async_iter_files_of_contract(contract_id: int, query: Query | None = None) → AsyncIterator[File]

Yield every file of one contract, following the cursor.

async_iter_files_of_crew(crew_id: int, query: Query | None = None) → AsyncIterator[File]

Yield every file of one crew member, following the cursor.

async_iter_files_of_equipment(equipment_id: int, query: Query | None = None) → AsyncIterator[File]

Yield every file of one material, following the cursor.

async_iter_files_of_invoice(invoice_id: int, query: Query | None = None) → AsyncIterator[File]

Yield every file of one invoice, following the cursor.

async_iter_files_of_project(project_id: int, query: Query | None = None) → AsyncIterator[File]

Yield every file of one project, following the cursor.

async_iter_files_of_purchase_order(purchase_order_id: int, query: Query | None = None) → AsyncIterator[File]

Yield every file of one purchase order, following the cursor.

async_iter_files_of_quote(quote_id: int, query: Query | None = None) → AsyncIterator[File]

Yield every file of one quote, following the cursor.

async_iter_files_of_repair(repair_id: int, query: Query | None = None) → AsyncIterator[File]

Yield every file of one repair, following the cursor.

async_iter_files_of_serial_number(serial_number_id: int, query: Query | None = None) → AsyncIterator[File]

Yield every file of one serial number, following the cursor.

async_iter_files_of_subrental(subrental_id: int, query: Query | None = None) → AsyncIterator[File]

Yield every file of one subrental, following the cursor.

async_iter_files_of_supplier(supplier_id: int, query: Query | None = None) → AsyncIterator[File]

Yield every file of one supplier, following the cursor.

async_iter_files_of_task(task_id: int, query: Query | None = None) → AsyncIterator[File]

Yield every file of one task, following the cursor.

async_iter_files_of_time_registration(time_registration_id: int, query: Query | None = None) → AsyncIterator[File]

Yield every file of one time registration, following the cursor.

async_iter_files_of_vehicle(vehicle_id: int, query: Query | None = None) → AsyncIterator[File]

Yield every file of one vehicle, following the cursor.

async_iter_folders(query: Query | None = None) → AsyncIterator[Folder]

Yield every folder, following the cursor across pages.

async_iter_invitations(query: Query | None = None) → AsyncIterator[Invitation]

Yield every planning invitation, following the cursor across pages.

async_iter_invitations_of_crew(crew_id: int, query: Query | None = None) → AsyncIterator[Invitation]

Yield every invitation of one crew member, following the cursor.

async_iter_invoice_lines(query: Query | None = None) → AsyncIterator[InvoiceLine]

Yield every invoice line, following the cursor across pages.

async_iter_invoice_lines_of_contract(contract_id: int, query: Query | None = None) → AsyncIterator[InvoiceLine]

Yield every invoice line of one contract, following the cursor.

async_iter_invoice_lines_of_invoice(invoice_id: int, query: Query | None = None) → AsyncIterator[InvoiceLine]

Yield every invoice line of one invoice, following the cursor.

async_iter_invoice_lines_of_purchase_order(purchase_order_id: int, query: Query | None = None) → AsyncIterator[InvoiceLine]

Yield every invoice line of one purchase order, following the cursor.

async_iter_invoice_lines_of_quote(quote_id: int, query: Query | None = None) → AsyncIterator[InvoiceLine]

Yield every invoice line of one quote, following the cursor.

async_iter_invoices(query: Query | None = None) → AsyncIterator[Invoice]

Yield every invoice, following the cursor across pages.

async_iter_leave_mutations(query: Query | None = None) → AsyncIterator[LeaveMutation]

Yield every leave balance mutation, following the cursor across pages.

async_iter_leave_requests(query: Query | None = None) → AsyncIterator[LeaveRequest]

Yield every leave request, following the cursor across pages.

async_iter_leave_types(query: Query | None = None) → AsyncIterator[LeaveType]

Yield every leave type, following the cursor across pages.

async_iter_ledger_codes(query: Query | None = None) → AsyncIterator[LedgerCode]

Yield every ledger code, following the cursor across pages.

async_iter_payments(query: Query | None = None) → AsyncIterator[Payment]

Yield every payment, following the cursor across pages.

async_iter_payments_of_invoice(invoice_id: int, query: Query | None = None) → AsyncIterator[Payment]

Yield every payment of one invoice, following the cursor.

async_iter_project_costs(query: Query | None = None) → AsyncIterator[ProjectCost]

Yield every project cost line, following the cursor across pages.

async_iter_project_costs_of_project(project_id: int, query: Query | None = None) → AsyncIterator[ProjectCost]

Yield every cost line of one project, following the cursor.

async_iter_project_crew(query: Query | None = None) → AsyncIterator[ProjectCrew]

Yield every planned crew member, following the cursor across pages.

async_iter_project_crew_of_project(project_id: int, query: Query | None = None) → AsyncIterator[ProjectCrew]

Yield every planned crew member of one project, following the cursor.

async_iter_project_crew_of_project_function(function_id: int, query: Query | None = None) → AsyncIterator[ProjectCrew]

Yield every crew member planned on one function, following the cursor.

async_iter_project_crew_of_subproject(subproject_id: int, query: Query | None = None) → AsyncIterator[ProjectCrew]

Yield every planned crew member of one subproject, following the cursor.

async_iter_project_equipment(query: Query | None = None) → AsyncIterator[ProjectEquipment]

Yield every planned equipment line, following the cursor.

async_iter_project_equipment_groups(query: Query | None = None) → AsyncIterator[ProjectEquipmentGroup]

Yield every project equipment group, following the cursor across pages.

async_iter_project_equipment_groups_of_project(project_id: int, query: Query | None = None) → AsyncIterator[ProjectEquipmentGroup]

Yield every equipment group of one project, following the cursor.

async_iter_project_equipment_groups_of_subproject(subproject_id: int, query: Query | None = None) → AsyncIterator[ProjectEquipmentGroup]

Yield every equipment group of one subproject, following the cursor.

async_iter_project_equipment_of_project(project_id: int, query: Query | None = None) → AsyncIterator[ProjectEquipment]

Yield every planned equipment line of one project, following the cursor.

async_iter_project_equipment_of_project_equipment_group(group_id: int, query: Query | None = None) → AsyncIterator[ProjectEquipment]

Yield every planned equipment line of one equipment group, following the cursor.

async_iter_project_equipment_of_subproject(subproject_id: int, query: Query | None = None) → AsyncIterator[ProjectEquipment]

Yield every planned equipment line of one subproject, following the cursor.

async_iter_project_function_groups(query: Query | None = None) → AsyncIterator[ProjectFunctionGroup]

Yield every project function group, following the cursor across pages.

async_iter_project_function_groups_of_project(project_id: int, query: Query | None = None) → AsyncIterator[ProjectFunctionGroup]

Yield every function group of one project, following the cursor.

async_iter_project_function_groups_of_subproject(subproject_id: int, query: Query | None = None) → AsyncIterator[ProjectFunctionGroup]

Yield every function group of one subproject, following the cursor.

async_iter_project_functions(query: Query | None = None) → AsyncIterator[ProjectFunction]

Yield every project function, following the cursor across pages.

async_iter_project_functions_of_project(project_id: int, query: Query | None = None) → AsyncIterator[ProjectFunction]

Yield every function of one project, following the cursor.

async_iter_project_functions_of_project_function_group(group_id: int, query: Query | None = None) → AsyncIterator[ProjectFunction]

Yield every function of one function group, following the cursor.

async_iter_project_request_equipment(query: Query | None = None) → AsyncIterator[ProjectRequestEquipment]

Yield every requested equipment line, following the cursor across pages.

async_iter_project_request_equipment_of_project_request(project_request_id: int, query: Query | None = None) → AsyncIterator[ProjectRequestEquipment]

Yield every requested equipment line of one project request, following the cursor.

async_iter_project_requests(query: Query | None = None) → AsyncIterator[ProjectRequest]

Yield every project request, following the cursor across pages.

async_iter_project_statuses(query: Query | None = None) → AsyncIterator[ProjectStatus]

Yield every project status, following the cursor across pages.

async_iter_project_types(query: Query | None = None) → AsyncIterator[ProjectType]

Yield every project type, following the cursor across pages.

async_iter_project_vehicles(query: Query | None = None) → AsyncIterator[ProjectVehicle]

Yield every planned vehicle, following the cursor across pages.

async_iter_project_vehicles_of_project(project_id: int, query: Query | None = None) → AsyncIterator[ProjectVehicle]

Yield every planned vehicle of one project, following the cursor.

async_iter_project_vehicles_of_project_function(function_id: int, query: Query | None = None) → AsyncIterator[ProjectVehicle]

Yield every vehicle planned on one function, following the cursor.

async_iter_project_vehicles_of_subproject(subproject_id: int, query: Query | None = None) → AsyncIterator[ProjectVehicle]

Yield every planned vehicle of one subproject, following the cursor.

async_iter_projects(query: Query | None = None) → AsyncIterator[Project]

Yield every project, following the cursor across pages.

async_iter_purchase_order_costs(query: Query | None = None) → AsyncIterator[PurchaseOrderCost]

Yield every purchase order cost line, following the cursor across pages.

async_iter_purchase_order_costs_of_purchase_order(purchase_order_id: int, query: Query | None = None) → AsyncIterator[PurchaseOrderCost]

Yield every cost line of one purchase order, following the cursor.

async_iter_purchase_order_global_costs(query: Query | None = None) → AsyncIterator[PurchaseOrderGlobalCost]

Yield every purchase order global cost line, following the cursor across pages.

async_iter_purchase_order_global_costs_of_purchase_order(purchase_order_id: int, query: Query | None = None) → AsyncIterator[PurchaseOrderGlobalCost]

Yield every global cost line of one purchase order, following the cursor.

async_iter_purchase_orders(query: Query | None = None) → AsyncIterator[PurchaseOrder]

Yield every purchase order, following the cursor across pages.

async_iter_quotes(query: Query | None = None) → AsyncIterator[Quote]

Yield every quote, following the cursor across pages.

async_iter_quotes_of_project(project_id: int, query: Query | None = None) → AsyncIterator[Quote]

Yield every quote of one project, following the cursor.

async_iter_rate_factors(query: Query | None = None) → AsyncIterator[RateFactor]

Yield every rate factor, following the cursor across pages.

async_iter_rate_factors_of_rate(rate_id: int, query: Query | None = None) → AsyncIterator[RateFactor]

Yield every rate factor of one rate, following the cursor.

async_iter_rates(query: Query | None = None) → AsyncIterator[Rate]

Yield every rate, following the cursor across pages.

async_iter_repairs(query: Query | None = None) → AsyncIterator[Repair]

Yield every repair, following the cursor across pages.

async_iter_repairs_of_equipment(equipment_id: int, query: Query | None = None) → AsyncIterator[Repair]

Yield every repair of one material, following the cursor.

async_iter_serial_numbers(query: Query | None = None) → AsyncIterator[SerialNumber]

Yield every serial number, following the cursor across pages.

async_iter_serial_numbers_of_equipment(equipment_id: int, query: Query | None = None) → AsyncIterator[SerialNumber]

Yield every serial number of one material, following the cursor.

async_iter_statuses(query: Query | None = None) → AsyncIterator[Status]

Yield every planning status, following the cursor across pages.

async_iter_stock_locations(query: Query | None = None) → AsyncIterator[StockLocation]

Yield every stock location, following the cursor across pages.

async_iter_stock_movements(query: Query | None = None) → AsyncIterator[StockMovement]

Yield every stock movement, following the cursor across pages.

async_iter_stock_movements_of_equipment(equipment_id: int, query: Query | None = None) → AsyncIterator[StockMovement]

Yield every stock movement of one material, following the cursor.

async_iter_subprojects(query: Query | None = None) → AsyncIterator[Subproject]

Yield every subproject, following the cursor across pages.

async_iter_subprojects_of_project(project_id: int, query: Query | None = None) → AsyncIterator[Subproject]

Yield every subproject of one project, following the cursor.

async_iter_subrental_equipment(query: Query | None = None) → AsyncIterator[SubrentalEquipment]

Yield every subrental equipment line, following the cursor across pages.

async_iter_subrental_equipment_groups(query: Query | None = None) → AsyncIterator[SubrentalEquipmentGroup]

Yield every subrental equipment group, following the cursor across pages.

async_iter_subrental_equipment_groups_of_subrental(subrental_id: int, query: Query | None = None) → AsyncIterator[SubrentalEquipmentGroup]

Yield every equipment group of one subrental, following the cursor.

async_iter_subrental_equipment_of_subrental(subrental_id: int, query: Query | None = None) → AsyncIterator[SubrentalEquipment]

Yield every equipment line of one subrental, following the cursor.

async_iter_subrental_equipment_of_subrental_equipment_group(group_id: int, query: Query | None = None) → AsyncIterator[SubrentalEquipment]

Yield every equipment line of one subrental group, following the cursor.

async_iter_subrentals(query: Query | None = None) → AsyncIterator[Subrental]

Yield every subrental, following the cursor across pages.

async_iter_subtasks(query: Query | None = None) → AsyncIterator[Subtask]

Yield every subtask, following the cursor across pages.

async_iter_subtasks_of_task(task_id: int, query: Query | None = None) → AsyncIterator[Subtask]

Yield every subtask of one task, following the cursor.

async_iter_suppliers(query: Query | None = None) → AsyncIterator[Supplier]

Yield every supplier, following the cursor across pages.

async_iter_suppliers_of_equipment(equipment_id: int, query: Query | None = None) → AsyncIterator[Supplier]

Yield every supplier of one material, following the cursor.

async_iter_task_assignments(query: Query | None = None) → AsyncIterator[TaskAssignment]

Yield every task_assignment, following the cursor across pages.

async_iter_task_assignments_of_task(task_id: int, query: Query | None = None) → AsyncIterator[TaskAssignment]

Yield every task assignment of one task, following the cursor.

async_iter_task_statuses(query: Query | None = None) → AsyncIterator[TaskStatus]

Yield every task_status, following the cursor across pages.

async_iter_tasks(query: Query | None = None) → AsyncIterator[Task]

Yield every task, following the cursor across pages.

async_iter_tasks_of_contact(contact_id: int, query: Query | None = None) → AsyncIterator[Task]

Yield every task of one contact, following the cursor.

async_iter_tasks_of_contact_person(contact_person_id: int, query: Query | None = None) → AsyncIterator[Task]

Yield every task of one contact person, following the cursor.

async_iter_tasks_of_contract(contract_id: int, query: Query | None = None) → AsyncIterator[Task]

Yield every task of one contract, following the cursor.

async_iter_tasks_of_crew(crew_id: int, query: Query | None = None) → AsyncIterator[Task]

Yield every task of one crew member, following the cursor.

async_iter_tasks_of_equipment(equipment_id: int, query: Query | None = None) → AsyncIterator[Task]

Yield every task of one material, following the cursor.

async_iter_tasks_of_invoice(invoice_id: int, query: Query | None = None) → AsyncIterator[Task]

Yield every task of one invoice, following the cursor.

async_iter_tasks_of_project(project_id: int, query: Query | None = None) → AsyncIterator[Task]

Yield every task of one project, following the cursor.

async_iter_tasks_of_purchase_order(purchase_order_id: int, query: Query | None = None) → AsyncIterator[Task]

Yield every task of one purchase order, following the cursor.

async_iter_tasks_of_quote(quote_id: int, query: Query | None = None) → AsyncIterator[Task]

Yield every task of one quote, following the cursor.

async_iter_tasks_of_repair(repair_id: int, query: Query | None = None) → AsyncIterator[Task]

Yield every task of one repair, following the cursor.

async_iter_tasks_of_serial_number(serial_number_id: int, query: Query | None = None) → AsyncIterator[Task]

Yield every task of one serial number, following the cursor.

async_iter_tasks_of_subrental(subrental_id: int, query: Query | None = None) → AsyncIterator[Task]

Yield every task of one subrental, following the cursor.

async_iter_tasks_of_supplier(supplier_id: int, query: Query | None = None) → AsyncIterator[Task]

Yield every task of one supplier, following the cursor.

async_iter_tasks_of_vehicle(vehicle_id: int, query: Query | None = None) → AsyncIterator[Task]

Yield every task of one vehicle, following the cursor.

async_iter_tax_classes(query: Query | None = None) → AsyncIterator[TaxClass]

Yield every tax class, following the cursor across pages.

async_iter_time_registration_activities(query: Query | None = None) → AsyncIterator[TimeRegistrationActivity]

Yield every time registration activity, following the cursor across pages.

async_iter_time_registration_activities_of_time_registration(time_registration_id: int, query: Query | None = None) → AsyncIterator[TimeRegistrationActivity]

Yield every activity of one time registration, following the cursor.

async_iter_time_registrations(query: Query | None = None) → AsyncIterator[TimeRegistration]

Yield every time registration, following the cursor across pages.

async_iter_time_registrations_of_leave_request(leave_request_id: int, query: Query | None = None) → AsyncIterator[TimeRegistration]

Yield every time registration of one leave request, following the cursor.

async_iter_vehicles(query: Query | None = None) → AsyncIterator[Vehicle]

Yield every vehicle, following the cursor across pages.

async_iter_vehicles_of_stock_location(stock_location_id: int, query: Query | None = None) → AsyncIterator[Vehicle]

Yield every vehicle of one stock location, following the cursor.

async_iter_warehouse_statuses(query: Query | None = None) → AsyncIterator[WarehouseStatus]

Yield every warehouse status, following the cursor across pages.

async async_list_accessories(query: Query | None = None) → RentmanPage[Accessory]

Fetch one page of accessories.

async async_list_accessories_of_equipment(equipment_id: int, query: Query | None = None) → RentmanPage[Accessory]

Fetch one page of accessories of one material.

async async_list_actual_content(query: Query | None = None) → RentmanPage[ActualContent]

Fetch one page of recorded combination contents.

async async_list_actual_content_of_serial_number(serial_number_id: int, query: Query | None = None) → RentmanPage[ActualContent]

Fetch one page of contents recorded inside one combination serial.

async async_list_alternatives(query: Query | None = None) → RentmanPage[Alternative]

Fetch one page of alternatives.

async async_list_alternatives_of_equipment(equipment_id: int, query: Query | None = None) → RentmanPage[Alternative]

Fetch one page of alternatives of one material.

async async_list_appointment_crew(query: Query | None = None) → RentmanPage[AppointmentCrew]

Fetch one page of appointment crew attachments.

async async_list_appointment_crew_of_appointment(appointment_id: int, query: Query | None = None) → RentmanPage[AppointmentCrew]

Fetch one page of crew attached to one appointment.

async async_list_appointments(query: Query | None = None) → RentmanPage[Appointment]

Fetch one page of appointments.

async async_list_appointments_of_crew(crew_id: int, query: Query | None = None) → RentmanPage[Appointment]

Fetch one page of appointments of one crew member.

async async_list_contact_persons(query: Query | None = None) → RentmanPage[ContactPerson]

Fetch one page of contact persons.

async async_list_contact_persons_of_contact(contact_id: int, query: Query | None = None) → RentmanPage[ContactPerson]

Fetch one page of contact persons of one contact.

async async_list_contacts(query: Query | None = None) → RentmanPage[Contact]

Fetch one page of contacts.

async async_list_contracts(query: Query | None = None) → RentmanPage[Contract]

Fetch one page of contracts.

async async_list_contracts_of_project(project_id: int, query: Query | None = None) → RentmanPage[Contract]

Fetch one page of contracts of one project.

async async_list_crew(query: Query | None = None) → RentmanPage[Crew]

Fetch one page of crew members.

async async_list_crew_availability(query: Query | None = None) → RentmanPage[CrewAvailability]

Fetch one page of availability windows.

async async_list_crew_availability_of_crew(crew_id: int, query: Query | None = None) → RentmanPage[CrewAvailability]

Fetch one page of availability windows of one crew member.

async async_list_crew_rates(query: Query | None = None) → RentmanPage[CrewRate]

Fetch one page of crew rates.

async async_list_crew_rates_of_crew(crew_id: int, query: Query | None = None) → RentmanPage[CrewRate]

Fetch one page of rates of one crew member.

async async_list_equipment(query: Query | None = None) → RentmanPage[Equipment]

Fetch one page of materials.

async async_list_equipment_assigned_serials(query: Query | None = None) → RentmanPage[EquipmentAssignedSerial]

Fetch one page of serial numbers assigned to combinations.

async async_list_equipment_assigned_serials_of_serial_number(serial_number_id: int, query: Query | None = None) → RentmanPage[EquipmentAssignedSerial]

Fetch one page of assignments recorded inside one combination serial.

async async_list_equipment_set_content(query: Query | None = None) → RentmanPage[EquipmentSetContent]

Fetch one page of equipment set contents.

async async_list_equipment_set_content_of_equipment(equipment_id: int, query: Query | None = None) → RentmanPage[EquipmentSetContent]

Fetch one page of set contents of one combination material.

async async_list_extra_input_fields(query: Query | None = None) → RentmanPage[ExtraInputField]

Fetch one page of custom field definitions.

async async_list_factor_groups(query: Query | None = None) → RentmanPage[FactorGroup]

Fetch one page of factor groups.

async async_list_factors(query: Query | None = None) → RentmanPage[Factor]

Fetch one page of factors.

async async_list_factors_of_factor_group(factor_group_id: int, query: Query | None = None) → RentmanPage[Factor]

Fetch one page of factors of one factor group.

async async_list_file_folders(query: Query | None = None) → RentmanPage[FileFolder]

Fetch one page of file folders.

async async_list_file_folders_of_contact(contact_id: int, query: Query | None = None) → RentmanPage[FileFolder]

Fetch one page of file folders of one contact.

async async_list_file_folders_of_contact_person(contact_person_id: int, query: Query | None = None) → RentmanPage[FileFolder]

Fetch one page of file folders of one contact person.

async async_list_file_folders_of_crew(crew_id: int, query: Query | None = None) → RentmanPage[FileFolder]

Fetch one page of file folders of one crew member.

async async_list_file_folders_of_equipment(equipment_id: int, query: Query | None = None) → RentmanPage[FileFolder]

Fetch one page of file folders of one material.

async async_list_file_folders_of_project(project_id: int, query: Query | None = None) → RentmanPage[FileFolder]

Fetch one page of file folders of one project.

async async_list_file_folders_of_purchase_order(purchase_order_id: int, query: Query | None = None) → RentmanPage[FileFolder]

Fetch one page of file folders of one purchase order.

async async_list_file_folders_of_repair(repair_id: int, query: Query | None = None) → RentmanPage[FileFolder]

Fetch one page of file folders of one repair.

async async_list_file_folders_of_serial_number(serial_number_id: int, query: Query | None = None) → RentmanPage[FileFolder]

Fetch one page of file folders of one serial number.

async async_list_file_folders_of_subproject(subproject_id: int, query: Query | None = None) → RentmanPage[FileFolder]

Fetch one page of file folders of one subproject.

async async_list_file_folders_of_subrental(subrental_id: int, query: Query | None = None) → RentmanPage[FileFolder]

Fetch one page of file folders of one subrental.

async async_list_file_folders_of_supplier(supplier_id: int, query: Query | None = None) → RentmanPage[FileFolder]

Fetch one page of file folders of one supplier.

async async_list_file_folders_of_task(task_id: int, query: Query | None = None) → RentmanPage[FileFolder]

Fetch one page of file folders of one task.

async async_list_file_folders_of_vehicle(vehicle_id: int, query: Query | None = None) → RentmanPage[FileFolder]

Fetch one page of file folders of one vehicle.

async async_list_files(query: Query | None = None) → RentmanPage[File]

Fetch one page of files.

async async_list_files_of_contact(contact_id: int, query: Query | None = None) → RentmanPage[File]

Fetch one page of files of one contact.

async async_list_files_of_contact_person(contact_person_id: int, query: Query | None = None) → RentmanPage[File]

Fetch one page of files of one contact person.

async async_list_files_of_contract(contract_id: int, query: Query | None = None) → RentmanPage[File]

Fetch one page of files of one contract.

async async_list_files_of_crew(crew_id: int, query: Query | None = None) → RentmanPage[File]

Fetch one page of files of one crew member.

async async_list_files_of_equipment(equipment_id: int, query: Query | None = None) → RentmanPage[File]

Fetch one page of files of one material.

async async_list_files_of_invoice(invoice_id: int, query: Query | None = None) → RentmanPage[File]

Fetch one page of files of one invoice.

async async_list_files_of_project(project_id: int, query: Query | None = None) → RentmanPage[File]

Fetch one page of files of one project.

async async_list_files_of_purchase_order(purchase_order_id: int, query: Query | None = None) → RentmanPage[File]

Fetch one page of files of one purchase order.

async async_list_files_of_quote(quote_id: int, query: Query | None = None) → RentmanPage[File]

Fetch one page of files of one quote.

async async_list_files_of_repair(repair_id: int, query: Query | None = None) → RentmanPage[File]

Fetch one page of files of one repair.

async async_list_files_of_serial_number(serial_number_id: int, query: Query | None = None) → RentmanPage[File]

Fetch one page of files of one serial number.

async async_list_files_of_subrental(subrental_id: int, query: Query | None = None) → RentmanPage[File]

Fetch one page of files of one subrental.

async async_list_files_of_supplier(supplier_id: int, query: Query | None = None) → RentmanPage[File]

Fetch one page of files of one supplier.

async async_list_files_of_task(task_id: int, query: Query | None = None) → RentmanPage[File]

Fetch one page of files of one task.

async async_list_files_of_time_registration(time_registration_id: int, query: Query | None = None) → RentmanPage[File]

Fetch one page of files of one time registration.

async async_list_files_of_vehicle(vehicle_id: int, query: Query | None = None) → RentmanPage[File]

Fetch one page of files of one vehicle.

async async_list_folders(query: Query | None = None) → RentmanPage[Folder]

Fetch one page of folders.

async async_list_invitations(query: Query | None = None) → RentmanPage[Invitation]

Fetch one page of planning invitations.

async async_list_invitations_of_crew(crew_id: int, query: Query | None = None) → RentmanPage[Invitation]

Fetch one page of invitations of one crew member.

async async_list_invoice_lines(query: Query | None = None) → RentmanPage[InvoiceLine]

Fetch one page of invoice lines.

async async_list_invoice_lines_of_contract(contract_id: int, query: Query | None = None) → RentmanPage[InvoiceLine]

Fetch one page of invoice lines of one contract.

async async_list_invoice_lines_of_invoice(invoice_id: int, query: Query | None = None) → RentmanPage[InvoiceLine]

Fetch one page of invoice lines of one invoice.

async async_list_invoice_lines_of_purchase_order(purchase_order_id: int, query: Query | None = None) → RentmanPage[InvoiceLine]

Fetch one page of invoice lines of one purchase order.

async async_list_invoice_lines_of_quote(quote_id: int, query: Query | None = None) → RentmanPage[InvoiceLine]

Fetch one page of invoice lines of one quote.

async async_list_invoices(query: Query | None = None) → RentmanPage[Invoice]

Fetch one page of invoices.

async async_list_leave_mutations(query: Query | None = None) → RentmanPage[LeaveMutation]

Fetch one page of leave balance mutations.

async async_list_leave_requests(query: Query | None = None) → RentmanPage[LeaveRequest]

Fetch one page of leave requests.

async async_list_leave_types(query: Query | None = None) → RentmanPage[LeaveType]

Fetch one page of leave types.

async async_list_ledger_codes(query: Query | None = None) → RentmanPage[LedgerCode]

Fetch one page of ledger codes.

async async_list_payments(query: Query | None = None) → RentmanPage[Payment]

Fetch one page of payments.

async async_list_payments_of_invoice(invoice_id: int, query: Query | None = None) → RentmanPage[Payment]

Fetch one page of payments of one invoice.

async async_list_project_costs(query: Query | None = None) → RentmanPage[ProjectCost]

Fetch one page of project cost lines.

async async_list_project_costs_of_project(project_id: int, query: Query | None = None) → RentmanPage[ProjectCost]

Fetch one page of cost lines of one project.

async async_list_project_crew(query: Query | None = None) → RentmanPage[ProjectCrew]

Fetch one page of planned crew.

async async_list_project_crew_of_project(project_id: int, query: Query | None = None) → RentmanPage[ProjectCrew]

Fetch one page of planned crew of one project.

async async_list_project_crew_of_project_function(function_id: int, query: Query | None = None) → RentmanPage[ProjectCrew]

Fetch one page of crew planned on one function.

async async_list_project_crew_of_subproject(subproject_id: int, query: Query | None = None) → RentmanPage[ProjectCrew]

Fetch one page of planned crew of one subproject.

async async_list_project_equipment(query: Query | None = None) → RentmanPage[ProjectEquipment]

Fetch one page of planned equipment lines.

async async_list_project_equipment_groups(query: Query | None = None) → RentmanPage[ProjectEquipmentGroup]

Fetch one page of project equipment groups.

async async_list_project_equipment_groups_of_project(project_id: int, query: Query | None = None) → RentmanPage[ProjectEquipmentGroup]

Fetch one page of equipment groups of one project.

async async_list_project_equipment_groups_of_subproject(subproject_id: int, query: Query | None = None) → RentmanPage[ProjectEquipmentGroup]

Fetch one page of equipment groups of one subproject.

async async_list_project_equipment_of_project(project_id: int, query: Query | None = None) → RentmanPage[ProjectEquipment]

Fetch one page of planned equipment lines of one project.

async async_list_project_equipment_of_project_equipment_group(group_id: int, query: Query | None = None) → RentmanPage[ProjectEquipment]

Fetch one page of planned equipment of one equipment group.

async async_list_project_equipment_of_subproject(subproject_id: int, query: Query | None = None) → RentmanPage[ProjectEquipment]

Fetch one page of planned equipment lines of one subproject.

async async_list_project_function_groups(query: Query | None = None) → RentmanPage[ProjectFunctionGroup]

Fetch one page of project function groups.

async async_list_project_function_groups_of_project(project_id: int, query: Query | None = None) → RentmanPage[ProjectFunctionGroup]

Fetch one page of function groups of one project.

async async_list_project_function_groups_of_subproject(subproject_id: int, query: Query | None = None) → RentmanPage[ProjectFunctionGroup]

Fetch one page of function groups of one subproject.

async async_list_project_functions(query: Query | None = None) → RentmanPage[ProjectFunction]

Fetch one page of project functions.

async async_list_project_functions_of_project(project_id: int, query: Query | None = None) → RentmanPage[ProjectFunction]

Fetch one page of functions of one project.

async async_list_project_functions_of_project_function_group(group_id: int, query: Query | None = None) → RentmanPage[ProjectFunction]

Fetch one page of functions of one function group.

async async_list_project_request_equipment(query: Query | None = None) → RentmanPage[ProjectRequestEquipment]

Fetch one page of requested equipment lines.

async async_list_project_request_equipment_of_project_request(project_request_id: int, query: Query | None = None) → RentmanPage[ProjectRequestEquipment]

Fetch one page of requested equipment of one project request.

async async_list_project_requests(query: Query | None = None) → RentmanPage[ProjectRequest]

Fetch one page of project requests.

async async_list_project_statuses(query: Query | None = None) → RentmanPage[ProjectStatus]

Fetch one page of project statuses.

async async_list_project_types(query: Query | None = None) → RentmanPage[ProjectType]

Fetch one page of project types.

async async_list_project_vehicles(query: Query | None = None) → RentmanPage[ProjectVehicle]

Fetch one page of planned vehicles.

async async_list_project_vehicles_of_project(project_id: int, query: Query | None = None) → RentmanPage[ProjectVehicle]

Fetch one page of planned vehicles of one project.

async async_list_project_vehicles_of_project_function(function_id: int, query: Query | None = None) → RentmanPage[ProjectVehicle]

Fetch one page of vehicles planned on one function.

async async_list_project_vehicles_of_subproject(subproject_id: int, query: Query | None = None) → RentmanPage[ProjectVehicle]

Fetch one page of planned vehicles of one subproject.

async async_list_projects(query: Query | None = None) → RentmanPage[Project]

Fetch one page of projects.

async async_list_purchase_order_costs(query: Query | None = None) → RentmanPage[PurchaseOrderCost]

Fetch one page of purchase order cost lines.

async async_list_purchase_order_costs_of_purchase_order(purchase_order_id: int, query: Query | None = None) → RentmanPage[PurchaseOrderCost]

Fetch one page of cost lines of one purchase order.

async async_list_purchase_order_global_costs(query: Query | None = None) → RentmanPage[PurchaseOrderGlobalCost]

Fetch one page of purchase order global cost lines.

async async_list_purchase_order_global_costs_of_purchase_order(purchase_order_id: int, query: Query | None = None) → RentmanPage[PurchaseOrderGlobalCost]

Fetch one page of global cost lines of one purchase order.

async async_list_purchase_orders(query: Query | None = None) → RentmanPage[PurchaseOrder]

Fetch one page of purchase orders.

async async_list_quotes(query: Query | None = None) → RentmanPage[Quote]

Fetch one page of quotes.

async async_list_quotes_of_project(project_id: int, query: Query | None = None) → RentmanPage[Quote]

Fetch one page of quotes of one project.

async async_list_rate_factors(query: Query | None = None) → RentmanPage[RateFactor]

Fetch one page of rate factors.

async async_list_rate_factors_of_rate(rate_id: int, query: Query | None = None) → RentmanPage[RateFactor]

Fetch one page of rate factors of one rate.

async async_list_rates(query: Query | None = None) → RentmanPage[Rate]

Fetch one page of rates.

async async_list_repairs(query: Query | None = None) → RentmanPage[Repair]

Fetch one page of repairs.

async async_list_repairs_of_equipment(equipment_id: int, query: Query | None = None) → RentmanPage[Repair]

Fetch one page of repairs of one material.

async async_list_serial_numbers(query: Query | None = None) → RentmanPage[SerialNumber]

Fetch one page of serial numbers.

async async_list_serial_numbers_of_equipment(equipment_id: int, query: Query | None = None) → RentmanPage[SerialNumber]

Fetch one page of serial numbers of one material.

async async_list_statuses(query: Query | None = None) → RentmanPage[Status]

Fetch one page of planning statuses.

async async_list_stock_locations(query: Query | None = None) → RentmanPage[StockLocation]

Fetch one page of stock locations.

async async_list_stock_movements(query: Query | None = None) → RentmanPage[StockMovement]

Fetch one page of stock movements.

async async_list_stock_movements_of_equipment(equipment_id: int, query: Query | None = None) → RentmanPage[StockMovement]

Fetch one page of stock movements of one material.

async async_list_subprojects(query: Query | None = None) → RentmanPage[Subproject]

Fetch one page of subprojects.

async async_list_subprojects_of_project(project_id: int, query: Query | None = None) → RentmanPage[Subproject]

Fetch one page of subprojects of one project.

async async_list_subrental_equipment(query: Query | None = None) → RentmanPage[SubrentalEquipment]

Fetch one page of subrental equipment lines.

async async_list_subrental_equipment_groups(query: Query | None = None) → RentmanPage[SubrentalEquipmentGroup]

Fetch one page of subrental equipment groups.

async async_list_subrental_equipment_groups_of_subrental(subrental_id: int, query: Query | None = None) → RentmanPage[SubrentalEquipmentGroup]

Fetch one page of equipment groups of one subrental.

async async_list_subrental_equipment_of_subrental(subrental_id: int, query: Query | None = None) → RentmanPage[SubrentalEquipment]

Fetch one page of equipment of one subrental.

async async_list_subrental_equipment_of_subrental_equipment_group(group_id: int, query: Query | None = None) → RentmanPage[SubrentalEquipment]

Fetch one page of equipment of one subrental equipment group.

async async_list_subrentals(query: Query | None = None) → RentmanPage[Subrental]

Fetch one page of subrentals.

async async_list_subtasks(query: Query | None = None) → RentmanPage[Subtask]

Fetch one page of subtasks.

async async_list_subtasks_of_task(task_id: int, query: Query | None = None) → RentmanPage[Subtask]

Fetch one page of subtasks of one task.

async async_list_suppliers(query: Query | None = None) → RentmanPage[Supplier]

Fetch one page of suppliers.

async async_list_suppliers_of_equipment(equipment_id: int, query: Query | None = None) → RentmanPage[Supplier]

Fetch one page of suppliers of one material.

async async_list_task_assignments(query: Query | None = None) → RentmanPage[TaskAssignment]

Fetch one page of task assignments.

async async_list_task_assignments_of_task(task_id: int, query: Query | None = None) → RentmanPage[TaskAssignment]

Fetch one page of task assignments of one task.

async async_list_task_statuses(query: Query | None = None) → RentmanPage[TaskStatus]

Fetch one page of task statuses.

async async_list_tasks(query: Query | None = None) → RentmanPage[Task]

Fetch one page of tasks.

async async_list_tasks_of_contact(contact_id: int, query: Query | None = None) → RentmanPage[Task]

Fetch one page of tasks of one contact.

async async_list_tasks_of_contact_person(contact_person_id: int, query: Query | None = None) → RentmanPage[Task]

Fetch one page of tasks of one contact person.

async async_list_tasks_of_contract(contract_id: int, query: Query | None = None) → RentmanPage[Task]

Fetch one page of tasks of one contract.

async async_list_tasks_of_crew(crew_id: int, query: Query | None = None) → RentmanPage[Task]

Fetch one page of tasks of one crew member.

async async_list_tasks_of_equipment(equipment_id: int, query: Query | None = None) → RentmanPage[Task]

Fetch one page of tasks of one material.

async async_list_tasks_of_invoice(invoice_id: int, query: Query | None = None) → RentmanPage[Task]

Fetch one page of tasks of one invoice.

async async_list_tasks_of_project(project_id: int, query: Query | None = None) → RentmanPage[Task]

Fetch one page of tasks of one project.

async async_list_tasks_of_purchase_order(purchase_order_id: int, query: Query | None = None) → RentmanPage[Task]

Fetch one page of tasks of one purchase order.

async async_list_tasks_of_quote(quote_id: int, query: Query | None = None) → RentmanPage[Task]

Fetch one page of tasks of one quote.

async async_list_tasks_of_repair(repair_id: int, query: Query | None = None) → RentmanPage[Task]

Fetch one page of tasks of one repair.

async async_list_tasks_of_serial_number(serial_number_id: int, query: Query | None = None) → RentmanPage[Task]

Fetch one page of tasks of one serial number.

async async_list_tasks_of_subrental(subrental_id: int, query: Query | None = None) → RentmanPage[Task]

Fetch one page of tasks of one subrental.

async async_list_tasks_of_supplier(supplier_id: int, query: Query | None = None) → RentmanPage[Task]

Fetch one page of tasks of one supplier.

async async_list_tasks_of_vehicle(vehicle_id: int, query: Query | None = None) → RentmanPage[Task]

Fetch one page of tasks of one vehicle.

async async_list_tax_classes(query: Query | None = None) → RentmanPage[TaxClass]

Fetch one page of tax classes.

async async_list_time_registration_activities(query: Query | None = None) → RentmanPage[TimeRegistrationActivity]

Fetch one page of time registration activities.

async async_list_time_registration_activities_of_time_registration(time_registration_id: int, query: Query | None = None) → RentmanPage[TimeRegistrationActivity]

Fetch one page of activities of one time registration.

async async_list_time_registrations(query: Query | None = None) → RentmanPage[TimeRegistration]

Fetch one page of time registrations.

async async_list_time_registrations_of_leave_request(leave_request_id: int, query: Query | None = None) → RentmanPage[TimeRegistration]

Fetch one page of time registrations of one leave request.

async async_list_vehicles(query: Query | None = None) → RentmanPage[Vehicle]

Fetch one page of vehicles.

async async_list_vehicles_of_stock_location(stock_location_id: int, query: Query | None = None) → RentmanPage[Vehicle]

Fetch one page of vehicles of one stock location.

async async_list_warehouse_statuses(query: Query | None = None) → RentmanPage[WarehouseStatus]

Fetch one page of warehouse statuses.

async async_update_accessory(accessory_id: int, payload: AccessoryPayload) → Accessory | None

Update one accessory by its id.

async async_update_alternative(alternative_id: int, payload: AlternativePayload) → Alternative | None

Update one alternative by its id.

async async_update_appointment(appointment_id: int, payload: AppointmentPayload) → Appointment | None

Update one appointment by its id.

async async_update_appointment_crew(appointment_crew_id: int, payload: AppointmentCrewPayload) → AppointmentCrew | None

Update one appointment crew by its id.

async async_update_contact(contact_id: int, payload: ContactPayload) → Contact | None

Update one contact by its id.

async async_update_contact_person(contact_person_id: int, payload: ContactPersonPayload) → ContactPerson | None

Update one contact person by its id.

async async_update_crew_availability(crew_availability_id: int, payload: CrewAvailabilityPayload) → CrewAvailability | None

Update one crew availability by its id.

async async_update_equipment(equipment_id: int, payload: EquipmentPayload) → Equipment | None

Update one equipment by its id.

async async_update_equipment_set_content(equipment_set_content_id: int, payload: EquipmentSetContentPayload) → EquipmentSetContent | None

Update one equipment set content by its id.

async async_update_folder(folder_id: int, payload: FolderPayload) → Folder | None

Update one folder by its id.

async async_update_leave_request(leave_request_id: int, payload: LeaveRequestPayload) → LeaveRequest | None

Update one leave request by its id.

async async_update_payment(payment_id: int, payload: PaymentPayload) → Payment | None

Update one payment by its id.

async async_update_project_cost(project_cost_id: int, payload: ProjectCostPayload) → ProjectCost | None

Update one project cost by its id.

async async_update_project_request(project_request_id: int, payload: ProjectRequestPayload) → ProjectRequest | None

Update one project request by its id.

async async_update_project_request_equipment(project_request_equipment_id: int, payload: ProjectRequestEquipmentPayload) → ProjectRequestEquipment | None

Update one project request equipment by its id.

async async_update_serial_number(serial_number_id: int, payload: SerialNumberPayload) → SerialNumber | None

Update one serial number by its id.

async async_update_stock_movement(stock_movement_id: int, payload: StockMovementPayload) → StockMovement | None

Update one stock movement by its id.

async async_update_subtask(subtask_id: int, payload: SubtaskPayload) → Subtask | None

Update one subtask by its id.

async async_update_supplier(supplier_id: int, payload: SupplierPayload) → Supplier | None

Update one supplier by its id.

async async_update_task(task_id: int, payload: TaskPayload) → Task | None

Update one task by its id.

async async_update_task_assignment(task_assignment_id: int, payload: TaskAssignmentPayload) → TaskAssignment | None

Update one task assignment by its id.

async async_update_task_status(task_status_id: int, payload: TaskStatusPayload) → TaskStatus | None

Update one task status by its id.

async async_update_time_registration(time_registration_id: int, payload: TimeRegistrationPayload) → TimeRegistration | None

Update one time registration by its id.

async async_update_vehicle(vehicle_id: int, payload: VehiclePayload) → Vehicle | None

Update one vehicle by its id.

Query

The typed query object for collection requests.

class aiorentman.query.Filter(field: str, operator: FilterOperator = FilterOperator.EQUALS, value: FilterValue = '')

One field filter: a field, an operator, and the value to compare with.

param() → tuple[str, str]

Render the filter as one query parameter key and value.

class aiorentman.query.FilterOperator(*values)

The relational operators the Rentman API accepts in filter keys.

class aiorentman.query.Query(fields: tuple[str, ...] = (), sort: tuple[Sort, ...] = (), expand: tuple[str, ...] = (), filters: tuple[Filter, ...] = (), limit: int | None = None, offset: int | None = None)

Fields, sorting, filters, expansion, and paging for one collection request.

Field, sort, and expand names are the schema property names of the resource being requested, including custom_<number> names. Filters reject the reserved query parameter names, and filters and sorts reject the generated fields qrcodes, tags, and qrcodes_of_serial_numbers. Other generated fields pass through unchecked. limit must be between 1 and 1500 and offset must not be negative. Every violation raises ValueError.

params() → dict[str, str]

Render the query as the query parameters the API expects.

class aiorentman.query.Sort(field: str, ascending: bool = True)

One sort field with its direction.

param() → str

Render the sort field with its direction prefix.

aiorentman.query.eq(field: str, value: FilterValue) → Filter

Filter on field equal to value.

aiorentman.query.gt(field: str, value: FilterValue) → Filter

Filter on field greater than value.

aiorentman.query.gte(field: str, value: FilterValue) → Filter

Filter on field greater than or equal to value.

aiorentman.query.is_null(field: str, *, value: bool = True) → Filter

Filter on field being null or, with value False, not null.

aiorentman.query.lt(field: str, value: FilterValue) → Filter

Filter on field less than value.

aiorentman.query.lte(field: str, value: FilterValue) → Filter

Filter on field less than or equal to value.

aiorentman.query.neq(field: str, value: FilterValue) → Filter

Filter on field not equal to value.

Models

class aiorentman.RentmanPage(items: tuple[ModelT, ...], item_count: int, limit: int, offset: int, next_page_url: str | None)

One page of a collection: the parsed items and the paging metadata.

The parser drops items without a usable id, and logs each one at debug level on the aiorentman.parsers logger. item_count is the count the API reported, so it can be higher than len(items).

class aiorentman.RentmanLink(path: str)

A reference to another resource, given as its API path.

Linked fields hold a path string such as /equipment/12 unless the request expanded them, in which case the parser returns the full typed model when the field annotation names one. An expanded object without a usable id, or on a field annotated as RentmanLink only, parses to None on an optional link and to an empty link on a required one.

property id: int | None

The numeric id at the end of the path, or None when absent.

class aiorentman.Equipment(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, folder: RentmanLink | Folder | None, code: str, factor_group: RentmanLink | None, name: str, internal_remark: str, external_remark: str, unit: str, in_shop: bool, surface_article: bool, shop_description_short: str, shop_description_long: str, shop_seo_title: str, shop_seo_keyword: str, shop_seo_description: str, shop_featured: bool, price: float | None, subrental_costs: float | None, critical_stock_level: int | None, type: str, rental_sales: str, temporary: bool, in_planner: bool, in_archive: bool, stock_management: str, taxclass: RentmanLink | None, list_price: float | None, volume: float | None, packed_per: int | None, height: float | None, width: float | None, length: float | None, weight: float | None, empty_weight: float | None, power: float | None, current: float | None, country_of_origin: str, image: RentmanLink | None, ledger: RentmanLink | None, ledger_debit: RentmanLink | None, defaultgroup: str, is_combination: bool, is_physical: str, can_edit_content_during_planning: bool, strict_container_content: str, qrcodes: tuple[str, ...], qrcodes_of_serial_numbers: tuple[str, ...], tags: tuple[str, ...], current_quantity_excl_cases: int | None, current_quantity: int | None, quantity_in_cases: int | None, location_in_warehouse: str, custom: dict[str, Any], raw: dict[str, Any] | None = None)

One material: a rental or sales item tracked in inventory.

class aiorentman.SerialNumber(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, equipment: RentmanLink | Equipment, serial: str, purchasedate: datetime | None, depreciation_monthly: float | None, book_value: float | None, residual_value: float | None, purchase_costs: float | None, active: bool, remark: str, ref: str, asset_location: RentmanLink | StockLocation | None, image: RentmanLink | None, current_book_value: float | None, next_inspection: datetime | None, qrcodes: tuple[str, ...], tags: tuple[str, ...], last_subproject: RentmanLink | Subproject | None, sealed: bool, custom: dict[str, Any], raw: dict[str, Any] | None = None)

One serialized unit of a material, the unit an RFID tag links to.

class aiorentman.EquipmentAssignedSerial(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, combination: RentmanLink | SerialNumber, serialnumber: RentmanLink | SerialNumber, raw: dict[str, Any] | None = None)

One serial number placed inside a serialized combination.

class aiorentman.ActualContent(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, equipment: RentmanLink | Equipment | None, serial: RentmanLink | SerialNumber | None, quantity: str, combination_serial: RentmanLink | SerialNumber | None, raw: dict[str, Any] | None = None)

One equipment item physically recorded inside a combination serial.

class aiorentman.EquipmentSetContent(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, quantity: str, parent_equipment: RentmanLink | Equipment, order: str, equipment: RentmanLink | Equipment, is_fixed: str, is_physically_connected: str, raw: dict[str, Any] | None = None)

One equipment line inside an equipment set combination.

class aiorentman.Folder(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, parent: RentmanLink | Folder | None, name: str, order: str, itemtype: str, path: str, raw: dict[str, Any] | None = None)

One folder that groups equipment items in the inventory tree.

class aiorentman.StockLocation(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, name: str, city: str, street: str, house_number: str, postal_code: str, state_province: str, country: str, active: bool, type: str, color: str, in_archive: bool, raw: dict[str, Any] | None = None)

One warehouse or storage location where stock is kept.

class aiorentman.WarehouseStatus(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, name: str, raw: dict[str, Any] | None = None)

One warehouse status that equipment can be booked to.

class aiorentman.Status(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, name: str, raw: dict[str, Any] | None = None)

One planning status that a subproject can carry.

class aiorentman.StockMovement(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, amount: int | None, equipment: RentmanLink | Equipment, projectequipment: RentmanLink | ProjectEquipment | None, description: str, details: str, date: datetime | None, type: str, stock_location: RentmanLink | StockLocation, api_client: str, raw: dict[str, Any] | None = None)

One recorded change of stock for a material.

class aiorentman.Repair(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, internal_name: str, equipment: RentmanLink | Equipment, serialnumber: RentmanLink | SerialNumber | None, reporter: RentmanLink | None, assignee: RentmanLink | None, external_repairer: RentmanLink | None, number: str, repairperiod_start: datetime | None, repairperiod_end: datetime | None, amount: int | None, remark: str, repair_costs: float | None, is_usable: str, costs_charged_to_customer: RentmanLink | None, subproject: RentmanLink | Subproject | None, stock_location: RentmanLink | StockLocation | None, repair_status: str, unrepairable_of: RentmanLink | Repair | None, tags: tuple[str, ...], custom: dict[str, Any], raw: dict[str, Any] | None = None)

One repair of a material or of one of its serial numbers.

class aiorentman.Project(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, location: RentmanLink | None, refundabledeposit: float | None, deposit_status: str, customer: RentmanLink | None, loc_contact: RentmanLink | None, cust_contact: RentmanLink | None, project_type: RentmanLink | None, name: str, reference: str, number: str, account_manager: RentmanLink | None, color: str, conditions: str, project_total_price: float | None, project_total_price_cancelled: float | None, project_rental_price: float | None, project_sale_price: float | None, project_crew_price: float | None, project_transport_price: float | None, project_other_price: float | None, project_insurance_price: float | None, project_services_price: float | None, estimated_cost: float | None, planned_cost: float | None, actual_cost: float | None, already_invoiced: float | None, tags: tuple[str, ...], usageperiod_start: datetime | None, usageperiod_end: datetime | None, planperiod_start: datetime | None, planperiod_end: datetime | None, weight: float | None, power: float | None, current: float | None, equipment_period_from: datetime | None, equipment_period_to: datetime | None, purchasecosts: float | None, volume: float | None, custom: dict[str, Any], raw: dict[str, Any] | None = None)

One project that plans materials, crew, and transport.

class aiorentman.Subproject(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, project: RentmanLink | Project, order: str, name: str, status: RentmanLink | Status, is_template: bool, location: RentmanLink | None, loc_contact: RentmanLink | None, insurance_rate: float | None, discount_rental: float | None, discount_sale: float | None, discount_crew: float | None, discount_transport: float | None, discount_additional_costs: float | None, discount_services: float | None, discount_subproject: float | None, discount_fixed: bool, discount_fixed_amount: float | None, fixed_price: bool, in_planning: bool, in_financial: bool, asset_location_from: RentmanLink | StockLocation | None, project_total_price: float | None, project_total_price_cancelled: float | None, project_rental_price: float | None, project_sale_price: float | None, project_crew_price: float | None, project_transport_price: float | None, project_other_price: float | None, project_insurance_price: float | None, project_services_price: float | None, estimated_cost: float | None, planned_cost: float | None, actual_cost: float | None, already_invoiced: float | None, usageperiod_start: datetime | None, usageperiod_end: datetime | None, planperiod_start: datetime | None, planperiod_end: datetime | None, weight: float | None, power: float | None, current: float | None, purchasecosts: float | None, volume: float | None, equipment_period_from: datetime | None, equipment_period_to: datetime | None, custom: dict[str, Any], raw: dict[str, Any] | None = None)

One subproject inside a project, carrying its own planning period.

class aiorentman.ProjectEquipment(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, equipment: RentmanLink | Equipment | None, parent: RentmanLink | ProjectEquipment | None, ledger: RentmanLink | None, ledger_debit: RentmanLink | None, quantity: str, quantity_total: int | None, equipment_group: RentmanLink | None, discount: float | None, is_option: bool, factor: str, order: str, unit_price: float | None, name: str, external_remark: str, internal_remark: str, delay_notified: bool, duration: float | None, is_delayed: bool, planperiod_start: datetime | None, planperiod_end: datetime | None, usageperiod_start: datetime | None, usageperiod_end: datetime | None, has_missings: bool, warehouse_reservations: int | None, subrent_reservations: int | None, serial_number_ids: str, custom: dict[str, Any], raw: dict[str, Any] | None = None)

One planned equipment line on a project or subproject.

class aiorentman.Accessory(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, parent_equipment: RentmanLink | Equipment, equipment: RentmanLink | Equipment | None, quantity: int | None, automatic: bool, skip: bool, is_free: bool, order: str, add_as_new_line: bool, raw: dict[str, Any] | None = None)

One material that planning adds together with its parent material.

class aiorentman.Alternative(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, equipment: RentmanLink | Equipment, alternative: RentmanLink | Equipment, raw: dict[str, Any] | None = None)

One material that can replace another material during planning.

class aiorentman.Supplier(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, equipment: RentmanLink | Equipment, contact: RentmanLink | None, contactperson: RentmanLink | None, price: float | None, details: str, raw: dict[str, Any] | None = None)

One purchase source of a material, priced through its contact.

class aiorentman.Vehicle(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, folder: RentmanLink | Folder | None, name: str, cost_rate: RentmanLink | None, in_planner: bool, height: float | None, length: float | None, width: float | None, seats: int | None, inspection_date: datetime | None, licenseplate: str, remark: str, payload_capacity: float | None, surface_area: str, multiple: str, image: RentmanLink | None, asset_location: RentmanLink | StockLocation | None, tags: tuple[str, ...], distance_cost: float | None, fixed_cost: float | None, custom: dict[str, Any], raw: dict[str, Any] | None = None)

One vehicle that planning books for transport.

class aiorentman.ExtraInputField(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, name: str, itemtype: str, linkedItemType: str, parent: RentmanLink | ExtraInputField | None, type: str, order: str, hidden: bool, classified: bool, search_include: bool, search_minlength: int | None, is_customfield_mandatory: bool, raw: dict[str, Any] | None = None)

One custom field definition attached to one item type.

class aiorentman.ProjectStatus(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, name: str, raw: dict[str, Any] | None = None)

One status that a project can carry in the planning workflow.

class aiorentman.ProjectType(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, name: str, color: str, type: str, raw: dict[str, Any] | None = None)

One project type that groups projects by kind.

class aiorentman.ProjectFunctionGroup(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, name: str, project: RentmanLink | Project, subproject: RentmanLink | Subproject, duration: float | None, planperiod_start_schedule_is_start: str, usageperiod_start_schedule_is_start: str, planperiod_end_schedule_is_start: str, usageperiod_end_schedule_is_start: str, usageperiod_start: datetime | None, usageperiod_end: datetime | None, planperiod_start: datetime | None, planperiod_end: datetime | None, remark: str, raw: dict[str, Any] | None = None)

One group of functions inside a subproject plan.

class aiorentman.ProjectFunction(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, cost_rate: RentmanLink | None, cost_accommodation: float | None, cost_catering: float | None, cost_travel: float | None, cost_other: float | None, price_rate: RentmanLink | None, price_accommodation: float | None, price_catering: float | None, price_travel: float | None, price_other: float | None, project: RentmanLink | Project, subproject: RentmanLink | Subproject, is_template: bool, group: RentmanLink | ProjectFunctionGroup | None, name_external: str, name: str, travel_time_before: float | None, travel_time_after: float | None, use_travel_time_from_location: bool, use_distance_from_location: bool, usageperiod_start: datetime | None, planperiod_start_schedule_is_start: str, usageperiod_start_schedule_is_start: str, planperiod_end_schedule_is_start: str, usageperiod_end_schedule_is_start: str, usageperiod_end: datetime | None, planperiod_start: datetime | None, planperiod_end: datetime | None, type: str, duration: float | None, amount: int | None, break_: float | None, distance: float | None, twoway: bool, taxclass: RentmanLink | None, ledger: RentmanLink | None, ledger_debit: RentmanLink | None, order: str, remark_client: str, remark_planner: str, remark_crew: str, in_financial: bool, in_planning: bool, is_plannable: bool, recurrence_group: int | None, recurrence_enddate: datetime | None, recurrence_interval_unit: str, recurrence_interval: int | None, recurrence_weekdays: str | None, price_fixed: float | None, price_variable: float | None, costs_fixed: float | None, costs_variable: float | None, price_total: float | None, costs_total: float | None, tags: tuple[str, ...], custom: dict[str, Any], raw: dict[str, Any] | None = None)

One planned crew or transport function on a subproject.

class aiorentman.ProjectCrew(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, cost_rate: RentmanLink | None, cost_accommodation: float | None, cost_catering: float | None, cost_travel: float | None, cost_other: float | None, function: RentmanLink | ProjectFunction, crewmember: RentmanLink, visible: bool, planperiod_start: datetime | None, planperiod_end: datetime | None, transport: str, remark: str, remark_planner: str, invoice_reference: str, project_leader: bool, is_visible_on_dashboard: bool, costs: float | None, cost_actual: float | None, hours_registered: float | None, hours_planned: float | None, cost_planned: float | None, diff_cost: float | None, diff_hours: float | None, activity_status: str, custom: dict[str, Any], raw: dict[str, Any] | None = None)

One crew member planned on a project function.

class aiorentman.ProjectVehicle(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, cost_rate: RentmanLink | None, function: RentmanLink | ProjectFunction, transport: str, vehicle: RentmanLink | Vehicle, planningperiod_start: datetime | None, planningperiod_end: datetime | None, remark: str, remark_planner: str, costs: float | None, custom: dict[str, Any], raw: dict[str, Any] | None = None)

One vehicle planned on a project function.

class aiorentman.ProjectEquipmentGroup(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, project: RentmanLink | Project, subproject: RentmanLink | Subproject, additional_scanned: bool, name: str, usageperiod_start: datetime | None, usageperiod_end: datetime | None, duration: float | None, planperiod_start: datetime | None, planperiod_end: datetime | None, is_delayed: bool, order: str, in_price_calculation: bool, remark: str, weight: float | None, power: float | None, current: float | None, volume: float | None, total_new_price: float | None, raw: dict[str, Any] | None = None)

One equipment group inside a subproject plan.

class aiorentman.ProjectCost(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, name: str, remark: str, project: RentmanLink | Project, quantity: int | None, discount: float | None, order: str, subproject: RentmanLink | Subproject, is_template: bool, taxclass: RentmanLink | None, ledger: RentmanLink | None, ledger_debit: RentmanLink | None, sale_price: float | None, purchase_price: float | None, custom: dict[str, Any], raw: dict[str, Any] | None = None)

One additional cost line on a subproject.

class aiorentman.ProjectRequest(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, linked_contact: RentmanLink | None, contact_mailing_number: str, contact_mailing_country: str, contact_name: str, contact_mailing_postalcode: str, contact_phone: str, contact_mailing_city: str, contact_mailing_street: str, linked_contact_person: RentmanLink | None, contact_person_lastname: str, contact_person_email: str, contact_person_middle_name: str, contact_person_first_name: str, usageperiod_end: datetime | None, usageperiod_start: datetime | None, is_paid: bool, language: str, in_: datetime | None, out_: datetime | None, linked_location: RentmanLink | None, location_mailing_number: str, location_mailing_country: str, location_name: str, location_mailing_postalcode: str, location_mailing_city: str, location_mailing_street: str, location_phone: str, name: str, external_reference: int | None, remark: str, planperiod_end: datetime | None, planperiod_start: datetime | None, price: float | None, linked_project: RentmanLink | Project | None, source: str, status: str, raw: dict[str, Any] | None = None)

One equipment request submitted by a customer.

class aiorentman.ProjectRequestEquipment(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, quantity: int | None, quantity_total: int | None, is_comment: bool, is_kit: bool, discount: float | None, linked_equipment: RentmanLink | Equipment | None, name: str, external_remark: str, parent: RentmanLink | ProjectRequestEquipment | None, unit_price: float | None, project_request: RentmanLink | ProjectRequest, factor: str, order: str, raw: dict[str, Any] | None = None)

One equipment line on a project request.

class aiorentman.Quote(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, number: str, customer: RentmanLink | None, contact: RentmanLink | None, date: datetime | None, expiration_date: datetime | None, version: int | None, subject: str, show_tax: bool, project: RentmanLink | Project, filename: str, project_total_price: float | None, project_total_price_cancelled: float | None, project_rental_price: float | None, project_sale_price: float | None, project_crew_price: float | None, project_transport_price: float | None, project_other_price: float | None, project_insurance_price: float | None, project_services_price: float | None, price: float | None, price_invat: float | None, vat_amount: float | None, tags: tuple[str, ...], raw: dict[str, Any] | None = None)

One quotation sent to a customer for a project.

class aiorentman.Contract(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, number: str, customer: RentmanLink | None, contact: RentmanLink | None, date: datetime | None, expiration_date: datetime | None, version: int | None, subject: str, show_tax: bool, project: RentmanLink | Project, filename: str, project_total_price: float | None, project_total_price_cancelled: float | None, project_rental_price: float | None, project_sale_price: float | None, project_crew_price: float | None, project_transport_price: float | None, project_other_price: float | None, project_insurance_price: float | None, project_services_price: float | None, price: float | None, price_invat: float | None, vat_amount: float | None, raw: dict[str, Any] | None = None)

One contract signed with a customer for a project.

class aiorentman.Invoice(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, customer: RentmanLink | None, account_manager: RentmanLink | None, contact: RentmanLink | None, expiration: datetime | None, date: datetime | None, number: str, procent: float | None, from_project: bool, subject: str, finalized: bool, integration_reference_id: str | None, project: RentmanLink | Project | None, filename: str, project_total_price: float | None, project_total_price_cancelled: float | None, project_rental_price: float | None, project_sale_price: float | None, project_crew_price: float | None, project_transport_price: float | None, project_other_price: float | None, project_insurance_price: float | None, project_services_price: float | None, sum_factuurregels: float | None, price: float | None, price_invat: float | None, vat_amount: float | None, invoicetype: str, outstanding_balance: float | None, total_paid: float | None, is_paid: bool, date_sent: datetime | None, payment_reminder_sent: int | None, final_payment_reminder_sent: datetime | None, payment_date: datetime | None, days_after_expiry: int | None, tags: tuple[str, ...], raw: dict[str, Any] | None = None)

One invoice issued for a project.

class aiorentman.InvoiceLine(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, item: int | None, base: float | None, ledger: RentmanLink | LedgerCode, vatrate: float | None, vatamount: float | None, priceincl: float | None, ledgercode: str, parent_api_path: str, raw: dict[str, Any] | None = None)

One VAT line on a quote, contract, or invoice.

class aiorentman.Payment(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, invoice: RentmanLink | Invoice, moment: datetime | None, amount: float | None, description: str, payment_import_source: str, raw: dict[str, Any] | None = None)

One payment recorded against an invoice.

class aiorentman.LedgerCode(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, code: str, is_credit: bool, is_debit: bool, raw: dict[str, Any] | None = None)

One ledger account that financial lines book to.

class aiorentman.TaxClass(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, name: str, code: str, type: str, raw: dict[str, Any] | None = None)

One tax class applied to financial lines.

class aiorentman.Subrental(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, name: str, accountmanager: RentmanLink | None, reference: str, supplier: RentmanLink | None, number: str, contactperson: RentmanLink | None, location: RentmanLink | None, location_contact: RentmanLink | None, usageperiod_start: datetime | None, usageperiod_end: datetime | None, planperiod_start: datetime | None, planperiod_end: datetime | None, delivery_in: datetime | None, delivery_out: datetime | None, equipment_cost: float | None, price: float | None, extra_cost: float | None, auto_update_costs: bool, remark: str, type: str, status: RentmanLink | Status, sent: datetime | None, asset_location_to: RentmanLink | StockLocation | None, asset_location_from: RentmanLink | StockLocation | None, is_internal: bool, supplier_project: RentmanLink | Project | None, tags: tuple[str, ...], custom: dict[str, Any], raw: dict[str, Any] | None = None)

One subrental order placed with an external supplier.

class aiorentman.SubrentalEquipmentGroup(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, subrental: RentmanLink | Subrental, name: str, order: str, supplier_category: RentmanLink | None, raw: dict[str, Any] | None = None)

One equipment group inside a subrental.

class aiorentman.SubrentalEquipment(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, subrental_group: RentmanLink | SubrentalEquipmentGroup, equipment: RentmanLink | Equipment | None, parent: RentmanLink | SubrentalEquipment | None, planperiod_start: datetime | None, planperiod_end: datetime | None, name: str, quantity: int | None, quantity_total: int | None, unit_price: float | None, discount: float | None, factor: str, order: str, remark: str, lineprice: float | None, supplier_planningmateriaal: RentmanLink | None, raw: dict[str, Any] | None = None)

One equipment line inside a subrental.

class aiorentman.PurchaseOrder(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, filename: str, subject: str, owner: RentmanLink, date_of_issue: datetime | None, delivery_date: datetime | None, description: str, number: str, approval_status: str, previous_status: str, approved_amount: float | None, supplier: RentmanLink | None, contact_person: RentmanLink | None, delivery_type: str, delivery_location: RentmanLink | None, delivery_location_person: RentmanLink | None, delivery_warehouse: RentmanLink | StockLocation | None, accounting_code: str, export_status: str, export_date: datetime | None, export_message: str | None, tags: tuple[str, ...], underlying_cost_amount: float | None, underlying_cost_amount_tax: float | None, underlying_cost_amount_with_tax: float | None, approved_by: RentmanLink | None, approved_at: datetime | None, projects_json: str | None, custom: dict[str, Any], raw: dict[str, Any] | None = None)

One purchase order sent to a supplier.

class aiorentman.PurchaseOrderCost(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, purchase_order: RentmanLink | PurchaseOrder, costitem: int | None, costitemtype: str, approved_amount: float | None, project: str, underlying_cost_amount: float | None, underlying_cost_amount_tax: float | None, underlying_cost_amount_with_tax: float | None, quantity: int | None, raw: dict[str, Any] | None = None)

One underlying cost line of a purchase order.

class aiorentman.PurchaseOrderGlobalCost(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, purchase_order: RentmanLink | PurchaseOrder, name: str, unit_purchase_cost: float | None, quantity: int | None, taxclass: RentmanLink | TaxClass | None, raw: dict[str, Any] | None = None)

One global cost line of a purchase order.

class aiorentman.Crew(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, folder: RentmanLink | Folder | None, street: str, housenumber: str, unit_number: str, district: str, city: str, postal_code: str, addressline2: str, extraaddressline: str, state: str, country: str, birthdate: datetime | None, passport_number: str, emergency_contact: str, remark: str, driving_license: str, contract: str, bank: str, contract_date: datetime | None, company_name: str, vat_code: str, coc_code: str, firstname: str, middle_name: str, lastname: str, email: str, phone: str, active: bool, avatar: RentmanLink | None, vt_fullname: str, default_warehouse: RentmanLink | StockLocation | None, external_reference: str, tags: tuple[str, ...], custom: dict[str, Any], raw: dict[str, Any] | None = None)

One crew member registered in the account.

class aiorentman.CrewAvailability(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, last_updater: RentmanLink | None, last_updated: datetime | None, start: datetime | None, end: datetime | None, crewmember: RentmanLink | Crew, status: str, remark: str, recurrence_interval_unit: str, recurrence_enddate: datetime | None, recurrence_interval: int | None, recurrent_group: int | None, recurrence_weekdays: str, raw: dict[str, Any] | None = None)

One availability window registered for one crew member.

class aiorentman.CrewRate(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, naam: str, cost_rate: RentmanLink | None, medewerker: RentmanLink | Crew, raw: dict[str, Any] | None = None)

One cost rate assigned to one crew member.

class aiorentman.Appointment(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, name: str, start: datetime | None, end: datetime | None, color: str, location: str, remark: str, is_public: bool, is_plannable: bool, recurrence_interval_unit: str, recurrence_enddate: datetime | None, recurrence_interval: int | None, recurrence_group: int | None, recurrence_weekdays: str | None, synchronization_id: str, synchronisation_uri: str, raw: dict[str, Any] | None = None)

One calendar appointment in the crew planner.

class aiorentman.AppointmentCrew(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, appointment: RentmanLink | Appointment, crew: RentmanLink | Crew, raw: dict[str, Any] | None = None)

One crew member attached to one appointment.

class aiorentman.Invitation(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, type: str, accepted: bool, responded_timestamp: datetime | None, expiration_date: datetime | None, start: datetime | None, end: datetime | None, function: RentmanLink | None, projectcrew: RentmanLink | None, crewmember: RentmanLink | Crew, remark: str, emailstatus: str, last_reminder: datetime | None, location_details: str | None, auto_reminder_date: datetime | None, auto_reminder_sent: int | None, raw: dict[str, Any] | None = None)

One planning invitation sent to one crew member.

class aiorentman.TimeRegistration(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, crewmember: RentmanLink | Crew | None, start: datetime | None, end: datetime | None, distance: float | None, is_lunch_included: bool, leavetype: RentmanLink | LeaveType | None, leaverequest: RentmanLink | LeaveRequest | None, duration: float | None, break_duration: float | None, travel_time: float | None, correction_duration: float | None, remark: str, status: str, break_duration_with_start_end: float | None, custom: dict[str, Any], raw: dict[str, Any] | None = None)

One worked or leave time registration of one crew member.

class aiorentman.TimeRegistrationActivity(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, time_registration: RentmanLink | TimeRegistration, project_function: RentmanLink | ProjectFunction | None, subproject_function: RentmanLink | ProjectFunction | None, description: str, duration: float | None, is_activity: bool, from_: datetime | None, to: datetime | None, raw: dict[str, Any] | None = None)

One activity line inside one time registration.

class aiorentman.LeaveRequest(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, description: str, approval_status: str, requested_for: RentmanLink | Crew, reviewed_on: datetime | None, reviewer: RentmanLink | None, raw: dict[str, Any] | None = None)

One leave request submitted by one crew member.

class aiorentman.LeaveMutation(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, description: str, duration: float | None, crewmember: RentmanLink | Crew, leavetype: RentmanLink | LeaveType, mutation_date: datetime | None, raw: dict[str, Any] | None = None)

One leave balance mutation for one crew member.

class aiorentman.LeaveType(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, type: str, name: str, payroll_code: str, color: str, requires_approval: bool, affects_availability: bool, has_balance: bool, balance_start_date: datetime | None, is_labor: str, has_calculated_duration: bool, can_have_activities: bool, counts_in_totals: bool, raw: dict[str, Any] | None = None)

One leave type that time registration books to.

class aiorentman.Contact(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, folder: RentmanLink | Folder | None, type: str, ext_name_line: str, firstname: str, distance: float | None, travel_time: float | None, surfix: str, surname: str, longitude: float | None, latitude: float | None, code: str, accounting_code: str, vendor_accounting_code: str, name: str, gender: str, mailing_city: str, mailing_street: str, mailing_number: str, mailing_unit_number: str, mailing_district: str, mailing_extra_address_line: str, mailing_postalcode: str, mailing_state: str, mailing_country: str, visit_city: str, visit_street: str, visit_number: str, visit_unit_number: str, visit_district: str, visit_extra_address_line: str, visit_postalcode: str, visit_state: str, country: str, invoice_city: str, invoice_street: str, invoice_number: str, invoice_unit_number: str, invoice_district: str, invoice_extra_address_line: str, invoice_postalcode: str, invoice_state: str, invoice_country: str, phone_1: str, phone_2: str, email_1: str, email_2: str, website: str, VAT_code: str, fiscal_code: str, commerce_code: str, purchase_number: str, bic: str, bank_account: str, default_person: RentmanLink | ContactPerson | None, admin_contactperson: RentmanLink | None, discount_crew: float | None, discount_transport: float | None, discount_rental: float | None, discount_sale: float | None, discount_total: float | None, projectnote: str, projectnote_title: str, contact_warning: str, discount_subrent: float | None, image: RentmanLink | None, tags: tuple[str, ...], custom: dict[str, Any], raw: dict[str, Any] | None = None)

One customer or supplier contact registered in the account.

class aiorentman.ContactPerson(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, contact: RentmanLink | Contact, firstname: str, middle_name: str, lastname: str, function: str, phone: str, street: str, number: str, postalcode: str, city: str, state: str, country: str, mobilephone: str, email: str, tags: tuple[str, ...], custom: dict[str, Any], raw: dict[str, Any] | None = None)

One person working at one contact.

class aiorentman.Task(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, recurhoe: str, recureind: str | None, recurperiode: int | None, is_template: bool, name: str, details: str, color: str, priority: str, order: str, deadline: datetime | None, deadline_type: str, deadline_relative_offset_base: str, deadline_relative_offset_amount: int | None, deadline_relative_offset_unit: str, deadline_relative_offset_direction: str, completed_at: datetime | None, status: RentmanLink | TaskStatus, item: int | None, itemtype: str | None, synchronization_id: str, synchronization_uri: str, public: str, assignment_type: str, completed_by: RentmanLink | None, expiry_notification_date: datetime | None, time_budget: float | None, tags: tuple[str, ...], parent_api_path: str, custom: dict[str, Any], raw: dict[str, Any] | None = None)

One task tracked against one item in the account.

class aiorentman.Subtask(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, task: RentmanLink | Task, title: str, completed: bool, raw: dict[str, Any] | None = None)

One checklist line inside one task.

class aiorentman.TaskAssignment(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, task: RentmanLink | Task, crew: RentmanLink | Crew, raw: dict[str, Any] | None = None)

One crew member assigned to one task.

class aiorentman.TaskStatus(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, name: str, color: str, type: str, order: str, raw: dict[str, Any] | None = None)

One status that a task can carry.

class aiorentman.File(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, readable_name: str, expiration: datetime | None, size: int | None, image: bool, item: int | None, itemtype: str | None, description: str, in_documents: bool, in_webshop: bool, classified: bool, public: bool, type: str, preview_of: RentmanLink | None, previewstatus: str, file_item: int | None, file_itemtype: str, folder: RentmanLink | FileFolder | None, path: str, path_without_file_name: str, path_with_file_folders: str, name_without_extension: str, friendly_name_without_extension: str, extension: str, url: str, proxy_url: str, parent_api_path: str, raw: dict[str, Any] | None = None)

One file stored against one item in the account.

class aiorentman.FileFolder(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, parent: RentmanLink | FileFolder | None, name: str, classified: bool, item: int | None, itemtype: str | None, is_template: bool, parent_api_path: str, raw: dict[str, Any] | None = None)

One folder that groups the files of one item.

class aiorentman.Rate(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, name: str, archived: bool, type: str, subtype: str, raw: dict[str, Any] | None = None)

One rate definition that prices or costs book against.

class aiorentman.RateFactor(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, rate_id: RentmanLink | Rate, from_: float | None, to: float | None, variable: float | None, fixed: float | None, raw: dict[str, Any] | None = None)

One bracket inside the price or cost table of a rate.

class aiorentman.Factor(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, from_days: int | None, to_days: int | None, factor: str, factor_group: RentmanLink | FactorGroup, raw: dict[str, Any] | None = None)

One day bracket inside a factor group.

class aiorentman.FactorGroup(id: int, created: datetime | None, modified: datetime | None, update_hash: str, creator: RentmanLink | None, displayname: str, name: str, raw: dict[str, Any] | None = None)

One group of day factors applied to rental prices.

Payloads

class aiorentman.AccessoryPayload(equipment: RentmanLink | None = None, quantity: int | None = None, automatic: bool | None = None, skip: bool | None = None, is_free: bool | None = None, order: str | None = None, add_as_new_line: bool | None = None)

The write payload for one accessory of a material.

class aiorentman.AlternativePayload(alternative: RentmanLink)

The write payload for one alternative of a material.

class aiorentman.AppointmentPayload(start: datetime, end: datetime, name: str | None = None, color: str | None = None, location: str | None = None, remark: str | None = None, is_public: bool | None = None, is_plannable: bool | None = None)

The write payload for one appointment.

class aiorentman.AppointmentCrewPayload(crew: RentmanLink)

The write payload for one crew member on an appointment.

class aiorentman.ContactPayload(folder: RentmanLink | None = None, type: str | None = None, ext_name_line: str | None = None, firstname: str | None = None, distance: float | None = None, travel_time: float | None = None, surfix: str | None = None, surname: str | None = None, longitude: float | None = None, latitude: float | None = None, code: str | None = None, accounting_code: str | None = None, vendor_accounting_code: str | None = None, name: str | None = None, gender: str | None = None, mailing_city: str | None = None, mailing_street: str | None = None, mailing_number: str | None = None, mailing_unit_number: str | None = None, mailing_district: str | None = None, mailing_extra_address_line: str | None = None, mailing_postalcode: str | None = None, mailing_state: str | None = None, mailing_country: str | None = None, visit_city: str | None = None, visit_street: str | None = None, visit_number: str | None = None, visit_unit_number: str | None = None, visit_district: str | None = None, visit_extra_address_line: str | None = None, visit_postalcode: str | None = None, visit_state: str | None = None, country: str | None = None, invoice_city: str | None = None, invoice_street: str | None = None, invoice_number: str | None = None, invoice_unit_number: str | None = None, invoice_district: str | None = None, invoice_extra_address_line: str | None = None, invoice_postalcode: str | None = None, invoice_state: str | None = None, invoice_country: str | None = None, phone_1: str | None = None, phone_2: str | None = None, email_1: str | None = None, email_2: str | None = None, website: str | None = None, VAT_code: str | None = None, fiscal_code: str | None = None, commerce_code: str | None = None, purchase_number: str | None = None, bic: str | None = None, bank_account: str | None = None, default_person: RentmanLink | None = None, admin_contactperson: RentmanLink | None = None, discount_crew: float | None = None, discount_transport: float | None = None, discount_rental: float | None = None, discount_sale: float | None = None, discount_total: float | None = None, projectnote: str | None = None, projectnote_title: str | None = None, contact_warning: str | None = None, discount_subrent: float | None = None, image: RentmanLink | None = None, custom: dict[str, Any] | None = None)

The write payload for one contact.

class aiorentman.ContactPersonPayload(firstname: str | None = None, middle_name: str | None = None, lastname: str | None = None, function: str | None = None, phone: str | None = None, street: str | None = None, number: str | None = None, postalcode: str | None = None, city: str | None = None, state: str | None = None, country: str | None = None, mobilephone: str | None = None, email: str | None = None, custom: dict[str, Any] | None = None)

The write payload for one contact person.

class aiorentman.CrewAvailabilityPayload(start: datetime, end: datetime, last_updater: RentmanLink | None = None, last_updated: datetime | None = None, status: str | None = None, remark: str | None = None, recurrence_interval_unit: str | None = None, recurrence_enddate: str | None = None, recurrence_interval: int | None = None, recurrent_group: int | None = None, recurrence_weekdays: str | None = None)

The write payload for one availability window of a crew member.

class aiorentman.EquipmentPayload(folder: RentmanLink | None = None, code: str | None = None, factor_group: RentmanLink | None = None, name: str | None = None, internal_remark: str | None = None, external_remark: str | None = None, unit: str | None = None, in_shop: bool | None = None, surface_article: bool | None = None, shop_description_short: str | None = None, shop_description_long: str | None = None, shop_seo_title: str | None = None, shop_seo_keyword: str | None = None, shop_seo_description: str | None = None, shop_featured: bool | None = None, price: float | None = None, subrental_costs: float | None = None, critical_stock_level: int | None = None, type: str | None = None, rental_sales: str | None = None, temporary: bool | None = None, in_planner: bool | None = None, in_archive: bool | None = None, stock_management: str | None = None, taxclass: RentmanLink | None = None, list_price: float | None = None, volume: float | None = None, packed_per: int | None = None, height: float | None = None, width: float | None = None, length: float | None = None, weight: float | None = None, empty_weight: float | None = None, power: float | None = None, current: float | None = None, country_of_origin: str | None = None, image: RentmanLink | None = None, ledger: RentmanLink | None = None, ledger_debit: RentmanLink | None = None, defaultgroup: str | None = None, is_combination: bool | None = None, is_physical: str | None = None, can_edit_content_during_planning: bool | None = None, strict_container_content: str | None = None, custom: dict[str, Any] | None = None)

The write payload for one material.

class aiorentman.EquipmentSetContentPayload(equipment: RentmanLink, quantity: str | None = None, order: str | None = None, is_fixed: str | None = None, is_physically_connected: str | None = None)

The write payload for one line of set content.

class aiorentman.FolderPayload(parent: RentmanLink | None = None, name: str | None = None, order: str | None = None, itemtype: str | None = None)

The write payload for one folder.

class aiorentman.LeaveMutationPayload(crewmember: RentmanLink, leavetype: RentmanLink, description: str | None = None, duration: float | None = None, mutation_date: str | None = None)

The write payload for one leave mutation.

class aiorentman.LeaveRequestPayload(requested_for: RentmanLink, description: str | None = None, approval_status: str | None = None, reviewed_on: datetime | None = None, reviewer: RentmanLink | None = None)

The write payload for one leave request.

class aiorentman.PaymentPayload(moment: datetime, amount: float | None = None, description: str | None = None, payment_import_source: str | None = None)

The write payload for one payment.

class aiorentman.ProjectPayload(name: str | None = None, reference: str | None = None, number: str | None = None, custom: dict[str, Any] | None = None)

The write payload for one project.

class aiorentman.ProjectCostPayload(subproject: RentmanLink, name: str | None = None, remark: str | None = None, quantity: int | None = None, discount: float | None = None, is_template: bool | None = None, taxclass: RentmanLink | None = None, ledger: RentmanLink | None = None, ledger_debit: RentmanLink | None = None, sale_price: float | None = None, purchase_price: float | None = None, custom: dict[str, Any] | None = None)

The write payload for one project cost.

class aiorentman.ProjectFunctionPayload(cost_rate: RentmanLink, price_rate: RentmanLink, subproject: RentmanLink, cost_accommodation: float | None = None, cost_catering: float | None = None, cost_travel: float | None = None, cost_other: float | None = None, price_accommodation: float | None = None, price_catering: float | None = None, price_travel: float | None = None, price_other: float | None = None, group: RentmanLink | None = None, name_external: str | None = None, name: str | None = None, usageperiod_start: datetime | None = None, usageperiod_end: datetime | None = None, planperiod_start: datetime | None = None, planperiod_end: datetime | None = None, type: str | None = None, amount: int | None = None, is_plannable: bool | None = None, custom: dict[str, Any] | None = None)

The write payload for one project function.

class aiorentman.ProjectFunctionGroupPayload(subproject: RentmanLink, name: str | None = None, usageperiod_start: datetime | None = None, usageperiod_end: datetime | None = None, planperiod_start: datetime | None = None, planperiod_end: datetime | None = None, remark: str | None = None)

The write payload for one project function group.

class aiorentman.ProjectRequestPayload(planperiod_end: datetime, planperiod_start: datetime, linked_contact: RentmanLink | None = None, contact_mailing_number: str | None = None, contact_mailing_country: str | None = None, contact_name: str | None = None, contact_mailing_postalcode: str | None = None, contact_phone: str | None = None, contact_mailing_city: str | None = None, contact_mailing_street: str | None = None, contact_person_lastname: str | None = None, contact_person_email: str | None = None, contact_person_middle_name: str | None = None, contact_person_first_name: str | None = None, usageperiod_end: datetime | None = None, usageperiod_start: datetime | None = None, is_paid: bool | None = None, language: str | None = None, in_: datetime | None = None, out_: datetime | None = None, location_mailing_number: str | None = None, location_mailing_country: str | None = None, location_name: str | None = None, location_mailing_postalcode: str | None = None, location_mailing_city: str | None = None, location_mailing_street: str | None = None, location_phone: str | None = None, name: str | None = None, external_reference: int | None = None, remark: str | None = None, price: float | None = None)

The write payload for one project request.

class aiorentman.ProjectRequestEquipmentPayload(quantity: int | None = None, quantity_total: int | None = None, is_comment: bool | None = None, is_kit: bool | None = None, discount: float | None = None, linked_equipment: RentmanLink | None = None, name: str | None = None, external_remark: str | None = None, parent: RentmanLink | None = None, unit_price: float | None = None, factor: str | None = None, order: str | None = None)

The write payload for one equipment line of a project request.

class aiorentman.SerialNumberPayload(serial: str | None = None, purchasedate: str | None = None, depreciation_monthly: float | None = None, book_value: float | None = None, residual_value: float | None = None, purchase_costs: float | None = None, active: bool | None = None, remark: str | None = None, ref: str | None = None, asset_location: RentmanLink | None = None, image: RentmanLink | None = None, custom: dict[str, Any] | None = None)

The write payload for one serial number.

class aiorentman.StockMovementPayload(date: datetime, amount: int | None = None, projectequipment: RentmanLink | None = None, description: str | None = None, details: str | None = None, stock_location: RentmanLink | None = None, api_client: str | None = None)

The write payload for one stock movement.

class aiorentman.SubprojectPayload(name: str | None = None, custom: dict[str, Any] | None = None)

The write payload for one subproject.

class aiorentman.SubtaskPayload(title: str | None = None, completed: bool | None = None)

The write payload for one subtask.

class aiorentman.SupplierPayload(contact: RentmanLink, contactperson: RentmanLink | None = None, price: float | None = None, details: str | None = None)

The write payload for one supplier of a material.

class aiorentman.TaskPayload(color: str, recurhoe: str | None = None, recureind: str | None = None, recurperiode: int | None = None, is_template: bool | None = None, name: str | None = None, details: str | None = None, priority: str | None = None, order: str | None = None, deadline: datetime | None = None, deadline_type: str | None = None, deadline_relative_offset_base: str | None = None, deadline_relative_offset_amount: int | None = None, deadline_relative_offset_unit: str | None = None, deadline_relative_offset_direction: str | None = None, completed_at: datetime | None = None, status: RentmanLink | None = None, item: int | None = None, itemtype: str | None = None, synchronization_id: str | None = None, synchronization_uri: str | None = None, public: str | None = None, assignment_type: str | None = None, completed_by: RentmanLink | None = None, expiry_notification_date: datetime | None = None, time_budget: float | None = None, custom: dict[str, Any] | None = None)

The write payload for one task.

class aiorentman.TaskAssignmentPayload(crew: RentmanLink)

The write payload for one task assignment.

class aiorentman.TaskStatusPayload(color: str, name: str | None = None, type: str | None = None, order: str | None = None)

The write payload for one task status.

class aiorentman.TimeRegistrationPayload(crewmember: RentmanLink | None = None, start: datetime | None = None, end: datetime | None = None, distance: float | None = None, is_lunch_included: bool | None = None, leavetype: RentmanLink | None = None, duration: float | None = None, break_duration: float | None = None, travel_time: float | None = None, correction_duration: float | None = None, remark: str | None = None, custom: dict[str, Any] | None = None)

The write payload for one time registration.

class aiorentman.VehiclePayload(folder: RentmanLink | None = None, name: str | None = None, cost_rate: RentmanLink | None = None, in_planner: bool | None = None, height: float | None = None, length: float | None = None, width: float | None = None, seats: int | None = None, inspection_date: str | None = None, licenseplate: str | None = None, remark: str | None = None, payload_capacity: float | None = None, surface_area: str | None = None, multiple: str | None = None, image: RentmanLink | None = None, asset_location: RentmanLink | None = None, custom: dict[str, Any] | None = None)

The write payload for one vehicle.

Exceptions

class aiorentman.RentmanError(message: str, status: int | None = None)

Base class for every error this library raises.

class aiorentman.RentmanCommunicationError(message: str, status: int | None = None)

The Rentman API answered with an unexpected failure or could not be reached.

class aiorentman.RentmanTimeoutError(message: str, status: int | None = None)

A Rentman request exceeded the configured timeout.

class aiorentman.RentmanInvalidResponseError(message: str, status: int | None = None)

A response carried an unusable payload, such as malformed JSON.

class aiorentman.RentmanNotFoundError(message: str, status: int | None = None)

A requested object does not exist.

class aiorentman.RentmanAuthenticationError(message: str, status: int | None = None)

The API token is missing or was rejected.

class aiorentman.RentmanAuthorizationError(message: str, status: int | None = None)

The token does not grant access to this resource.

class aiorentman.RentmanValidationError(message: str, status: int | None = None)

The Rentman API rejected a request body or query as invalid.

class aiorentman.RentmanRateLimitError(message: str, status: int | None = None, retry_after: int | None = None)

The request exceeded the Rentman rate limits.

Rentman allows 10 requests per second, at most 20 concurrent requests, and 50.000 requests per day. The client paces its own requests, so this error usually means another consumer of the same account is spending the shared budget. retry_after holds the Retry-After delay in seconds when the response provides one.

class aiorentman.RentmanClientClosedError(message: str, status: int | None = None)

The client was closed, so no further requests can be made.