Cotações

Get the quote configuration

crm.quotes.config.get

Returns the quote configuration of the CRM: the templates (layout, accent color, intro text, attached pages, which one is the default), the number prefix and the next number, the default validity in days, the number format and decimals, the issuer data printed on the document and the three footer texts. Never empty: an organization that never saved a template gets the synthetic template named 'Estándar' (id __default) with its brand color, and it stays when another template is created.

Escopo

crm:read

Permissão

Ver o módulo

Tool do MCP

crm_quotes_config_getNa superfície completa; na compacta, mb_execute_operation com id: "crm.quotes.config.get".

Custo declarado: até 1 leituras e 0 escritas por chamada (contam na cota diária).

Parâmetros

Sem parâmetros.

Resposta

Erros

Exemplo

curl "https://api.mb-suite.com/v1/crm/quotes/config" \
  -H "Authorization: Bearer $MB_API_KEY"

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

curl "https://api.mb-suite.com/v1/crm/quotes/config" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Update the quote numbering, issuer and footer

crm.quotes.config.update

Updates any of: the number prefix, the next number (it never goes back: the stored one wins if it is higher, so numbers already emitted are never reused), the default validity in days, the number format (auto, dot_comma, comma_dot) and decimals (0 or 2), the issuer data (replaced as a whole) and the three footer texts (an empty string leaves that position blank; {{numero}} prints the quote number). Fields not sent are kept. Returns the next number in force. Templates are managed with crm.quotes.templates.*. Requires manage_quote_config (managers and admins).

Escopo

crm:write

Permissão

Editar no módulo · Ação do CRM: manage_quote_config

Tool do MCP

crm_quotes_config_updateNa superfície completa; na compacta, mb_execute_operation com id: "crm.quotes.config.update".

Custo declarado: até 1 leituras e 1 escritas por chamada (contam na cota diária).

Parâmetros

Resposta

Erros

Exemplo

curl -X PATCH "https://api.mb-suite.com/v1/crm/quotes/config" \
  -H "Authorization: Bearer $MB_API_KEY"

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

curl -X PATCH "https://api.mb-suite.com/v1/crm/quotes/config" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Create or replace a quote template

crm.quotes.templates.save

Creates a quote template (without template.id) or replaces the whole template with that id (fields not sent, like intro_text, are left empty; an id that does not exist answers quote_template_not_found): name, layout (classic, modern or compact), accent color (#rrggbb), optional intro text, the ordered ids of the attached pages (from crm.quotes.pages.list, up to 20; one that does not exist answers quote_page_not_found) and whether it is the default (marking it unmarks the others; one template is always the default). In an organization that never saved a template the synthetic 'Estándar' (id __default) stays next to the new one. Returns the template id. A template is the design every quote uses: a deal's quote (its lines and totals) is built with crm.deals.update_quote and emitted with crm.quotes.emit. Requires manage_quote_config.

Escopo

crm:write

Permissão

Editar no módulo · Ação do CRM: manage_quote_config

Tool do MCP

crm_quotes_templates_saveNa superfície completa; na compacta, mb_execute_operation com id: "crm.quotes.templates.save".

Custo declarado: até 1 leituras e 1 escritas por chamada (contam na cota diária).

Parâmetros

Resposta

Erros

Exemplo

curl -X POST "https://api.mb-suite.com/v1/crm/quotes/templates" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "template": {}
}'

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

curl -X POST "https://api.mb-suite.com/v1/crm/quotes/templates" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "template": {}
}'

Delete a quote template

crm.quotes.templates.delete

Deletes a quote template for good: templates have no trash, so it cannot be restored (quotes already emitted keep their PDF and their snapshot). If it was the default, the first remaining template becomes the default; when none remains, the synthetic 'Estándar' (id __default) comes back, and that one alone cannot be deleted (quote_template_last). The dry run names the template and which one becomes the default. Confirm with the user first. Requires manage_quote_config.

Pede confirmação: primeiro dry_run: true (prévia e confirm_token, válido por 10 minutos e por uma única execução), depois o mesmo corpo com confirm_token. Em algumas poucas, só com certos dados: a descrição diz quando. Por que e como: Prévia e confirmação.

Escopo

crm:write e «Permitir exclusões» (crm:delete no OAuth)

Permissão

Editar no módulo · Ação do CRM: manage_quote_config

Tool do MCP

crm_quotes_templates_deleteNa superfície completa; na compacta, mb_execute_operation com id: "crm.quotes.templates.delete".

Custo declarado: até 2 leituras e 1 escritas por chamada (contam na cota diária).

Parâmetros

Resposta

Erros

Exemplo

curl -X POST "https://api.mb-suite.com/v1/crm/quotes/templates/{template_id}/delete" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "dry_run": true
}'

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

curl -X POST "https://api.mb-suite.com/v1/crm/quotes/templates/{template_id}/delete" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "dry_run": true
}'

Make a quote template the default

crm.quotes.templates.set_default

Marks a template as the default one (the others stop being default): it is the template a new emission uses when none is chosen; also the synthetic 'Estándar' (id __default). Idempotent. Requires manage_quote_config.

Escopo

crm:write

Permissão

Editar no módulo · Ação do CRM: manage_quote_config

Tool do MCP

crm_quotes_templates_set_defaultNa superfície completa; na compacta, mb_execute_operation com id: "crm.quotes.templates.set_default".

Custo declarado: até 2 leituras e 1 escritas por chamada (contam na cota diária).

Parâmetros

Resposta

Erros

Exemplo

curl -X POST "https://api.mb-suite.com/v1/crm/quotes/templates/{template_id}/default" \
  -H "Authorization: Bearer $MB_API_KEY"

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

curl -X POST "https://api.mb-suite.com/v1/crm/quotes/templates/{template_id}/default" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Duplicate a quote template

crm.quotes.templates.duplicate

Copies a template with all its settings and pages under the name '<name> (copia)', never as the default, and returns the id of the copy. Requires manage_quote_config.

Escopo

crm:write

Permissão

Editar no módulo · Ação do CRM: manage_quote_config

Tool do MCP

crm_quotes_templates_duplicateNa superfície completa; na compacta, mb_execute_operation com id: "crm.quotes.templates.duplicate".

Custo declarado: até 2 leituras e 1 escritas por chamada (contam na cota diária).

Parâmetros

Resposta

Erros

Exemplo

curl -X POST "https://api.mb-suite.com/v1/crm/quotes/templates/{template_id}/duplicate" \
  -H "Authorization: Bearer $MB_API_KEY"

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

curl -X POST "https://api.mb-suite.com/v1/crm/quotes/templates/{template_id}/duplicate" \
  -H "Authorization: Bearer $MB_TEST_KEY"

List the quote attachment pages

crm.quotes.pages.list

Lists the attachment pages that templates can append at the end of a quote (terms of sale, payment methods…), ordered by title, with their size; with include_content, also their sanitized HTML. Paginated by cursor (limit up to 50). Templates reference them by id in page_ids.

Escopo

crm:read

Permissão

Ver o módulo

Tool do MCP

crm_quotes_pages_listNa superfície completa; na compacta, mb_execute_operation com id: "crm.quotes.pages.list".

Custo declarado: até 52 leituras e 0 escritas por chamada (contam na cota diária).

Parâmetros

Resposta

Erros

Exemplo

curl "https://api.mb-suite.com/v1/crm/quotes/pages" \
  -H "Authorization: Bearer $MB_API_KEY"

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

curl "https://api.mb-suite.com/v1/crm/quotes/pages" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Create a quote attachment page

crm.quotes.pages.create

Creates an attachment page (title up to 160 characters and its rich-text HTML, sanitized when saved: scripts and event attributes are removed) that templates can append at the end of a quote; add its id to a template with crm.quotes.templates.save. Returns the page id. It is not the quote itself: a deal's quote (its lines and totals) is built with crm.deals.update_quote and its PDF is emitted with crm.quotes.emit. Requires manage_quote_config.

Escopo

crm:write

Permissão

Editar no módulo · Ação do CRM: manage_quote_config

Tool do MCP

crm_quotes_pages_createNa superfície completa; na compacta, mb_execute_operation com id: "crm.quotes.pages.create".

Custo declarado: até 0 leituras e 1 escritas por chamada (contam na cota diária).

Parâmetros

Resposta

Erros

Exemplo

curl -X POST "https://api.mb-suite.com/v1/crm/quotes/pages" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "title": "TITLE",
  "content_html": "CONTENT_HTML"
}'

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

curl -X POST "https://api.mb-suite.com/v1/crm/quotes/pages" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "title": "TITLE",
  "content_html": "CONTENT_HTML"
}'

Update a quote attachment page

crm.quotes.pages.update

Changes the title and/or the HTML content (sanitized when saved) of an attachment page; with neither it answers no_changes. Quotes already emitted keep the PDF they were issued with. Requires manage_quote_config.

Escopo

crm:write

Permissão

Editar no módulo · Ação do CRM: manage_quote_config

Tool do MCP

crm_quotes_pages_updateNa superfície completa; na compacta, mb_execute_operation com id: "crm.quotes.pages.update".

Custo declarado: até 1 leituras e 1 escritas por chamada (contam na cota diária).

Parâmetros

Resposta

Erros

Exemplo

curl -X PATCH "https://api.mb-suite.com/v1/crm/quotes/pages/{page_id}" \
  -H "Authorization: Bearer $MB_API_KEY"

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

curl -X PATCH "https://api.mb-suite.com/v1/crm/quotes/pages/{page_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Delete a quote attachment page

crm.quotes.pages.delete

Deletes an attachment page for good and removes it from every template that used it: pages have no trash, so it cannot be restored (quotes already emitted keep their PDF). The dry run names the page and the templates it leaves. Confirm with the user first. Requires manage_quote_config.

Pede confirmação: primeiro dry_run: true (prévia e confirm_token, válido por 10 minutos e por uma única execução), depois o mesmo corpo com confirm_token. Em algumas poucas, só com certos dados: a descrição diz quando. Por que e como: Prévia e confirmação.

Escopo

crm:write e «Permitir exclusões» (crm:delete no OAuth)

Permissão

Editar no módulo · Ação do CRM: manage_quote_config

Tool do MCP

crm_quotes_pages_deleteNa superfície completa; na compacta, mb_execute_operation com id: "crm.quotes.pages.delete".

Custo declarado: até 3 leituras e 2 escritas por chamada (contam na cota diária).

Parâmetros

Resposta

Erros

Exemplo

curl -X POST "https://api.mb-suite.com/v1/crm/quotes/pages/{page_id}/delete" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "dry_run": true
}'

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

curl -X POST "https://api.mb-suite.com/v1/crm/quotes/pages/{page_id}/delete" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "dry_run": true
}'

Emit the quote PDF of a deal

crm.quotes.emit

Emits the deal's quote as a PDF (rendered by MB Suite's PDF service) and returns its download URL and number. The first emission reserves the next number for the deal; later emissions of the same deal reuse it and add a new row to its history (crm.quotes.emissions.list). Options: template (one that does not exist answers quote_template_not_found), which of its pages to include (only among the template's: quote_page_not_in_template otherwise), document language (es, en, pt-BR), number format and decimals, validity in days and a note for this emission. The deal must have line items (crm.deals.update_quote); see the document first with crm.quotes.export. When the PDF service is not available it answers pdf_unavailable (503) and nothing is emitted: retry in a few seconds. Not idempotent. Requires edit_deal on the deal.

Escopo

crm:write

Permissão

Editar no módulo

Tool do MCP

crm_quotes_emitNa superfície completa; na compacta, mb_execute_operation com id: "crm.quotes.emit".

Custo declarado: até 26 leituras e 6 escritas por chamada (contam na cota diária). Usa uma plataforma externa (pdf): conta na cota de operações externas.

Parâmetros

Resposta

Erros

Exemplo

curl -X POST "https://api.mb-suite.com/v1/crm/deals/{deal_id}/quote/emit" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "locale": "es",
  "validity_days": 1
}'

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar. Na prática esta operação não é simulada (usa outra plataforma): responde 409 sandbox_external_unavailable.

List the quote emissions of a deal

crm.quotes.emissions.list

Returns the emissions of the deal's quote, newest first, paginated by cursor (limit up to 50, default 20): number, language, validity, totals, currency, the template used, who emitted it and a fresh download URL of its PDF; with include_content, also the frozen content (issuer, client, line items, intro and footer). deal_not_found when the deal does not exist or the seller's scope hides it.

Escopo

crm:read

Permissão

Ver o módulo

Tool do MCP

crm_quotes_emissions_listNa superfície completa; na compacta, mb_execute_operation com id: "crm.quotes.emissions.list".

Custo declarado: até 53 leituras e 0 escritas por chamada (contam na cota diária).

Parâmetros

Resposta

Erros

Exemplo

curl "https://api.mb-suite.com/v1/crm/deals/{deal_id}/quote/emissions" \
  -H "Authorization: Bearer $MB_API_KEY"

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

curl "https://api.mb-suite.com/v1/crm/deals/{deal_id}/quote/emissions" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Get the quote document of a deal

crm.quotes.export

Builds the deal's quote document from its current state, exactly what the emission preview shows: issuer (name is the configuration's legal_name, the logo as an absolute URL), client (company and primary person), line items and totals, currency, the number it has (or the next one, is_preview_number), validity, template layout and color, the attached pages (sanitized HTML) and the footer. Optional template (quote_template_not_found when it does not exist), pages (only among the template's: quote_page_not_in_template otherwise) and language. It writes nothing and does not reserve a number: use crm.quotes.emit for the PDF. Not found if the deal does not exist or the seller's scope hides it.

Escopo

crm:read

Permissão

Ver o módulo

Tool do MCP

crm_quotes_exportNa superfície completa; na compacta, mb_execute_operation com id: "crm.quotes.export".

Custo declarado: até 26 leituras e 0 escritas por chamada (contam na cota diária).

Parâmetros

Resposta

Erros

Exemplo

curl "https://api.mb-suite.com/v1/crm/deals/{deal_id}/quote" \
  -H "Authorization: Bearer $MB_API_KEY"

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

curl "https://api.mb-suite.com/v1/crm/deals/{deal_id}/quote" \
  -H "Authorization: Bearer $MB_TEST_KEY"