SIGNALS Docs
Reader View

Rental Projects

Group related rentals under one rental project for shared planning and reporting.

Overview

A rental project groups related rentals under a single engagement — for example a multi-venue festival, a touring production, or a long-running account job that spans several quotes and orders. Projects are deliberately cross-warehouse: they have no warehouse_id of their own; warehouse scoping and availability still flow through the underlying rentals.

Projects carry a name, an optional Customer (company or contact) and venue, date window, owner, and a fixed lifecycle status (draft → active → completed / archived).

Route: /projects

Rental Projects live under the Job Planning section of the main navigation, gated on the projects.access permission.

Project-level scheduling and costs

The project create and edit form starts with Name, Dates, Who (Customer and Owner) and status. Expand More details for Venue and Description.

Resource assignments and additional cost rows can belong directly to a project instead of to one rental. The database enforces that each row has exactly one attachment: a rental or a rental project, never both or neither.

Project-level rows follow the project's warehouse union. A warehouse-scoped viewer can see them when they can access at least one linked rental's warehouse; a viewer who cannot access any linked rental warehouse cannot see them. Cost amounts still require the normal cost-visibility permission after cached project data is retrieved.

A project must have at least one non-deleted linked rental before a project-scoped assignment or cost can be created. Attach the first rental to establish the warehouse union, then add the project-level row. Attempts made prior return the coded rental_project_requires_rental validation error.

The Crew tab requires a Labour service for each new project-level person, account, or dispatch-group assignment. Signals resolves that service's normal company-base rate over the assignment window and atomically records the assignment with one editable Labour project cost. A catalogue-linked vehicle assignment uses the same bridge for a Fleet project cost. These are creation-time snapshots: later assignment or rate changes do not silently re-price the cost. Project-level costs contribute to the shared project-resource rollup and can be billed on a standalone project invoice.

Standalone project invoicing

The Money register can generate a standard invoice from every remaining non-optional project cost, or the API can select partial quantities from individual costs. The invoice freezes the cost type, description, unit amount, quantity, tax result, and a soft link back to the source cost. An invoice has at most one rental or rental-project source; source-less manual invoices remain valid. Project costs are already held in company base currency, so project invoices persist the normal document-base columns with a stored base rate of 1.

Project invoice tax uses the warehouse on the project's deterministic primary rental: the earliest-created non-deleted linked rental, with rental id as the tie-breaker. Associated descendants are linked rentals for this rule. Signals uses the project's billing account when present and otherwise falls back to the primary rental's account. A project without a live linked rental is blocked with project_invoice_requires_rental; a primary rental without a warehouse is blocked with project_invoice_requires_primary_warehouse. Only draft and active projects can generate invoices.

A billing run can sweep remaining project costs in the same period and warehouse scope. Those items generate their invoices at issue time through the same project-invoice path; undo voids the invoice and releases the frozen quantity. See Billing runs.

Project and rental invoices share the same per-warehouse standard-invoice numbering sequence. A partially invoiced cost may still be edited, but its quantity cannot be reduced below the invoiced quantity, it cannot be made optional, and it cannot be removed. Once fully invoiced, the entire cost row is locked. Voiding or deleting the project invoice releases its frozen quantities. Direct project invoices contribute to the shared project money rollups in base and document currency, but are not attributed to an individual rental; the Money register discloses their contribution separately from its per-rental rows.

Crew and transport planning

The Crew tab combines project-owned and linked-rental people or dispatch-group assignments. Its assignment register shows role, resource, viewer-local window, lifecycle status, attachment, and unresolved conflicts. The day lane uses distinct people per display-timezone calendar day; it does not add assignment rows together as headcount. Users with both project-update and resource-assignment-create access can add a project-level crew row once the project has a linked rental.

The Transport tab applies the same rules to vehicle assignments. It groups runs and route stops by day and vehicle, and its route manager creates, edits, reorders, and removes stops through the normal assignment route-stop actions. Assignment and stop inputs are read in the viewer timezone and stored as UTC instants.

The Overview has separate Crew and Transport registers with total assignments, next-seven-day coverage, and unresolved conflict counts. Its briefing marks an upcoming rental start with no crew as Act and missing transport as Watch. These figures, the tab counters, and both detail tabs all consume the shared cached project-resource rollup; no view recomputes financial or scheduling totals. Detail lists cap at 50 rows and show a truncation notice while their headline counts remain complete.

Unscheduled service demand

Integrations can poll GET /api/v1/resource-assignments/unscheduled for rental service lines whose demanded quantity exceeds their non-cancelled assignments. from and to are required ISO 8601 overlap bounds; optional warehouse_id and service_id narrow the result. Each unscheduled_demand row identifies the rental line, rental, service, window, demanded quantity, assigned count, and numeric shortfall. The endpoint requires resource-assignments.view and resource-assignments:read.

This read endpoint is the current, window-scoped backlog and is suitable for reconciliation or a scheduling connector's next work queue. The resource_assignment.demand_unmet webhook is the event counterpart: it fires when cancelling an assignment leaves its linked rental service line short and carries the rental_line_id and resulting shortfall. Subscribe to the webhook for immediate change notification, then query the unscheduled endpoint when you need the complete current picture.

Rental assignment

Each rental belongs to at most one project. From the project detail page (or the rental form) you can attach and detach rentals:

  • Attach links an unassigned rental to the project.
  • Reassigning a rental that already belongs to another project is allowed in the UI (the FK is overwritten). The REST attach endpoint is stricter — see below.
  • Detach clears the link. Soft-deleting a project also clears every linked rental.

Project deletion is blocked while any project-owned costs, resource assignments, or invoices remain. The coded validation response lists all three row counts; remove those rows first, then delete the project.

Permissions

Permission Grants
projects.access See the Rental Projects area in navigation
projects.view View project records
projects.create Create projects
projects.update Edit projects and attach/detach rentals
projects.delete Soft-delete projects

Two neighbouring permissions gate parts of the project page rather than the project itself:

Permission Grants
resource-assignments.create The add-row controls on the Crew and Transport tabs. Held together with projects.update — either one alone is not enough
costs.view The cost and margin figures on the Money register and in project cost rows. Without it the registers render, but the amounts do not

Tabs

Tab Route Description
Overview /projects/{id} Briefing, money register, and the crew / transport / status registers
Rentals /projects/{id}/rentals Linked record rentals, nested parent-first with their associated descendants
Crew /projects/{id}/crew People and dispatch-group assignments, project-owned and from linked rentals
Transport /projects/{id}/transport Vehicle assignments, grouped by day and vehicle, with the route-stop manager
Project changes /projects/{id}/activity The project's audit register

Plugins can contribute further tabs through the rental_project.detail.tabs slot. A rental's own header links back to its owning project.

There is deliberately no project Costs tab. Project-level costs are created and managed through the nested REST endpoints below, and surface in the UI only through the Money register and the rollups that read them.

API

Create, update and read payloads use owner_id for the owning user ID. Filter projects with filter[owner_id][eq]. This references a user record; account and rental ownership references account records. An explicit null on project update clears the owner.

Project starts_at and ends_at are inclusive dates in YYYY-MM-DD format. The created_at and updated_at fields are ISO 8601 timestamps.

MethodURLSummaryAbilityWeight
GET/api/v1/rental_projectsIndex rental projectsprojects:read2
POST/api/v1/rental_projectsStore rental projectsprojects:write3
GET/api/v1/rental_projects/{rental_project}Show rental projectsprojects:read1
PUT/api/v1/rental_projects/{rental_project}Update rental projectsprojects:write3
DELETE/api/v1/rental_projects/{rental_project}Destroy rental projectsprojects:write3
GET/api/v1/rental_projects/{rental_project}/costsCosts rental projectsprojects:read2
POST/api/v1/rental_projects/{rental_project}/costsCosts rental projectsprojects:write3
GET/api/v1/rental_projects/{rental_project}/costs/{cost}Costs rental projectsprojects:read1
PATCH/api/v1/rental_projects/{rental_project}/costs/{cost}Costs rental projectsprojects:write3
DELETE/api/v1/rental_projects/{rental_project}/costs/{cost}Costs rental projectsprojects:write3
POST/api/v1/rental_projects/{rental_project}/invoicesInvoices rental projectsinvoices:write4
GET/api/v1/rental_projects/{rental_project}/rentalsRentals rental projectsprojects:read2
POST/api/v1/rental_projects/{rental_project}/rentalsRentals rental projectsprojects:write3
DELETE/api/v1/rental_projects/{rental_project}/rentals/{rental}Rentals rental projectsprojects:write3
AbilityDescription
projects:readRead rental project records
projects:writeCreate, update, and delete rental projects; attach and detach rentals

Attach returns 422 when the rental already belongs to a different project. Detach is idempotent — repeating the call (or detaching a rental that is not on this project) returns 204 without error.

Project-owned costs can be listed, created, shown, updated, and removed through the nested /api/v1/rental_projects/{rental_project}/costs endpoints with the existing projects:read / projects:write token abilities. Cost amounts remain field-level protected by the normal cost-visibility permission. Financial / margin rollups are available in the UI but are not exposed as REST totals yet. A project whose rentals carry mixed currencies shows per-rental amounts in their own currencies and never a blended total. Project costs contribute only to the shared rollup's stored-base totals and their own currency bucket; currencies are never blended into a document-currency figure.

POST /api/v1/rental_projects/{rental_project}/invoices generates a project invoice and requires the invoices.create permission plus the invoices:write token ability. Omit lines to invoice all remaining non-optional costs, or pass lines[*].rental_cost_id and lines[*].quantity for a partial invoice. Invoice resources expose rental_project_id; request include=rentalProject on invoice endpoints for the linked project reference.

GET /api/v1/rental_projects/{rental_project}/rentals lists directly linked rentals and every associated descendant as a depth-annotated tree. Warehouse scoping is applied to the returned rows; if an ancestor is hidden, its first visible descendant is rebased as a response root rather than exposing the hidden id. Project-scoped resource assignments use the existing resource-assignment API: supply rental_project_id instead of rental_id on single or batch create, and filter the collection with filter[rental_project_id][eq]. The normal update and cancel endpoints apply unchanged.

To reconcile uncovered rental-service demand, call GET /api/v1/resource-assignments/unscheduled?from=2026-09-01T00:00:00Z&to=2026-09-30T23:59:59Z; add warehouse_id or service_id when a connector owns only part of the schedule.

See the interactive OpenAPI reference for request and response schemas.

API ownership

Rental-project requests, responses, filters and webhook objects use owner_id, which references a user. Account ownership references accounts, including linked user accounts.

Additional form guidance

Project create and edit forms include configured RentalProject custom fields. Required values are validated when saving.