Quotes

Get a quote

Returns the detail of a quote with its active version flattened (document and commercial status).

Tool
filmo_quotes_get
Access: Read

Result

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_quotes_get",
    "arguments": {
      "quoteId": "quot_8f2a1c"
    }
  }
}

generated from the schema

Arguments

quoteIdstringRequired

Quote identifier.

Limits: min length 1

Result

On success the result carries structuredContent with data and meta. These are the attributes of data.

Show the attributes of data
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 | null

Name of the linked project; null if not linked.

taxBreakdownobject[] | null

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

An error is a result with isError: true and the problem in content[0].text; there is no structuredContent. See Errors.

The same operation by REST

This tool runs GET /api/v1/quotes/{quoteId}.

  • Quotes

    Get a quote

    Returns the detail of a quote with its active version flattened (document and commercial status).

  • Guides

    Safe writes

    An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.

  • Guides

    Errors

    A tool error is a result with isError: true and the problem in the first text block. Branch on its code.