Rentals

Quote

The quote, as returned by the API.

Schemas: QuoteDto, QuoteDetailDto

{
  "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"
    }
  ]
}

Generated from the schema

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}, adds the project name and the tax breakdown. The lines are read with GET /api/v1/quotes/{quoteId}/lines.

Attributes

idstring

Unique quote identifier (container).

quoteNumberstring

Human-readable quote number.

versionNumberinteger

Number of the active version of the quote.

statusstring

Document lifecycle status of the active version: draft or validated (validated and numbered).

Available options: draft, validated

operativeStatusstring

Commercial status of the active version: pending (awaiting an answer), confirmed (accepted), cancelled (rejected/cancelled) or superseded (replaced).

Available options: pending, confirmed, cancelled, superseded

issueDatestring<date-time> | null

Issue date of the active version in ISO 8601 with offset; null if not issued.

validUntilstring<date-time> | null

Validity date of the quote in ISO 8601 with offset; null if not set.

startDatestring<date-time>

Start of the quoted rental period in ISO 8601 with offset.

endDatestring<date-time>

End of the quoted rental period in ISO 8601 with offset.

currencystring

Quote currency as an ISO 4217 code (for example "EUR").

contactobject | null

Compact reference to the quote contact; null if none.

Show child attributes

contact.idstring

Unique contact identifier.

contact.namestring

Contact name.

orderIdstring | null

Identifier of the linked order; null if not linked.

orderNumberstring | null

Number of the linked order; null if not linked.

projectIdstring | null

Identifier of the linked project; null if not linked.

subTotalstring

Subtotal before discounts and taxes, as a decimal string "1234.50" (ROUND_HALF_UP).

Limits: pattern ^-?\d+\.\d{2}$

discountTotalstring

Total discounts as a decimal string "1234.50" (ROUND_HALF_UP).

Limits: pattern ^-?\d+\.\d{2}$

taxesPricestring

Tax total as a decimal string "1234.50" (ROUND_HALF_UP).

Limits: pattern ^-?\d+\.\d{2}$

netPricestring

Taxable base (net before taxes) as a decimal string "1234.50" (ROUND_HALF_UP).

Limits: pattern ^-?\d+\.\d{2}$

grossPricestring

Total including taxes, as a decimal string "1234.50" (ROUND_HALF_UP).

Limits: pattern ^-?\d+\.\d{2}$

totalPaidstring | null

Amount collected against the quote as a decimal string "1234.50" (ROUND_HALF_UP); null if not recorded.

Limits: pattern ^-?\d+\.\d{2}$

createdAtstring<date-time>

Creation date of the container in ISO 8601 with offset.

updatedAtstring<date-time>

Last update date in ISO 8601 with offset.

projectNamestring | nullonly in the detail

Name of the linked project; null if not linked.

taxBreakdownobject[] | nullonly in the detail

Tax breakdown by type; null if not calculated.

Show child attributes

taxBreakdown.taxTypestring

Tax type key (for example "IVA_21").

taxBreakdown.labelstring

Human-readable tax label.

taxBreakdown.ratenumber

Tax rate applied, as a percentage (for example 21 for 21%).

taxBreakdown.baseAmountstring

Taxable base the tax is applied to, as a decimal string "1234.50" (ROUND_HALF_UP).

Limits: pattern ^-?\d+\.\d{2}$

taxBreakdown.amountstring

Tax amount as a decimal string "1234.50" (ROUND_HALF_UP).

Limits: pattern ^-?\d+\.\d{2}$

Values

status: draft, validated
operativeStatus: pending, confirmed, cancelled, superseded

Returned by

GET /api/v1/quotes — List quotes
GET /api/v1/quotes/{quoteId} — Get a quote

Modified by

PATCH /api/v1/quotes/{quoteId}/status — Change the commercial status of a quote

Was this page helpful?