Rentals

Project

The project, as returned by the API.

Schemas: ProjectDto, ProjectDetailDto

{
  "id": "id_8f2a1c",
  "projectNumber": "string",
  "name": "Example",
  "color": "string",
  "externalReference": "string",
  "projectTypeId": "string",
  "projectType": {
    "id": "id_8f2a1c",
    "name": "Example",
    "color": "string"
  },
  "contact": {
    "id": "id_8f2a1c",
    "name": "Example"
  },
  "location": {
    "name": "Example",
    "address": "string",
    "city": "string",
    "postalCode": "string",
    "province": "string",
    "country": "ES",
    "lat": 1,
    "lng": 1
  },
  "startDate": "2026-09-01T08:00:00Z",
  "endDate": "2026-09-01T08:00:00Z",
  "status": "draft",
  "archived": true,
  "orderIds": [
    "string"
  ],
  "totalOrders": 1,
  "tags": [
    {
      "id": "id_8f2a1c",
      "name": "Example"
    }
  ],
  "customFields": {
    "key": "string"
  },
  "source": "string",
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z"
}

Generated from the schema

A project that groups orders and work for a contact, with its dates, type, location and the identifiers of its orders. Projects use the tenancy inherited from the parent account, so a billing account also sees the projects of its parent. externalReference is writable, so it can hold your own key. Archive or restore a project with PUT /api/v1/projects/{projectId}/archive, and link orders to it with POST /api/v1/projects/{projectId}/orders/{orderId}.

Attributes

idstring

Unique project identifier.

projectNumberstring | null

Human-readable project number; null if not numbered.

namestring

Project name.

colorstring | null

Color associated with the project (for the UI); null if none.

externalReferencestring | null

External reference of the project (for example, from the customer system); null if not recorded.

projectTypeIdstring | null

Project type identifier; null if the project has no type.

projectTypeobject | null

Compact reference to the project type; null if none.

Show child attributes

projectType.idstring

Unique project type identifier.

projectType.namestring

Project type name.

projectType.colorstring | null

Color associated with the project type (for the UI); null if none.

contactobject | null

Compact reference to the project contact; null if none.

Show child attributes

contact.idstring

Unique contact identifier.

contact.namestring

Contact name.

locationobject

Project location; its inner fields are null when not recorded.

Show child attributes

location.namestring | null

Name of the place/location; null if not recorded.

location.addressstring | null

Address of the location; null if not recorded.

location.citystring | null

City of the location; null if not recorded.

location.postalCodestring | null

Postal code of the location; null if not recorded.

location.provincestring | null

Province or region of the location; null if not recorded.

location.countrystring | null

Country of the location; null if not recorded.

location.latnumber | null

Latitude of the location; null if not recorded.

location.lngnumber | null

Longitude of the location; null if not recorded.

startDatestring<date-time>

Project start date in ISO 8601 with offset.

endDatestring<date-time>

Project end date in ISO 8601 with offset.

statusstring

Project status: draft, budgeted, confirmed, in_progress, invoiced, completed, cancelled or archived. archived is a LEGACY status that appears in old data; the current archived state is expressed by the archived boolean of this same DTO.

Available options: draft, budgeted, confirmed, in_progress, invoiced, completed, cancelled, archived

archivedboolean

Whether the project is archived.

orderIdsstring[]

Identifiers of the project orders. Order details are obtained from GET /api/v1/orders?projectId=.

totalOrdersinteger

Total number of orders in the project (equals orderIds.length).

tagsobject[]

Tags attached to the project, with their identifier and name.

Show child attributes

tags.idstring

Unique identifier of the tag.

tags.namestring

Tag name.

customFieldsobject<string, any>

Custom field values by custom field identifier; the definitions are in /api/v1/custom-fields.

sourcestring | null

Source the project was created from; null if not recorded.

createdAtstring<date-time>

Creation date in ISO 8601 with offset.

updatedAtstring<date-time>

Last update date in ISO 8601 with offset.

Values

status: draft, budgeted, confirmed, in_progress, invoiced, completed, cancelled, archived

Returned by

GET /api/v1/projects — List projects
GET /api/v1/projects/{projectId} — Get a project

Modified by

POST /api/v1/projects — Create a project
PATCH /api/v1/projects/{projectId} — Update a project
POST /api/v1/projects/{projectId}/orders/{orderId} — Link an order to a project
DELETE /api/v1/projects/{projectId}/orders/{orderId} — Unlink an order from a project

Was this page helpful?