*REST API › Objects › Rentals*

# Quote

> The quote, as returned by the API.

A quote, shown as its active version. `status` is the document lifecycle and `operativeStatus` is the commercial status; confirming a version leaves the others as `superseded`. Quotes are bounded to the subscription that owns the key. The detail read, [`GET /api/v1/quotes/{quoteId}`](https://docs.filmo.io/rest-api/endpoint-reference/quotes/get-a-quote), adds the project name and the tax breakdown. The lines are read with [`GET /api/v1/quotes/{quoteId}/lines`](https://docs.filmo.io/rest-api/endpoint-reference/quotes/list-the-lines-of-a-quote).

Schemas: `QuoteDto`, `QuoteDetailDto`

## Attributes

| Name | Type | Description |
| --- | --- | --- |
| `id` | string | Unique quote identifier (container). |
| `quoteNumber` | string | Human-readable quote number. |
| `versionNumber` | integer | Number of the active version of the quote. |
| `status` | string | Document lifecycle status of the active version: draft or validated (validated and numbered). `draft`, `validated` |
| `operativeStatus` | string | Commercial status of the active version: pending (awaiting an answer), confirmed (accepted), cancelled (rejected/cancelled) or superseded (replaced). `pending`, `confirmed`, `cancelled`, `superseded` |
| `issueDate` | string<date-time> | Issue date of the active version in ISO 8601 with offset; null if not issued. |
| `validUntil` | string<date-time> | Validity date of the quote in ISO 8601 with offset; null if not set. |
| `startDate` | string<date-time> | Start of the quoted rental period in ISO 8601 with offset. |
| `endDate` | string<date-time> | End of the quoted rental period in ISO 8601 with offset. |
| `currency` | string | Quote currency as an ISO 4217 code (for example "EUR"). |
| `contact` | object | Compact reference to the quote contact; null if none. |
| `contact.id` | string | Unique contact identifier. |
| `contact.name` | string | Contact name. |
| `orderId` | string | Identifier of the linked order; null if not linked. |
| `orderNumber` | string | Number of the linked order; null if not linked. |
| `projectId` | string | Identifier of the linked project; null if not linked. |
| `subTotal` | string | Subtotal before discounts and taxes, as a decimal string "1234.50" (ROUND_HALF_UP). |
| `discountTotal` | string | Total discounts as a decimal string "1234.50" (ROUND_HALF_UP). |
| `taxesPrice` | string | Tax total as a decimal string "1234.50" (ROUND_HALF_UP). |
| `netPrice` | string | Taxable base (net before taxes) as a decimal string "1234.50" (ROUND_HALF_UP). |
| `grossPrice` | string | Total including taxes, as a decimal string "1234.50" (ROUND_HALF_UP). |
| `totalPaid` | string | Amount collected against the quote as a decimal string "1234.50" (ROUND_HALF_UP); null if not recorded. |
| `createdAt` | string<date-time> | Creation date of the container in ISO 8601 with offset. |
| `updatedAt` | string<date-time> | Last update date in ISO 8601 with offset. |
| `projectName` | string | Name of the linked project; null if not linked. |
| `taxBreakdown` | object[] | Tax breakdown by type; null if not calculated. |
| `taxBreakdown.taxType` | string | Tax type key (for example "IVA_21"). |
| `taxBreakdown.label` | string | Human-readable tax label. |
| `taxBreakdown.rate` | number | Tax rate applied, as a percentage (for example 21 for 21%). |
| `taxBreakdown.baseAmount` | string | Taxable base the tax is applied to, as a decimal string "1234.50" (ROUND_HALF_UP). |
| `taxBreakdown.amount` | string | Tax amount as a decimal string "1234.50" (ROUND_HALF_UP). |

## Values

| Field | Values |
| --- | --- |
| `status` | `draft`, `validated` |
| `operativeStatus` | `pending`, `confirmed`, `cancelled`, `superseded` |

## Example

*Quote · Generated from the schema*

```json
{
  "id": "id_8f2a1c",
  "quoteNumber": "string",
  "versionNumber": 1,
  "status": "draft",
  "operativeStatus": "pending",
  "issueDate": "2026-09-01T08:00:00Z",
  "validUntil": "2026-09-01T08:00:00Z",
  "startDate": "2026-09-01T08:00:00Z",
  "endDate": "2026-09-01T08:00:00Z",
  "currency": "EUR",
  "contact": {
    "id": "id_8f2a1c",
    "name": "Example"
  },
  "orderId": "string",
  "orderNumber": "string",
  "projectId": "string",
  "subTotal": "1234.50",
  "discountTotal": "1234.50",
  "taxesPrice": "1234.50",
  "netPrice": "1234.50",
  "grossPrice": "1234.50",
  "totalPaid": "1234.50",
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z",
  "projectName": "Example",
  "taxBreakdown": [
    {
      "taxType": "1234.50",
      "label": "Example",
      "rate": 1,
      "baseAmount": "1234.50",
      "amount": "1234.50"
    }
  ]
}
```

## Returned by

- [`GET /api/v1/quotes`](https://docs.filmo.io/rest-api/endpoint-reference/quotes/list-quotes) — List quotes
- [`GET /api/v1/quotes/{quoteId}`](https://docs.filmo.io/rest-api/endpoint-reference/quotes/get-a-quote) — Get a quote

## Modified by

- [`PATCH /api/v1/quotes/{quoteId}/status`](https://docs.filmo.io/rest-api/endpoint-reference/quotes/change-the-commercial-status-of-a-quote) — Change the commercial status of a quote

---

Canonical URL: https://docs.filmo.io/rest-api/objects/quote  
Last updated: 2026-10-25