# Estimates Create quotes, proformas and fees notes and send them to your clients. ## Create partial payment for document - [POST /api/v3/documents/{document_id}/partial_payments.json](https://docs.invoicexpress.com/v3/invoices/createv3documentpartialpayment.md): Creates a partial payment for a document. This generates a treasury movement and client current account entry. Use the document numeric id (the same id returned for invoice-type and guide-type resources). The .json suffix requests a JSON response body. Send an Idempotency-Key header to make retries safe: a repeated request with the same key and payload replays the first answer (kept for 24 hours) instead of registering the payment twice. ## Create partial payment for document - [POST /api/v3/documents/{document_id}/partial_payments.json](https://docs.invoicexpress.com/v3/guides/createv3documentpartialpayment.md): Creates a partial payment for a document. This generates a treasury movement and client current account entry. Use the document numeric id (the same id returned for invoice-type and guide-type resources). The .json suffix requests a JSON response body. Send an Idempotency-Key header to make retries safe: a repeated request with the same key and payload replays the first answer (kept for 24 hours) instead of registering the payment twice. ## Create partial payment for document - [POST /api/v3/documents/{document_id}/partial_payments.json](https://docs.invoicexpress.com/v3/estimates/createv3documentpartialpayment.md): Creates a partial payment for a document. This generates a treasury movement and client current account entry. Use the document numeric id (the same id returned for invoice-type and guide-type resources). The .json suffix requests a JSON response body. Send an Idempotency-Key header to make retries safe: a repeated request with the same key and payload replays the first answer (kept for 24 hours) instead of registering the payment twice. ## List Estimates - [GET /api/v3/estimates](https://docs.invoicexpress.com/v3/estimates/listv3estimates.md): Returns a list of all your estimates (quotes, proformas and fees notes). ## List Estimates (POST) - [POST /api/v3/estimates](https://docs.invoicexpress.com/v3/estimates/listv3estimatespost.md): Same as GET /api/v3/estimates, with the filters sent as a JSON body instead of the query string (useful for long id / client_id lists). The response is identical. Page size defaults to 10. ## Get Estimates Summary - [POST /api/v3/estimates/summary](https://docs.invoicexpress.com/v3/estimates/getv3estimatessummary.md): Returns the totals of the specific documents selected. ## Create Estimate - [POST /api/v3/{estimate_type}](https://docs.invoicexpress.com/v3/estimates/createv3estimate.md): Creates a new estimate of the specified type. The request body wrapper key must match the path segment: - quote for quotes - proforma for proformas - fees_note for fees_notes ## Update Estimate Summary - [POST /api/v3/{estimate_type}/update_summary](https://docs.invoicexpress.com/v3/estimates/updatev3estimatesummary.md): Calculates and returns the financial summary (totals, taxes, discounts, retention) for an estimate based on the provided data without saving it. The request body wrapper key must be the singular of the path type (quote, proforma, fees_note); any other key returns 422 "No quote element provided" (with the expected key name). ## Calculate Estimate Summary - [POST /api/v3/{estimate_type}/calculate_summary](https://docs.invoicexpress.com/v3/estimates/calculatev3estimatesummary.md): Calculates the totals (sum, discount, taxes, retention, total) for the items sent, without validating or saving anything. Unlike update_summary, invalid input is coerced instead of rejected: a missing or wrongly named wrapper key, or no items, returns an all-zero summary with 200. Only items, retention, global_discount, currency_code, rate and tax_exemption are read; at most 1000 items are processed. The wrapper key is the singular of the path type (quote, proforma, fees_note). ## New Estimate Defaults - [GET /api/v3/{estimate_type}/new](https://docs.invoicexpress.com/v3/estimates/newv3estimate.md): Returns the defaults and choices needed to build a new estimate of the given type (due-date options, exemption reasons, issuable sequences, currencies, retention options, default remarks, taxes). Nothing is created. When client_id is sent, the client's payment days, exemption code, currency and observations take priority over the account's. ## Get Estimate by ID - [GET /api/v3/{estimate_type}/{id}](https://docs.invoicexpress.com/v3/estimates/getv3estimatebyid.md): Retrieves detailed information about a specific estimate document including client data, items, financial summary, and account information. ## Update Estimate - [PUT /api/v3/{estimate_type}/{id}](https://docs.invoicexpress.com/v3/estimates/updatev3estimate.md): Updates an estimate of the given type. The wrapper key must be the singular of the path type (quote, proforma, fees_note). items is required and replaces the whole item set. Documents in state sent, settled, deleted, canceled, accepted, refused or second_copy cannot be edited. ## Clone Estimate - [GET /api/v3/{estimate_type}/{id}/clone](https://docs.invoicexpress.com/v3/estimates/clonev3estimate.md): Returns an unsaved draft copy of the document, as an estimate of the path type, ready to be edited and submitted with the create operation. Nothing is persisted: the returned document has no id. Date is today, due date is today plus the client's (else the account's) payment days, and the exchange rate is refreshed for foreign-currency documents. The sequence is the account's default for the type unless keep_owner_sequence=true. The source id may be any document of the account (not only one of the path type); the copy always takes the path type. ## List estimate movements - [GET /api/v3/{estimate_type}/{id}/movements](https://docs.invoicexpress.com/v3/estimates/listv3estimatemovements.md): Returns the payments and reimbursements recorded against the estimate, its related documents and their receipts (non-canceled treasury movements of the document's client). ## Archive a document - [PUT /api/v3/{estimate_type}/{id}/archive](https://docs.invoicexpress.com/v3/estimates/archivev3estimatedocument.md): Archives the specified estimate document by setting its archived flag to true and returns the updated document. ## Archive a document - [PATCH /api/v3/{estimate_type}/{id}/archive](https://docs.invoicexpress.com/v3/estimates/archivev3estimatedocumentpatch.md): Archives the specified estimate document by setting its archived flag to true and returns the updated document. ## Creates a comment for a document - [POST /api/v3/{estimate_type}/{id}/comments](https://docs.invoicexpress.com/v3/estimates/createv3estimatecomment.md): Creates a new comment for the specified estimate document. Comments can only be deleted within 15 minutes of creation. ## Deletes a comment from a document - [DELETE /api/v3/{estimate_type}/{id}/comments/{comment_id}](https://docs.invoicexpress.com/v3/estimates/deletev3estimatecomment.md): Deletes a comment from the specified estimate document. Comments can only be deleted within 15 minutes of creation and only by the author. ## Download estimate PDF - [GET /api/v3/{estimate_type}/{id}/pdf](https://docs.invoicexpress.com/v3/estimates/getv3estimatepdf.md): Returns the PDF URL for the specified estimate or indicates if PDF generation is in progress. ## Get QR Code - [GET /api/v3/{estimate_type}/{id}/qr_code](https://docs.invoicexpress.com/v3/estimates/getv3estimateqrcode.md): Returns the QR Code URL for the specified estimate or indicates if QR Code generation is in progress. ## Get send document configuration - [GET /api/v3/{estimate_type}/{id}/send](https://docs.invoicexpress.com/v3/estimates/getv3estimatesendconfig.md): Returns the pre-filled email data for sending an estimate to a client. This includes the default recipient, subject, and body with placeholders resolved based on the document and client context. ## Send document by email - [POST /api/v3/{estimate_type}/{id}/send](https://docs.invoicexpress.com/v3/estimates/sendv3estimatedocument.md): Sends the specified estimate by email to the client. ## List related documents - [GET /api/v3/{estimate_type}/{id}/related_documents](https://docs.invoicexpress.com/v3/estimates/listv3estimaterelateddocuments.md): Returns the list of documents related to the specified estimate document. ## Returns timeline activities for a specific document - [GET /api/v3/{estimate_type}/{id}/timeline](https://docs.invoicexpress.com/v3/estimates/getv3estimatetimeline.md): Retrieves timeline activities for a specific estimate document including status changes, comments, and other events. ## Unarchive a document - [PUT /api/v3/{estimate_type}/{id}/unarchive](https://docs.invoicexpress.com/v3/estimates/unarchivev3estimatedocument.md): Unarchives the specified document by setting its archived flag to false and returns the updated document. ## Unarchive a document - [PATCH /api/v3/{estimate_type}/{id}/unarchive](https://docs.invoicexpress.com/v3/estimates/unarchivev3estimatedocumentpatch.md): Unarchives the specified document by setting its archived flag to false and returns the updated document. ## Change estimate state - [PUT /api/v3/{estimate_type}/{id}/change-state.json](https://docs.invoicexpress.com/v3/estimates/changev3estimatedocumentstate.md): Changes the state of an estimate document (estimate_type path segment: quotes, proformas, fees_notes). | From | To | Value in request body | | :--- | :--- | :--- | | draft | sent | finalized | | draft | deleted | deleted | | sent, refused | accepted | accept | | sent, accepted | refused | refuse | | sent, accepted, refused | canceled | canceled | The request body wrapper key must be the singular of the path type (quote, proforma, fees_note); any other key returns 422 "Invalid root element, expected quote" (with the expected key name). To cancel, send the reason in message inside the wrapper, e.g. {"quote": {"state": "canceled", "message": "Client withdrew the request"}}. Without it the API returns 422 "The cancellation reason is a required field".