Quotes

Change the commercial status of a quote

Moves the OPERATIVE status of the active version of the quote —pending, confirmed or cancelled— and leaves an optional note in the history.

PATCH

/api/v1/quotes/{quoteId}/status

curl https://app.filmo.io/api/v1/quotes/quot_8f2a1c/status \
  --request PATCH \
  --header "Authorization: Bearer $FILMO_API_KEY" \
  --header "Idempotency-Key: $(uuidgen 2>/dev/null || cat /proc/sys/kernel/random/uuid)" \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "confirmed",
  "notes": "Aceptada la versión 3 por teléfono"
}'

Node.jsfetch('https://app.filmo.io/api/v1/quotes/quot_8f2a1c/status', { method: 'PATCH', headers: { Authorization: 'Bearer YOUR_FILMO_API_KEY', 'Idempotency-Key': crypto.randomUUID(), 'Content-Type': 'application/json' }, body: JSON.stringify({ status: 'confirmed', notes: 'Aceptada la versión 3 por teléfono' }) })Pythonimport uuid import requests requests.patch( "https://app.filmo.io/api/v1/quotes/quot_8f2a1c/status", headers={ "Authorization": "Bearer YOUR_FILMO_API_KEY", "Idempotency-Key": str(uuid.uuid4()), "Content-Type": "application/json" }, json={ "status": "confirmed", "notes": "Aceptada la versión 3 por teléfono" } )

{
  "data": {
    "id": "quote_9f3a2b",
    "quoteNumber": "2026-0001",
    "versionNumber": 1,
    "status": "draft",
    "operativeStatus": "pending",
    "issueDate": "2026-09-01T08:00:00.000Z",
    "validUntil": "2026-09-01T08:00:00.000Z",
    "startDate": "2026-09-01T08:00:00.000Z",
    "endDate": "2026-09-01T08:00:00.000Z",
    "currency": "EUR",
    "contact": {
      "id": "contact_9f3a2b",
      "name": "Example contact"
    },
    "orderId": "order_9f3a2b",
    "orderNumber": "2026-0001",
    "projectId": "project_9f3a2b",
    "subTotal": "120.00",
    "discountTotal": "120.00",
    "taxesPrice": "120.00",
    "netPrice": "120.00",
    "grossPrice": "120.00",
    "totalPaid": "120.00",
    "createdAt": "2026-09-01T08:00:00.000Z",
    "updatedAt": "2026-09-01T08:00:00.000Z",
    "projectName": "Example project name",
    "taxBreakdown": [
      {
        "taxType": "120.00",
        "label": "Main",
        "rate": 1,
        "baseAmount": "120.00",
        "amount": "120.00"
      }
    ]
  }
}

{
  "type": "https://docs.filmo.io/errors/validation_error",
  "title": "Validation error",
  "status": 400,
  "code": "validation_error",
  "detail": "2 validation errors",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "errors": [
    {
      "path": "name",
      "code": "too_small",
      "message": "Must be at least 1 characters long"
    },
    {
      "path": "contactType",
      "code": "invalid_value",
      "message": "Value not allowed; expected company, person"
    }
  ]
}

{
  "type": "https://docs.filmo.io/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthorized",
  "detail": "Missing Authorization header: Bearer <api key>",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/addon_required",
  "title": "Add-on required",
  "status": 402,
  "code": "addon_required",
  "detail": "Your plan does not include the add-on this operation requires",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "requiredAddon": "sales-documents"
}

{
  "type": "https://docs.filmo.io/errors/insufficient_scope",
  "title": "Insufficient scope",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "The API key does not have the required scope (orders:write)",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "requiredScope": "quotes:write"
}

{
  "type": "https://docs.filmo.io/errors/not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "Resource not found",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/conflict",
  "title": "Conflict",
  "status": 409,
  "code": "conflict",
  "detail": "The current state of the resource does not allow the operation",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "errors": [
    {
      "path": "",
      "code": "invalid_state",
      "message": "The current state of the resource does not allow the operation"
    }
  ]
}

{
  "type": "https://docs.filmo.io/errors/precondition_failed",
  "title": "Precondition failed",
  "status": 412,
  "code": "precondition_failed",
  "detail": "The resource changed since you read it: read it again and retry",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/idempotency_key_reused",
  "title": "Idempotency-Key reused",
  "status": 422,
  "code": "idempotency_key_reused",
  "detail": "The Idempotency-Key header was already used with a different body",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/rate_limited",
  "title": "Rate limit exceeded",
  "status": 429,
  "code": "rate_limited",
  "detail": "Rate limit exceeded: retry in 30 seconds",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "retryAfter": 30
}

{
  "type": "https://docs.filmo.io/errors/internal_error",
  "title": "Internal error",
  "status": 500,
  "code": "internal_error",
  "detail": "Internal error",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

Generated from the schema

Confirming a version moves ALL the others to superseded, including another one that was confirmed: it is the rule that leaves a single one in force, and it is not visible in the body. superseded cannot be set by hand; the system sets it. It does NOT touch the tax status (draft / validated): the document path is for that. It requires sales documents in the plan of the account (402 without it). Returns the full quote, the same projection as its GET.

Authorizations

Bearer API key with the scope below. quotes:write

Headers

Idempotency-Keystring

Unique identifier of the request, chosen by the client (a UUID works). Between 1 and 255 characters: an empty header is rejected with 400 validation_error, because the client would believe itself protected. Repeating the same key with the SAME body within 24 h returns the stored response without executing again, with the Idempotent-Replay: true header. With a DIFFERENT body it returns 422. It is the safe way to retry after a network timeout.

Limits: min length 1, max length 255

Example:"9f1c2f4e-3a5b-4f6d-8e7a-0b1c2d3e4f5a"

If-Matchstring

Optimistic locking: the ETag you read from the resource (or *). If the resource changed since, the write is rejected with 412 precondition_failed before doing anything; read it again and retry. Without the header the write always proceeds.

Example:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Path parameters

quoteIdstringRequired

Quote identifier.

Limits: min length 1

Body

application/json

Body schema: QuoteStatusBody

statusstringRequired

New commercial status of the active version: pending (awaiting an answer), confirmed (accepted; the other versions become superseded) or cancelled (rejected or cancelled).

Available options: pending, confirmed, cancelled

notesstring

Note stored in the quote history alongside the status change.

Limits: max length 1000

Response

application/json

Successful response.

Response schema: QuoteDetailDto

Envelope: QuoteDetailResponse. meta.warnings is present only when the operation is deprecated.

Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag · Idempotent-Replay

dataobject

The quote in full, as returned by the API.

Show child attributes

data.idstring

Unique quote identifier (container).

data.quoteNumberstring

Human-readable quote number.

data.versionNumberinteger

Number of the active version of the quote.

data.statusstring

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

Available options: draft, validated

data.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

data.issueDatestring<date-time> | null

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

data.validUntilstring<date-time> | null

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

data.startDatestring<date-time>

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

data.endDatestring<date-time>

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

data.currencystring

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

data.contactobject | null

Compact reference to the quote contact; null if none.

Show child attributes

data.contact.idstring

Unique contact identifier.

data.contact.namestring

Contact name.

data.orderIdstring | null

Identifier of the linked order; null if not linked.

data.orderNumberstring | null

Number of the linked order; null if not linked.

data.projectIdstring | null

Identifier of the linked project; null if not linked.

data.subTotalstring

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

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

data.discountTotalstring

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

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

data.taxesPricestring

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

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

data.netPricestring

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

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

data.grossPricestring

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

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

data.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}$

data.createdAtstring<date-time>

Creation date of the container in ISO 8601 with offset.

data.updatedAtstring<date-time>

Last update date in ISO 8601 with offset.

data.projectNamestring | null

Name of the linked project; null if not linked.

data.taxBreakdownobject[] | null

Tax breakdown by type; null if not calculated.

Show child attributes

data.taxBreakdown.taxTypestring

Tax type key (for example "IVA_21").

data.taxBreakdown.labelstring

Human-readable tax label.

data.taxBreakdown.ratenumber

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

data.taxBreakdown.baseAmountstring

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

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

data.taxBreakdown.amountstring

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

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

metaobject

Additional information about the response.

Show child attributes

meta.warningsobject[]

Lifecycle warnings; present only when the operation is deprecated.

Show child attributes

meta.warnings.codestring

Stable warning code.

Available options: deprecated

meta.warnings.messagestring

For people: what is deprecated, until when, and what to use.

meta.warnings.sunsetstring

Day (YYYY-MM-DD) the operation stops being served.

meta.warnings.replacementstring | null

operationId of the operation to use instead, or null if there is none.

meta.warnings.linkstring

Where the deprecation is documented (the changelog).

Errors

Status	Codes	Meaning
400	`validation_error`	Malformed query or body. `errors[]` lists every offending field with its stable code.
402	`addon_required`	The account plan does not include the add-on this operation needs; `requiredAddon` names it.
404	`not_found`	It does not exist or is outside the scope of the API key.
409	`conflict`	The current state of the resource prevents the operation, a request with that Idempotency-Key is already in progress, or another conditional write (`If-Match`) held the resource for more than five seconds. `errors[0].code` says which: `in_progress` and `lock_timeout` are solved by retrying; `invalid_state` is not, because the state of the resource forbids the operation.
412	`precondition_failed`	The `If-Match` entity tag does not match the current representation. Read the resource again and retry.
422	`idempotency_key_reused`	The same key was used before with a different body. Change the key.

401, 403, 429, 500 can be returned by any operation. Errors

Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date. Versioning policy

Rentals
Quote
The quote, as returned by the API.

Was this page helpful?

Request examples

Authorizations

Headers

Path parameters

Body

Response

Errors

Deprecation

Related

Related pages

Quote